その他

説明

---

説明

class yaylib.api.MiscApi(client)

未分類 API

async accept_policy_agreement(agreement_type: str) → Response

利用規約、ポリシー同意書に同意する

Args:

agreement_type (str):

Returns:

Response:

async get_app_config() → ApplicationConfigResponse

アプリケーションのメタデータを取得する

Returns:

ApplicationConfigResponse:

async get_banned_words(country_code: str = 'jp') → BanWordsResponse

禁止ワードの一覧を取得する

Args:

country_code (str, optional):

Returns:

BanWordsResponse:

async get_email_grant_token(**params) → EmailGrantTokenResponse

メールアドレス認証トークンを取得する

Args:

code (int): email (str):

Returns:

EmailGrantTokenResponse:

async get_email_verification_presigned_url(email: str, locale: str = 'ja', intent: str = None) → EmailVerificationPresignedUrlResponse

メールアドレス確認用の署名付きURLを取得する

Args:

email (str): locale (str): intent (str, optional):

Returns:

EmailVerificationPresignedUrlResponse:

async get_file_upload_presigned_urls(file_names: List[str]) → PresignedUrlsResponse

ファイルアップロード用の署名付きURLを取得する

Args:

file_names (List[str]):

Returns:

PresignedUrlsResponse:

async get_id_checker_presigned_url(model: str, action: str, **params) → IdCheckerPresignedUrlResponse

身分証明用の署名付きURLを取得する

Args:

model (str): action (str):

Returns:

IdCheckerPresignedUrlResponse:

async get_old_file_upload_presigned_url(video_file_name: str) → PresignedUrlResponse

旧版ファイルアップロード用の署名付きURLを取得する

Args:

video_file_name (str):

Returns:

PresignedUrlResponse:

async get_policy_agreed() → PolicyAgreementsResponse

利用規約、ポリシー同意書に同意しているかどうかを取得する

Returns:

PolicyAgreementsResponse:

async get_popular_words(country_code: str = 'jp') → PopularWordsResponse

人気ワードの一覧を取得する

Args:

country_code (str, optional):

Returns:

PopularWordsResponse:

async get_web_socket_token() → WebSocketTokenResponse

WebSocket トークンを取得する

Returns:

WebSocketTokenResponse:

async send_verification_code(email: str, intent: str, locale: str = 'ja') → Response

メールアドレス認証コードを送信する

Args:

email (str): intent (str): locale (str):

Returns:

Response:

async upload_image(image_paths: List[str], image_type: str) → List[Attachment]

画像をアップロードして、サーバー上のファイルのリストを取得する

Examples:

投稿に画像を付与する場合

>>> # サーバー上にアップロード
>>> attachments = client.upload_image(
>>>     image_type=yaylib.ImageType.POST,
>>>     image_paths=["./example.jpg"],
>>> )
>>> # サーバー上のファイル名を指定
>>> client.create_post(
>>>     "Hello with yaylib!",
>>>     attachment_filename=attachments[0].filename
>>> )

Args:

image_paths (List[str]): 画像ファイルのパスのリスト image_type (str): 画像の種類

Raises:

ValueError: 画像タイプやフォーマットが不正な場合

Returns:

List[Attachment]: サーバー上のファイル情報

async upload_video(video_path: str) → str

動画をアップロードして、サーバー上のファイル名を取得する

Examples:

投稿に動画を付与する場合

>>> # サーバー上にアップロード
>>> filename = client.upload_video("./example.mp4")
>>> # サーバー上のファイル名を指定
>>> client.create_post(
>>>     "Hello with yaylib!",
>>>     video_file_name=filename
>>> )

Args:

video_path (str): 動画ファイルのパス

Raises:

ValueError: 動画フォーマットが不正な場合

Returns:

str: サーバー上のファイル名