FastComments の Python SDK

これは FastComments の公式 Python SDK です。

FastComments API の公式 Python SDK

リポジトリ

インストール

Install from GitHub

リリースタグから直接インストールします（推奨、完全に再現可能）:

pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0

ビルドが決定的になるよう、ブランチではなくタグを固定してください。同じ形式は requirements.txt でも機能します:

fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0

各タグ付けされた GitHub Release には、バイナリ成果物として直接インストールできるビルトホイールも添付されています。

Library Contents

このライブラリは 2 つのモジュールを含みます: 生成された API クライアントと、API の利用を容易にする手書きユーティリティを含むコア Python ライブラリ（SSO サポートを含む）。

Public vs Secured APIs

API クライアントには DefaultApi、PublicApi、ModerationApi の 3 クラスがあります。DefaultApi には API キーが必要なメソッドが含まれ、PublicApi には認証なしでブラウザ/モバイルデバイス等から直接呼び出せるメソッドが含まれます。ModerationApi は、ライブかつ高速なモデレーション API の包括的なスイートを提供します。すべての ModerationApi メソッドは sso パラメータを受け取り、SSO または FastComments.com のセッションクッキーで認証できます。

クイックスタート

Using Authenticated APIs (DefaultApi)

重要: 認証されたリクエストを行う前に、Configuration に API キーを設定する必要があります。設定しない場合、リクエストは 401 エラーで失敗します。

from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData

# Create and configure the API client
config = Configuration()
config.host = "https://fastcomments.com"

# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}

# Create the API instance with the configured client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)

# Now you can make authenticated API calls
try:
    # Example: Add an SSO user
    user_data = CreateAPISSOUserData(
        id="user-123",
        email="user@example.com",
        display_name="John Doe"
    )

    response = api.add_sso_user("YOUR_TENANT_ID", user_data)
    print(f"User created: {response}")

except Exception as e:
    print(f"Error: {e}")
    # Common errors:
    # - 401: API key is missing or invalid
    # - 400: Request validation failed

Using Public APIs (PublicApi)

Public endpoints don't require authentication:

from client import ApiClient, Configuration, PublicApi

config = Configuration()
config.host = "https://fastcomments.com"

api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)

try:
    response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
    print(response)
except Exception as e:
    print(f"Error: {e}")

Using the Moderation Dashboard (ModerationApi)

The ModerationApi powers the moderator dashboard. Methods are called on behalf of a moderator by passing an sso token:

from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions

config = Configuration()
config.host = "https://fastcomments.com"

api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)

try:
    # Count the comments awaiting moderation
    response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
    print(response)
except Exception as e:
    print(f"Error: {e}")

Using SSO (Single Sign-On)

The SDK includes utilities for generating secure SSO tokens:

from sso import FastCommentsSSO, SecureSSOUserData

# Create user data (id, email, and username are required)
user_data = SecureSSOUserData(
    id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# Sign it with your API secret (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)

# Generate the SSO token to pass to the widget or an API call
sso_token = sso.create_token()

# Use this token in your frontend or pass to API calls
print(f"SSO Token: {sso_token}")

For simple SSO (less secure, for testing):

from sso import FastCommentsSSO, SimpleSSOUserData

user_data = SimpleSSOUserData(
    username="johndoe",
    email="user@example.com"
)

sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()

Common Issues

401 "missing-api-key" error: DefaultApi インスタンスを作成する前に config.api_key = {"api_key": "YOUR_KEY"} を設定してください。
Wrong API class: サーバー側の認証リクエストには DefaultApi、クライアント側/公開リクエストには PublicApi、モデーターダッシュボードのリクエストには ModerationApi を使用してください。
Import errors: 正しいモジュールからインポートしていることを確認してください:
- API client: from client import ...
- SSO utilities: from sso import ...

注意事項

ブロードキャストID

一部のAPI呼び出しでは broadcast_id を渡す必要があることが分かるでしょう。イベントを受信すると、このIDが返されるので、クライアント側で楽観的に変更を適用する予定がある場合にそのイベントを無視すべきかを判断できます（ユーザー体験が最も良いため、おそらくそうするでしょう）。ここにはUUIDを渡してください。そのIDは、同じブラウザセッション内で重複しない程度に十分一意である必要があります。

要件

Python >= 3.8

ベースインストールは純粋な標準ライブラリで、SSOユーティリティを提供します。生成された APIクライアント（DefaultApi/PublicApi/ModerationApi）は client エクストラが必要で、これにより urllib3 >= 1.25.3、python-dateutil >= 2.8.2、pydantic >= 2.0.0、および typing-extensions >= 4.0.0 がインストールされます：

pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"

aggregate

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
parentTenantId	string	query	No
includeStats	boolean	query	No

レスポンス

返却: AggregateResponse

例

集計例

Copy

import client
from client.api.default_api import AggregateOptions
from client.models.aggregate_response import AggregateResponse
from client.models.aggregation_request import AggregationRequest
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
# クライアントは、APIサーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って
# 各認証方式の例が以下に提供されています。適切な例を使用してください
# あなたの認証ユースケースに合致するもの
# APIキー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスでコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    aggregation_request = client.AggregationRequest() # AggregationRequest | 
    parent_tenant_id = 'parent_tenant_id_example' # str |  (optional)
    include_stats = True # bool |  (optional)
    try:
        api_response = api_instance.aggregate(tenant_id, aggregation_request, AggregateOptions(parent_tenant_id=parent_tenant_id, include_stats=include_stats))
        print("The response of DefaultApi->aggregate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->aggregate: %s\n" % e)

get_audit_logs

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
limit	number	query	No
skip	number	query	No
order	string	query	No
after	number	query	No
before	number	query	No

レスポンス

戻り値: GetAuditLogsResponse

例

get_audit_logs の例

Copy

import client
from client.api.default_api import GetAuditLogsOptions
from client.models.get_audit_logs_response import GetAuditLogsResponse
from client.models.sortdir import SORTDIR
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# すべてのサポートされている設定パラメータの一覧は configuration.py を参照してください。
# クライアントは認証と認可のパラメータを API サーバーのセキュリティポリシーに従って設定する必要があります
# 各認証方法の例が以下に提供されています。認証ユースケースに合う例を使用してください。
# APIキー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    limit = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    order = client.SORTDIR() # SORTDIR |  (optional)
    after = 3.4 # float |  (optional)
    before = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_audit_logs(tenant_id, GetAuditLogsOptions(limit=limit, skip=skip, order=order, after=after, before=before))
        print("The response of DefaultApi->get_audit_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_audit_logs: %s\n" % e)

logout_public

レスポンス

戻り値: APIEmptyResponse

例

logout_public の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    try:
        api_response = api_instance.logout_public()
        print("The response of PublicApi->logout_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->logout_public: %s\n" % e)

block_from_comment_public

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: BlockSuccess

例

block_from_comment_public の例

Copy

import client
from client.models.block_success import BlockSuccess
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->block_from_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->block_from_comment_public: %s\n" % e)

un_block_comment_public

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: UnblockSuccess

例

un_block_comment_public の例

Copy

import client
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.models.unblock_success import UnblockSuccess
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->un_block_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_block_comment_public: %s\n" % e)

checked_comments_for_blocked

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
commentIds	string	query	Yes	コメントIDのカンマ区切りリスト。
sso	string	query	No

レスポンス

戻り値: CheckBlockedCommentsResponse

例

checked_comments_for_blocked の例

Copy

import client
from client.models.check_blocked_comments_response import CheckBlockedCommentsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py に、サポートされているすべての設定パラメータの一覧があります。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_ids = 'comment_ids_example' # str | コメントIDのカンマ区切りリスト。
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, sso=sso)
        print("The response of PublicApi->checked_comments_for_blocked:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->checked_comments_for_blocked: %s\n" % e)

block_user_from_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

Returns: BlockSuccess

例

block_user_from_comment 例

Copy

import client
from client.api.default_api import BlockUserFromCommentOptions
from client.models.block_from_comment_params import BlockFromCommentParams
from client.models.block_success import BlockSuccess
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます。
# クライアントは認証と認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って
# 各認証方法の例が以下に提供されています。以下の例を使用してください
# 認証ユースケースに合致するものを
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, BlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->block_user_from_comment: %s\n" % e)

create_comment_public

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

レスポンス

戻り値: SaveCommentsResponseWithPresence

例

create_comment_public の例

Copy

import client
from client.api.public_api import CreateCommentPublicOptions
from client.models.comment_data import CommentData
from client.models.save_comments_response_with_presence import SaveCommentsResponseWithPresence
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_data = client.CommentData() # CommentData | 
    session_id = 'session_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, CreateCommentPublicOptions(session_id=session_id, sso=sso))
        print("The response of PublicApi->create_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_comment_public: %s\n" % e)

delete_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
isLive	boolean	query	No

レスポンス

返却: DeleteCommentResult

例

delete_comment の例

Copy

import client
from client.api.default_api import DeleteCommentOptions
from client.models.delete_comment_result import DeleteCommentResult
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされている構成パラメータの一覧が確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります
# 各認証方法の例が以下に提供されているので、あなたの認証ユースケースに合う例を使用してください
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、以下のコメントアウトを外して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    context_user_id = 'context_user_id_example' # str |  (optional)
    is_live = True # bool |  (optional)
    try:
        api_response = api_instance.delete_comment(tenant_id, id, DeleteCommentOptions(context_user_id=context_user_id, is_live=is_live))
        print("The response of DefaultApi->delete_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_comment: %s\n" % e)

delete_comment_public

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

レスポンス

戻り値: PublicAPIDeleteCommentResponse

例

delete_comment_public の例

Copy

import client
from client.api.public_api import DeleteCommentPublicOptions
from client.models.public_api_delete_comment_response import PublicAPIDeleteCommentResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  （オプション）
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, DeleteCommentPublicOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->delete_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_public: %s\n" % e)

delete_comment_vote

パラメータ

名前	タイプ	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
voteId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

レスポンス

返却: VoteDeleteResponse

例

delete_comment_vote の例

Copy

import client
from client.api.public_api import DeleteCommentVoteOptions
from client.models.vote_delete_response import VoteDeleteResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご確認ください
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    vote_id = 'vote_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, DeleteCommentVoteOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->delete_comment_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_vote: %s\n" % e)

flag_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

応答

戻り値: FlagCommentResponse

例

flag_comment の例

Copy

import client
from client.api.default_api import FlagCommentOptions
from client.models.flag_comment_response import FlagCommentResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは、認証および認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って
# 各認証方法の例が以下に提供されています。ご自分の認証ユースケースに合う例を使用してください。
# APIキー認証を設定: api_key
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  （オプション）
    anon_user_id = 'anon_user_id_example' # str |  （オプション）
    try:
        api_response = api_instance.flag_comment(tenant_id, id, FlagCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->flag_comment: %s\n" % e)

get_comment

パラメータ

Name	Type	Location	Required	Description
tenantId	string	クエリ	はい
id	string	パス	はい

レスポンス

返却: APIGetCommentResponse

例

get_comment の例

Copy

import client
from client.models.api_get_comment_response import APIGetCommentResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例を以下に示します。ご自身の認証ユースケースに
# 適した例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_comment(tenant_id, id)
        print("The response of DefaultApi->get_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comment: %s\n" % e)

get_comment_text

Parameters

Name	Type	Location	Required
tenantId	string	path	Yes
commentId	string	path	Yes
editKey	string	query	No
sso	string	query	No

Response

戻り値: PublicAPIGetCommentTextResponse

Example

get_comment_text の例

Copy

import client
from client.api.public_api import GetCommentTextOptions
from client.models.public_api_get_comment_text_response import PublicAPIGetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_comment_text(tenant_id, comment_id, GetCommentTextOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->get_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_text: %s\n" % e)

get_comment_vote_user_names

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
dir	integer	query	はい
sso	string	query	いいえ

レスポンス

戻り値: GetCommentVoteUserNamesSuccessResponse

例

get_comment_vote_user_names の例

Copy

import client
from client.models.get_comment_vote_user_names_success_response import GetCommentVoteUserNamesSuccessResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    dir = 56 # int | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, sso=sso)
        print("The response of PublicApi->get_comment_vote_user_names:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_vote_user_names: %s\n" % e)

get_comments

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

レスポンス

返り値: APIGetCommentsResponse

例

get_comments の例

Copy

import client
from client.api.default_api import GetCommentsOptions
from client.models.api_get_comments_response import APIGetCommentsResponse
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に示されています。使用ケースに合った例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 56 # int |  (optional)
    limit = 56 # int |  (optional)
    skip = 56 # int |  (optional)
    as_tree = True # bool |  (optional)
    skip_children = 56 # int |  (optional)
    limit_children = 56 # int |  (optional)
    max_tree_depth = 56 # int |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    context_user_id = 'context_user_id_example' # str |  (optional)
    hash_tag = 'hash_tag_example' # str |  (optional)
    parent_id = 'parent_id_example' # str |  (optional)
    direction = client.SortDirections() # SortDirections |  (optional)
    from_date = 56 # int |  (optional)
    to_date = 56 # int |  (optional)
    try:
        api_response = api_instance.get_comments(tenant_id, GetCommentsOptions(page=page, limit=limit, skip=skip, as_tree=as_tree, skip_children=skip_children, limit_children=limit_children, max_tree_depth=max_tree_depth, url_id=url_id, user_id=user_id, anon_user_id=anon_user_id, context_user_id=context_user_id, hash_tag=hash_tag, parent_id=parent_id, direction=direction, from_date=from_date, to_date=to_date))
        print("The response of DefaultApi->get_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comments: %s\n" % e)

get_comments_public

req tenantId urlId

パラメータ

名前	タイプ	ロケーション	必須
tenantId	string	path	はい
urlId	string	query	はい
page	integer	query	いいえ
direction	string	query	いいえ
sso	string	query	いいえ
skip	integer	query	いいえ
skipChildren	integer	query	いいえ
limit	integer	query	いいえ
limitChildren	integer	query	いいえ
countChildren	boolean	query	いいえ
fetchPageForCommentId	string	query	いいえ
includeConfig	boolean	query	いいえ
countAll	boolean	query	いいえ
includei10n	boolean	query	いいえ
locale	string	query	いいえ
modules	string	query	いいえ
isCrawler	boolean	query	いいえ
includeNotificationCount	boolean	query	いいえ
asTree	boolean	query	いいえ
maxTreeDepth	integer	query	いいえ
useFullTranslationIds	boolean	query	いいえ
parentId	string	query	いいえ
searchText	string	query	いいえ
hashTags	array	query	いいえ
userId	string	query	いいえ
customConfigStr	string	query	いいえ
afterCommentId	string	query	いいえ
beforeCommentId	string	query	いいえ

レスポンス

Returns: GetCommentsResponseWithPresencePublicComment

例

get_comments_public 例

Copy

import client
from client.api.public_api import GetCommentsPublicOptions
from client.models.get_comments_response_with_presence_public_comment import GetCommentsResponseWithPresencePublicComment
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    page = 56 # int |  (optional)
    direction = client.SortDirections() # SortDirections |  (optional)
    sso = 'sso_example' # str |  (optional)
    skip = 56 # int |  (optional)
    skip_children = 56 # int |  (optional)
    limit = 56 # int |  (optional)
    limit_children = 56 # int |  (optional)
    count_children = True # bool |  (optional)
    fetch_page_for_comment_id = 'fetch_page_for_comment_id_example' # str |  (optional)
    include_config = True # bool |  (optional)
    count_all = True # bool |  (optional)
    includei10n = True # bool |  (optional)
    locale = 'locale_example' # str |  (optional)
    modules = 'modules_example' # str |  (optional)
    is_crawler = True # bool |  (optional)
    include_notification_count = True # bool |  (optional)
    as_tree = True # bool |  (optional)
    max_tree_depth = 56 # int |  (optional)
    use_full_translation_ids = True # bool |  (optional)
    parent_id = 'parent_id_example' # str |  (optional)
    search_text = 'search_text_example' # str |  (optional)
    hash_tags = ['hash_tags_example'] # List[str] |  (optional)
    user_id = 'user_id_example' # str |  (optional)
    custom_config_str = 'custom_config_str_example' # str |  (optional)
    after_comment_id = 'after_comment_id_example' # str |  (optional)
    before_comment_id = 'before_comment_id_example' # str |  (optional)
    try:
        api_response = api_instance.get_comments_public(tenant_id, url_id, GetCommentsPublicOptions(page=page, direction=direction, sso=sso, skip=skip, skip_children=skip_children, limit=limit, limit_children=limit_children, count_children=count_children, fetch_page_for_comment_id=fetch_page_for_comment_id, include_config=include_config, count_all=count_all, includei10n=includei10n, locale=locale, modules=modules, is_crawler=is_crawler, include_notification_count=include_notification_count, as_tree=as_tree, max_tree_depth=max_tree_depth, use_full_translation_ids=use_full_translation_ids, parent_id=parent_id, search_text=search_text, hash_tags=hash_tags, user_id=user_id, custom_config_str=custom_config_str, after_comment_id=after_comment_id, before_comment_id=before_comment_id))
        print("The response of PublicApi->get_comments_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comments_public: %s\n" % e)

lock_comment

パラメータ

名前	型	Location	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

lock_comment の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの設定は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータは configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->lock_comment: %s\n" % e)

pin_comment

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: ChangeCommentPinStatusResponse

例

pin_comment の例

Copy

import client
from client.models.change_comment_pin_status_response import ChangeCommentPinStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->pin_comment: %s\n" % e)

save_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

レスポンス

戻り値: APISaveCommentResponse

例

save_comment の例

Copy

import client
from client.api.default_api import SaveCommentOptions
from client.models.api_save_comment_response import APISaveCommentResponse
from client.models.create_comment_params import CreateCommentParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧をご確認ください
# クライアントは API サーバーのセキュリティポリシーに従って、認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って
# 各認証方法の例が以下に提供されています。適切な例を使用してください
# あなたの認証ユースケースに合致するもの
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_comment_params = client.CreateCommentParams() # CreateCommentParams | 
    is_live = True # bool |  (optional)
    do_spam_check = True # bool |  (optional)
    send_emails = True # bool |  (optional)
    populate_notifications = True # bool |  (optional)
    try:
        api_response = api_instance.save_comment(tenant_id, create_comment_params, SaveCommentOptions(is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications))
        print("The response of DefaultApi->save_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->save_comment: %s\n" % e)

save_comments_bulk

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

レスポンス

戻り値: SaveCommentsBulkResponse

例

save_comments_bulk の例

Copy

import client
from client.api.default_api import SaveCommentsBulkOptions
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comments_bulk_response import SaveCommentsBulkResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
# クライアントは認証および認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って
# 各認証方式の例が以下に提供されているので、使用ケースに合致する例を使用してください
# あなたの認証使用ケースを満たすものを
# APIキー認証を設定: api_key
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_comment_params = [client.CreateCommentParams()] # List[CreateCommentParams] | 
    is_live = True # bool |  (オプション)
    do_spam_check = True # bool |  (オプション)
    send_emails = True # bool |  (オプション)
    populate_notifications = True # bool |  (オプション)
    try:
        api_response = api_instance.save_comments_bulk(tenant_id, create_comment_params, SaveCommentsBulkOptions(is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications))
        print("The response of DefaultApi->save_comments_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->save_comments_bulk: %s\n" % e)

set_comment_text

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
editKey	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: PublicAPISetCommentTextResponse

例

set_comment_text の例

Copy

import client
from client.api.public_api import SetCommentTextOptions
from client.models.comment_text_update_request import CommentTextUpdateRequest
from client.models.public_api_set_comment_text_response import PublicAPISetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_text_update_request = client.CommentTextUpdateRequest() # CommentTextUpdateRequest | 
    edit_key = 'edit_key_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, SetCommentTextOptions(edit_key=edit_key, sso=sso))
        print("The response of PublicApi->set_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->set_comment_text: %s\n" % e)

un_block_user_from_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

応答

返却: UnblockSuccess

例

un_block_user_from_comment の例

Copy

import client
from client.api.default_api import UnBlockUserFromCommentOptions
from client.models.un_block_from_comment_params import UnBlockFromCommentParams
from client.models.unblock_success import UnblockSuccess
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に示されていますので、認証ユースケースに合致する例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、以下のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (オプション)
    anon_user_id = 'anon_user_id_example' # str |  (オプション)
    try:
        api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, UnBlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->un_block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_block_user_from_comment: %s\n" % e)

un_flag_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

返却: FlagCommentResponse

例

un_flag_comment の例

Copy

import client
from client.api.default_api import UnFlagCommentOptions
from client.models.flag_comment_response import FlagCommentResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に提供されています。
# あなたの認証ユースケースに合う例を使用してください。
# API キー認可を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.un_flag_comment(tenant_id, id, UnFlagCommentOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->un_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_flag_comment: %s\n" % e)

un_lock_comment

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

un_lock_comment の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_lock_comment: %s\n" % e)

un_pin_comment

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

レスポンス

返却値: ChangeCommentPinStatusResponse

例

un_pin_comment の例

Copy

import client
from client.models.change_comment_pin_status_response import ChangeCommentPinStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストを開きます
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_pin_comment: %s\n" % e)

update_comment

Parameters

名前	種類	場所	必須
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
doSpamCheck	boolean	query	No
isLive	boolean	query	No

Response

戻り値: APIEmptyResponse

例

update_comment 例

Copy

import client
from client.api.default_api import UpdateCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.models.updatable_comment_params import UpdatableCommentParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティ ポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に示されています。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    updatable_comment_params = client.UpdatableCommentParams() # UpdatableCommentParams | 
    context_user_id = 'context_user_id_example' # str |  (optional)
    do_spam_check = True # bool |  (optional)
    is_live = True # bool |  (optional)
    try:
        api_response = api_instance.update_comment(tenant_id, id, updatable_comment_params, UpdateCommentOptions(context_user_id=context_user_id, do_spam_check=do_spam_check, is_live=is_live))
        print("The response of DefaultApi->update_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_comment: %s\n" % e)

vote_comment

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

応答

戻り値: VoteResponse

例

vote_comment の例

Copy

import client
from client.api.public_api import VoteCommentOptions
from client.models.vote_body_params import VoteBodyParams
from client.models.vote_response import VoteResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータのリストをご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    vote_body_params = client.VoteBodyParams() # VoteBodyParams | 
    session_id = 'session_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, VoteCommentOptions(session_id=session_id, sso=sso))
        print("The response of PublicApi->vote_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->vote_comment: %s\n" % e)

get_comments_for_user

パラメータ

名前	型	場所	必須
userId	string	query	No
direction	string	query	No
repliesToUserId	string	query	No
page	number	query	No
includei10n	boolean	query	No
locale	string	query	No
isCrawler	boolean	query	No

レスポンス

戻り値: GetCommentsForUserResponse

例

get_comments_for_user の例

Copy

import client
from client.api.public_api import GetCommentsForUserOptions
from client.models.get_comments_for_user_response import GetCommentsForUserResponse
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    user_id = 'user_id_example' # str |  (optional)
    direction = client.SortDirections() # SortDirections |  (optional)
    replies_to_user_id = 'replies_to_user_id_example' # str |  (optional)
    page = 3.4 # float |  (optional)
    includei10n = True # bool |  (optional)
    locale = 'locale_example' # str |  (optional)
    is_crawler = True # bool |  (optional)
    try:
        api_response = api_instance.get_comments_for_user(GetCommentsForUserOptions(user_id=user_id, direction=direction, replies_to_user_id=replies_to_user_id, page=page, includei10n=includei10n, locale=locale, is_crawler=is_crawler))
        print("The response of PublicApi->get_comments_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comments_for_user: %s\n" % e)

add_domain_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	クエリ	はい

レスポンス

戻り値: AddDomainConfigResponse

例

add_domain_config の例

Copy

import client
from client.models.add_domain_config_params import AddDomainConfigParams
from client.models.add_domain_config_response import AddDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバのセキュリティポリシーに従ってください。
# 各認証方法の例を以下に示します。ご自身のユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、以下の行のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    add_domain_config_params = client.AddDomainConfigParams() # AddDomainConfigParams | 
    try:
        api_response = api_instance.add_domain_config(tenant_id, add_domain_config_params)
        print("The response of DefaultApi->add_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_domain_config: %s\n" % e)

delete_domain_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
domain	string	path	はい

レスポンス

返却値: DeleteDomainConfigResponse

例

delete_domain_config の例

Copy

import client
from client.models.delete_domain_config_response import DeleteDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例は以下に示されています、使用する例は
# あなたの認証ユースケースに合致するものを選んでください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.delete_domain_config(tenant_id, domain)
        print("The response of DefaultApi->delete_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_domain_config: %s\n" % e)

get_domain_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
domain	string	path	はい

レスポンス

返却値: GetDomainConfigResponse

例

get_domain_config の例

Copy

import client
from client.models.get_domain_config_response import GetDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを構成する必要があります
# API サーバーのセキュリティポリシーに従って。
# 各認証方法の例は以下に示されています。使用する例は
# ご自身の認証ユースケースに合うものを使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.get_domain_config(tenant_id, domain)
        print("The response of DefaultApi->get_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_domain_config: %s\n" % e)

get_domain_configs

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: GetDomainConfigsResponse

例

get_domain_configs の例

Copy

import client
from client.models.get_domain_configs_response import GetDomainConfigsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、既定値は https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例は以下に示されています。あなたのユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外します
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_domain_configs(tenant_id)
        print("The response of DefaultApi->get_domain_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_domain_configs: %s\n" % e)

patch_domain_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
domainToUpdate	string	path	はい

レスポンス

戻り値: PatchDomainConfigResponse

例

patch_domain_config の例

Copy

import client
from client.models.patch_domain_config_params import PatchDomainConfigParams
from client.models.patch_domain_config_response import PatchDomainConfigResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 以下に各認証方式の例を示します。あなたの認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_to_update = 'domain_to_update_example' # str | 
    patch_domain_config_params = client.PatchDomainConfigParams() # PatchDomainConfigParams | 
    try:
        api_response = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
        print("The response of DefaultApi->patch_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_domain_config: %s\n" % e)

put_domain_config

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

レスポンス

戻り値: PutDomainConfigResponse

例

put_domain_config の例

Copy

import client
from client.models.put_domain_config_response import PutDomainConfigResponse
from client.models.update_domain_config_params import UpdateDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って設定してください。
# 各認証方式のサンプルは以下に示されています。ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_to_update = 'domain_to_update_example' # str | 
    update_domain_config_params = client.UpdateDomainConfigParams() # UpdateDomainConfigParams | 
    try:
        api_response = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
        print("The response of DefaultApi->put_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->put_domain_config: %s\n" % e)

create_email_template

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	必須

戻り値

Returns: CreateEmailTemplateResponse

例

create_email_template の例

Copy

import client
from client.models.create_email_template_body import CreateEmailTemplateBody
from client.models.create_email_template_response import CreateEmailTemplateResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは、API サーバーのセキュリティポリシーに従って認証および認可パラメータを構成する必要があります。
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_email_template_body = client.CreateEmailTemplateBody() # CreateEmailTemplateBody | 
    try:
        api_response = api_instance.create_email_template(tenant_id, create_email_template_body)
        print("The response of DefaultApi->create_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_email_template: %s\n" % e)

delete_email_template

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_email_template の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_email_template(tenant_id, id)
        print("The response of DefaultApi->delete_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template: %s\n" % e)

delete_email_template_render_error

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
errorId	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_email_template_render_error の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを設定する必要があります
# それは API サーバーのセキュリティポリシーに従う必要があります。
# 各認証方式の例を以下に示します、
# ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて下記のコメントを外して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入る
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    error_id = 'error_id_example' # str | 
    try:
        api_response = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
        print("The response of DefaultApi->delete_email_template_render_error:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template_render_error: %s\n" % e)

get_email_template

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetEmailTemplateResponse

例

get_email_template の例

Copy

import client
from client.models.get_email_template_response import GetEmailTemplateResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_email_template(tenant_id, id)
        print("The response of DefaultApi->get_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template: %s\n" % e)

get_email_template_definitions

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes

レスポンス

戻り値: GetEmailTemplateDefinitionsResponse

例

get_email_template_definitions の例

Copy

import client
from client.models.get_email_template_definitions_response import GetEmailTemplateDefinitionsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って設定します。
# 各認証方式の例を以下に示します。
# ご利用の認証ユースケースに合致する例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_email_template_definitions(tenant_id)
        print("The response of DefaultApi->get_email_template_definitions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template_definitions: %s\n" % e)

get_email_template_render_errors

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
skip	number	query	No

レスポンス

戻り値: GetEmailTemplateRenderErrorsResponse

例

get_email_template_render_errors の例

Copy

import client
from client.models.get_email_template_render_errors_response import GetEmailTemplateRenderErrorsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータは configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# （API サーバーのセキュリティポリシーに従って）
# 以下に各認証方式の例を示します。
# あなたの認証ユースケースを満たす例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_email_template_render_errors(tenant_id, id, skip=skip)
        print("The response of DefaultApi->get_email_template_render_errors:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template_render_errors: %s\n" % e)

get_email_templates

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetEmailTemplatesResponse

例

get_email_templates の例

Copy

import client
from client.models.get_email_templates_response import GetEmailTemplatesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。ご自身の認証ユースケースに合った例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (任意)
    try:
        api_response = api_instance.get_email_templates(tenant_id, skip=skip)
        print("The response of DefaultApi->get_email_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_templates: %s\n" % e)

render_email_template

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
locale	string	query	いいえ

レスポンス

戻り値: RenderEmailTemplateResponse

例

render_email_template の例

Copy

import client
from client.models.render_email_template_body import RenderEmailTemplateBody
from client.models.render_email_template_response import RenderEmailTemplateResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 以下に各認証方法の例を示します。あなたの認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、下記のコメントアウトを解除して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使うコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    render_email_template_body = client.RenderEmailTemplateBody() # RenderEmailTemplateBody | 
    locale = 'locale_example' # str |  (optional)
    try:
        api_response = api_instance.render_email_template(tenant_id, render_email_template_body, locale=locale)
        print("The response of DefaultApi->render_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->render_email_template: %s\n" % e)

update_email_template

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

update_email_template の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_email_template_body import UpdateEmailTemplateBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例は以下に示されています。あなたのユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスのコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_email_template_body = client.UpdateEmailTemplateBody() # UpdateEmailTemplateBody | 
    try:
        api_response = api_instance.update_email_template(tenant_id, id, update_email_template_body)
        print("The response of DefaultApi->update_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_email_template: %s\n" % e)

get_event_log

req tenantId urlId userIdWS

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
userIdWS	string	query	はい
startTime	integer	query	はい
endTime	integer	query	いいえ

レスポンス

戻り値: GetEventLogResponse

例

get_event_log の例

Copy

import client
from client.models.get_event_log_response import GetEventLogResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# 利用可能なすべての設定パラメーターの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int |  (optional)
    try:
        api_response = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time=end_time)
        print("The response of PublicApi->get_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_event_log: %s\n" % e)

get_global_event_log

req tenantId urlId userIdWS

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
urlId	string	query	はい
userIdWS	string	query	はい
startTime	integer	query	はい
endTime	integer	query	いいえ

レスポンス

戻り値: GetEventLogResponse

例

get_global_event_log の例

Copy

import client
from client.models.get_event_log_response import GetEventLogResponse
from client.rest import ApiException
from pprint import pprint
# ホストの指定は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使用するコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int |  (オプション)
    try:
        api_response = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time=end_time)
        print("The response of PublicApi->get_global_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_global_event_log: %s\n" % e)

create_feed_post

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

レスポンス

戻り値: CreateFeedPostsResponse

例

create_feed_post の例

Copy

import client
from client.api.default_api import CreateFeedPostOptions
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_posts_response import CreateFeedPostsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご確認ください
# クライアントは、API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります
# 各認証方式の例が以下に示されています。ご自身の認証ユースケースに合う例を使用してください
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス (例: Bearer) を設定する場合は以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional) → (オプション)
    is_live = True # bool |  (optional) → (オプション)
    do_spam_check = True # bool |  (optional) → (オプション)
    skip_dup_check = True # bool |  (optional) → (オプション)
    try:
        api_response = api_instance.create_feed_post(tenant_id, create_feed_post_params, CreateFeedPostOptions(broadcast_id=broadcast_id, is_live=is_live, do_spam_check=do_spam_check, skip_dup_check=skip_dup_check))
        print("The response of DefaultApi->create_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_feed_post: %s\n" % e)

create_feed_post_public

パラメータ

Name	Type	Location	Required
tenantId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

返却: CreateFeedPostResponse

例

create_feed_post_public の例

Copy

import client
from client.api.public_api import CreateFeedPostPublicOptions
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_post_response import CreateFeedPostResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧をご確認ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, CreateFeedPostPublicOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->create_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_feed_post_public: %s\n" % e)

delete_feed_post_public

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

返り値: DeleteFeedPostPublicResponse

例

delete_feed_post_public 例

Copy

import client
from client.api.public_api import DeleteFeedPostPublicOptions
from client.models.delete_feed_post_public_response import DeleteFeedPostPublicResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  （オプション）
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.delete_feed_post_public(tenant_id, post_id, DeleteFeedPostPublicOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->delete_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_feed_post_public: %s\n" % e)

get_feed_posts

リクエスト tenantId afterId

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
afterId	string	query	いいえ
limit	integer	query	いいえ
tags	array	query	いいえ

レスポンス

返却: GetFeedPostsResponse

例

get_feed_posts 例

Copy

import client
from client.api.default_api import GetFeedPostsOptions
from client.models.get_feed_posts_response import GetFeedPostsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# すべてのサポートされている構成パラメータの一覧は configuration.py を参照してください。
# クライアントは認証および認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って。
# 各認証方法の例が以下に提供されています。使用ケースに合う例を使用してください。
# APIキー認証を設定します: api_key
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外します
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (optional)
    limit = 56 # int |  (optional)
    tags = ['tags_example'] # List[str] |  (optional)
    try:
        api_response = api_instance.get_feed_posts(tenant_id, GetFeedPostsOptions(after_id=after_id, limit=limit, tags=tags))
        print("The response of DefaultApi->get_feed_posts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_feed_posts: %s\n" % e)

get_feed_posts_public

req tenantId afterId

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
afterId	string	query	No
limit	integer	query	No
tags	array	query	No
sso	string	query	No
isCrawler	boolean	query	No
includeUserInfo	boolean	query	No

レスポンス

返却: PublicFeedPostsResponse

例

get_feed_posts_public の例

Copy

import client
from client.api.public_api import GetFeedPostsPublicOptions
from client.models.public_feed_posts_response import PublicFeedPostsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (optional)
    limit = 56 # int |  (optional)
    tags = ['tags_example'] # List[str] |  (optional)
    sso = 'sso_example' # str |  (optional)
    is_crawler = True # bool |  (optional)
    include_user_info = True # bool |  (optional)
    try:
        api_response = api_instance.get_feed_posts_public(tenant_id, GetFeedPostsPublicOptions(after_id=after_id, limit=limit, tags=tags, sso=sso, is_crawler=is_crawler, include_user_info=include_user_info))
        print("The response of PublicApi->get_feed_posts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_public: %s\n" % e)

get_feed_posts_stats

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
postIds	array	query	はい
sso	string	query	いいえ

レスポンス

戻り値: FeedPostsStatsResponse

例

get_feed_posts_stats の例

Copy

import client
from client.models.feed_posts_stats_response import FeedPostsStatsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_feed_posts_stats(tenant_id, post_ids, sso=sso)
        print("The response of PublicApi->get_feed_posts_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_stats: %s\n" % e)

get_user_reacts_public

Parameters

名前	型	場所	必須
tenantId	string	path	はい
postIds	array	query	いいえ
sso	string	query	いいえ

Response

戻り値: UserReactsResponse

Example

get_user_reacts_public 例

Copy

import client
from client.api.public_api import GetUserReactsPublicOptions
from client.models.user_reacts_response import UserReactsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_user_reacts_public(tenant_id, GetUserReactsPublicOptions(post_ids=post_ids, sso=sso))
        print("PublicApi->get_user_reacts_public のレスポンス:\n")
        pprint(api_response)
    except Exception as e:
        print("PublicApi->get_user_reacts_public を呼び出す際の例外: %s\n" % e)

react_feed_post_public

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: ReactFeedPostResponse

例

react_feed_post_public の例

Copy

import client
from client.api.public_api import ReactFeedPostPublicOptions
from client.models.react_body_params import ReactBodyParams
from client.models.react_feed_post_response import ReactFeedPostResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    react_body_params = client.ReactBodyParams() # ReactBodyParams | 
    is_undo = True # bool |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, ReactFeedPostPublicOptions(is_undo=is_undo, broadcast_id=broadcast_id, sso=sso))
        print("The response of PublicApi->react_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->react_feed_post_public: %s\n" % e)

update_feed_post

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIEmptyResponse

例

update_feed_post の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.feed_post import FeedPost
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 以下に各認証方式の例を示します。下記の例から
# ご自身の認証ユースケースに合うものを使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    feed_post = client.FeedPost() # FeedPost | 
    try:
        api_response = api_instance.update_feed_post(tenant_id, id, feed_post)
        print("The response of DefaultApi->update_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_feed_post: %s\n" % e)

update_feed_post_public

Parameters

Name	Type	Location	Required
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Response

Returns: CreateFeedPostResponse

Example

update_feed_post_public の例

Copy

import client
from client.api.public_api import UpdateFeedPostPublicOptions
from client.models.create_feed_post_response import CreateFeedPostResponse
from client.models.update_feed_post_params import UpdateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧については configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    update_feed_post_params = client.UpdateFeedPostParams() # UpdateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, UpdateFeedPostPublicOptions(broadcast_id=broadcast_id, sso=sso))
        print("PublicApi->update_feed_post_public のレスポンス:\n")
        pprint(api_response)
    except Exception as e:
        print("PublicApi->update_feed_post_public の呼び出し時の例外: %s\n" % e)

flag_comment_public

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
isFlagged	boolean	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

flag_comment_public の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    is_flagged = True # bool | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, sso=sso)
        print("The response of PublicApi->flag_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->flag_comment_public: %s\n" % e)

get_gif_large

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
largeInternalURLSanitized	string	query	Yes

レスポンス

返却値: GifGetLargeResponse

例

get_gif_large の例

Copy

import client
from client.models.gif_get_large_response import GifGetLargeResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    large_internal_url_sanitized = 'large_internal_url_sanitized_example' # str | 
    try:
        api_response = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
        print("The response of PublicApi->get_gif_large:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_gif_large: %s\n" % e)

get_gifs_search

パラメータ

名前	型	場所	必須
tenantId	string	パス	はい
search	string	クエリ	はい
locale	string	クエリ	いいえ
rating	string	クエリ	いいえ
page	number	クエリ	いいえ

レスポンス

返却: GetGifsSearchResponse

例

get_gifs_search 例

Copy

import client
from client.api.public_api import GetGifsSearchOptions
from client.models.get_gifs_search_response import GetGifsSearchResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py にはサポートされているすべての構成パラメータの一覧があります
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクラスのインスタンスを作成
with client.ApiClient(configuration) as api_client:
    # Enter a context with an instance of the API client
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    search = 'search_example' # str | 
    locale = 'locale_example' # str |  (optional)
    rating = 'rating_example' # str |  (optional)
    page = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_gifs_search(tenant_id, search, GetGifsSearchOptions(locale=locale, rating=rating, page=page))
        print("The response of PublicApi->get_gifs_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_gifs_search: %s\n" % e)

パラメータ

名前	型	場所	必須
tenantId	string	path	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

レスポンス

戻り値: GetGifsTrendingResponse

例

get_gifs_trending 例

Copy

import client
from client.api.public_api import GetGifsTrendingOptions
from client.models.get_gifs_trending_response import GetGifsTrendingResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py にはサポートされているすべての設定パラメータのリストがあります
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    locale = 'locale_example' # str |  (optional)
    rating = 'rating_example' # str |  (optional)
    page = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_gifs_trending(tenant_id, GetGifsTrendingOptions(locale=locale, rating=rating, page=page))
        print("The response of PublicApi->get_gifs_trending:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_gifs_trending: %s\n" % e)

add_hash_tag

Parameters

名前	タイプ	場所	必須	説明
tenantId	string	query	はい

Response

戻り値: CreateHashTagResponse

例

add_hash_tag 例

Copy

import client
from client.models.create_hash_tag_body import CreateHashTagBody
from client.models.create_hash_tag_response import CreateHashTagResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照してください。サポートされているすべての設定パラメータの一覧があります。
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って。
# 各認証方式の例が以下に提供されています。使用する例を選んでください
# あなたの認証ユースケースに適合するものです。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、以下のコメントを解除して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_hash_tag_body = client.CreateHashTagBody() # CreateHashTagBody |  (optional)
    try:
        api_response = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
        print("The response of DefaultApi->add_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_hash_tag: %s\n" % e)

add_hash_tags_bulk

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes

レスポンス

返却: BulkCreateHashTagsResponse

例

add_hash_tags_bulk の例

Copy

import client
from client.models.bulk_create_hash_tags_body import BulkCreateHashTagsBody
from client.models.bulk_create_hash_tags_response import BulkCreateHashTagsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータのリストを確認できます。
# クライアントは認証および認可パラメータを構成する必要があります
# それは API サーバーのセキュリティポリシーに従います
# 各認証方法の例が以下に提供されています
# 認証ユースケースに合う例を使用してください
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_create_hash_tags_body = client.BulkCreateHashTagsBody() # BulkCreateHashTagsBody |  (optional)
    try:
        api_response = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
        print("The response of DefaultApi->add_hash_tags_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_hash_tags_bulk: %s\n" % e)

delete_hash_tag

パラメータ

名前	種類	場所	必須	説明
tenantId	string	query	Yes
tag	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

delete_hash_tag 例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.delete_hash_tag_request_body import DeleteHashTagRequestBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定しなければなりません
# API サーバーのセキュリティポリシーに従って。
# 各認証方法の例が以下に提供されています。
# ご自身の認証ユースケースに合ったものを使用してください。
# API キー認可を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    tag = 'tag_example' # str | 
    delete_hash_tag_request_body = client.DeleteHashTagRequestBody() # DeleteHashTagRequestBody |  (optional)
    try:
        api_response = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
        print("The response of DefaultApi->delete_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_hash_tag: %s\n" % e)

get_hash_tags

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
page	number	query	いいえ

レスポンス

戻り値: GetHashTagsResponse

例

get_hash_tags の例

Copy

import client
from client.models.get_hash_tags_response import GetHashTagsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例が以下に示されています。自分のユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するために、以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストを開きます
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 3.4 # float |  (任意)
    try:
        api_response = api_instance.get_hash_tags(tenant_id, page=page)
        print("The response of DefaultApi->get_hash_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_hash_tags: %s\n" % e)

patch_hash_tag

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
tag	string	path	Yes

レスポンス

戻り値: UpdateHashTagResponse

例

patch_hash_tag の例

Copy

import client
from client.models.update_hash_tag_body import UpdateHashTagBody
from client.models.update_hash_tag_response import UpdateHashTagResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照してください。サポートされているすべての設定パラメータの一覧があります。
# クライアントは認証および認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って。
# 各認証方式の例が以下に提供されています。使用する例を選択してください
# あなたの認証ユースケースに合致するものを。
# APIキー認証を設定: api_key
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 必要に応じて、以下のコメントアウトを解除して API キーのプレフィックス (例: Bearer) を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    tag = 'tag_example' # str | 
    update_hash_tag_body = client.UpdateHashTagBody() # UpdateHashTagBody |  (optional)
    try:
        api_response = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
        print("The response of DefaultApi->patch_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_hash_tag: %s\n" % e)

delete_moderation_vote

パラメータ

名前	種類	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
voteId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: VoteDeleteResponse

例

delete_moderation_vote の例

Copy

import client
from client.api.moderation_api import DeleteModerationVoteOptions
from client.models.vote_delete_response import VoteDeleteResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされている構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    vote_id = 'vote_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, DeleteModerationVoteOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->delete_moderation_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->delete_moderation_vote: %s\n" % e)

get_api_comments

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

応答

返却: ModerationAPIGetCommentsResponse

例

get_api_comments の例

Copy

import client
from client.api.moderation_api import GetApiCommentsOptions
from client.models.moderation_api_get_comments_response import ModerationAPIGetCommentsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータのリストをご確認ください
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 3.4 # float |  (オプション)
    count = 3.4 # float |  (オプション)
    text_search = 'text_search_example' # str |  (オプション)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (オプション)
    filters = 'filters_example' # str |  (オプション)
    search_filters = 'search_filters_example' # str |  (オプション)
    sorts = 'sorts_example' # str |  (オプション)
    demo = True # bool |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_api_comments(tenant_id, GetApiCommentsOptions(page=page, count=count, text_search=text_search, by_ip_from_comment=by_ip_from_comment, filters=filters, search_filters=search_filters, sorts=sorts, demo=demo, sso=sso))
        print("The response of ModerationApi->get_api_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_api_comments: %s\n" % e)

get_api_export_status

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
batchJobId	string	query	No
sso	string	query	No

応答

戻り値: ModerationExportStatusResponse

例

get_api_export_status の例

Copy

import client
from client.api.moderation_api import GetApiExportStatusOptions
from client.models.moderation_export_status_response import ModerationExportStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入る
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    batch_job_id = 'batch_job_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_api_export_status(tenant_id, GetApiExportStatusOptions(batch_job_id=batch_job_id, sso=sso))
        print("The response of ModerationApi->get_api_export_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_api_export_status: %s\n" % e)

get_api_ids

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

応答

返り値: ModerationAPIGetCommentIdsResponse

例

get_api_ids の例

Copy

import client
from client.api.moderation_api import GetApiIdsOptions
from client.models.moderation_api_get_comment_ids_response import ModerationAPIGetCommentIdsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (optional)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (optional)
    filters = 'filters_example' # str |  (optional)
    search_filters = 'search_filters_example' # str |  (optional)
    after_id = 'after_id_example' # str |  (optional)
    demo = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_api_ids(tenant_id, GetApiIdsOptions(text_search=text_search, by_ip_from_comment=by_ip_from_comment, filters=filters, search_filters=search_filters, after_id=after_id, demo=demo, sso=sso))
        print("The response of ModerationApi->get_api_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_api_ids: %s\n" % e)

get_ban_users_from_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

応答

返却: GetBannedUsersFromCommentResponse

例

get_ban_users_from_comment の例

Copy

import client
from client.models.get_banned_users_from_comment_response import GetBannedUsersFromCommentResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_ban_users_from_comment(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_ban_users_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_ban_users_from_comment: %s\n" % e)

get_comment_ban_status

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

応答

返却: GetCommentBanStatusResponse

例

get_comment_ban_status の例

Copy

import client
from client.models.get_comment_ban_status_response import GetCommentBanStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py に、サポートされているすべての設定パラメータの一覧があります。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_comment_ban_status(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_comment_ban_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_comment_ban_status: %s\n" % e)

get_comment_children

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

Returns: ModerationAPIChildCommentsResponse

例

get_comment_children 例

Copy

import client
from client.models.moderation_api_child_comments_response import ModerationAPIChildCommentsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.get_comment_children(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_comment_children:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_comment_children: %s\n" % e)

get_count

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

応答

戻り値: ModerationAPICountCommentsResponse

例

get_count 例

Copy

import client
from client.api.moderation_api import GetCountOptions
from client.models.moderation_api_count_comments_response import ModerationAPICountCommentsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータのリストをご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (optional)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (optional)
    filter = 'filter_example' # str |  (optional)
    search_filters = 'search_filters_example' # str |  (optional)
    demo = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_count(tenant_id, GetCountOptions(text_search=text_search, by_ip_from_comment=by_ip_from_comment, filter=filter, search_filters=search_filters, demo=demo, sso=sso))
        print("The response of ModerationApi->get_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_count: %s\n" % e)

get_counts

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返却: GetBannedUsersCountResponse

例

get_counts の例

Copy

import client
from client.models.get_banned_users_count_response import GetBannedUsersCountResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_counts(tenant_id, sso=sso)
        print("The response of ModerationApi->get_counts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_counts: %s\n" % e)

get_logs

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

Returns: ModerationAPIGetLogsResponse

例

get_logs の例

Copy

import client
from client.models.moderation_api_get_logs_response import ModerationAPIGetLogsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.get_logs(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_logs: %s\n" % e)

get_manual_badges

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返却: GetTenantManualBadgesResponse

例

get_manual_badges の例

Copy

import client
from client.models.get_tenant_manual_badges_response import GetTenantManualBadgesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# すべてのサポートされている構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_manual_badges(tenant_id, sso=sso)
        print("The response of ModerationApi->get_manual_badges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_manual_badges: %s\n" % e)

get_manual_badges_for_user

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

応答

返却: GetUserManualBadgesResponse

例

get_manual_badges_for_user の例

Copy

import client
from client.api.moderation_api import GetManualBadgesForUserOptions
from client.models.get_user_manual_badges_response import GetUserManualBadgesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# すべてのサポートされている構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    badges_user_id = 'badges_user_id_example' # str |  (オプション)
    comment_id = 'comment_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_manual_badges_for_user(tenant_id, GetManualBadgesForUserOptions(badges_user_id=badges_user_id, comment_id=comment_id, sso=sso))
        print("The response of ModerationApi->get_manual_badges_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_manual_badges_for_user: %s\n" % e)

get_moderation_comment

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

レスポンス

Returns: ModerationAPICommentResponse

例

get_moderation_comment の例

Copy

import client
from client.api.moderation_api import GetModerationCommentOptions
from client.models.moderation_api_comment_response import ModerationAPICommentResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    include_email = True # bool |  (optional)
    include_ip = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_moderation_comment(tenant_id, comment_id, GetModerationCommentOptions(include_email=include_email, include_ip=include_ip, sso=sso))
        print("The response of ModerationApi->get_moderation_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_moderation_comment: %s\n" % e)

get_moderation_comment_text

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

返却: GetCommentTextResponse

例

get_moderation_comment_text の例

Copy

import client
from client.models.get_comment_text_response import GetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_moderation_comment_text(tenant_id, comment_id, sso=sso)
        print("The response of ModerationApi->get_moderation_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_moderation_comment_text: %s\n" % e)

get_pre_ban_summary

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
includeByUserIdAndEmail	boolean	query	いいえ
includeByIP	boolean	query	いいえ
includeByEmailDomain	boolean	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: PreBanSummary

例

get_pre_ban_summary の例

Copy

import client
from client.api.moderation_api import GetPreBanSummaryOptions
from client.models.pre_ban_summary import PreBanSummary
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての構成パラメータの一覧をご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    include_by_user_id_and_email = True # bool |  (optional)
    include_by_ip = True # bool |  (optional)
    include_by_email_domain = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_pre_ban_summary(tenant_id, comment_id, GetPreBanSummaryOptions(include_by_user_id_and_email=include_by_user_id_and_email, include_by_ip=include_by_ip, include_by_email_domain=include_by_email_domain, sso=sso))
        print("The response of ModerationApi->get_pre_ban_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_pre_ban_summary: %s\n" % e)

get_search_comments_summary

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

応答

戻り値: ModerationCommentSearchResponse

例

get_search_comments_summary の例

Copy

import client
from client.api.moderation_api import GetSearchCommentsSummaryOptions
from client.models.moderation_comment_search_response import ModerationCommentSearchResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (optional)
    filters = 'filters_example' # str |  (optional)
    search_filters = 'search_filters_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_search_comments_summary(tenant_id, GetSearchCommentsSummaryOptions(value=value, filters=filters, search_filters=search_filters, sso=sso))
        print("The response of ModerationApi->get_search_comments_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_comments_summary: %s\n" % e)

get_search_pages

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

レスポンス

返却: ModerationPageSearchResponse

例

get_search_pages の例

Copy

import client
from client.api.moderation_api import GetSearchPagesOptions
from client.models.moderation_page_search_response import ModerationPageSearchResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_search_pages(tenant_id, GetSearchPagesOptions(value=value, sso=sso))
        print("The response of ModerationApi->get_search_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_pages: %s\n" % e)

get_search_sites

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

応答

返却: ModerationSiteSearchResponse

例

get_search_sites の例

Copy

import client
from client.api.moderation_api import GetSearchSitesOptions
from client.models.moderation_site_search_response import ModerationSiteSearchResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (optional) -> str |  （オプション）
    sso = 'sso_example' # str |  (optional) -> str |  （オプション）
    try:
        api_response = api_instance.get_search_sites(tenant_id, GetSearchSitesOptions(value=value, sso=sso))
        print("The response of ModerationApi->get_search_sites:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_sites: %s\n" % e)

get_search_suggest

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

レスポンス

返り値: ModerationSuggestResponse

例

get_search_suggest の例

Copy

import client
from client.api.moderation_api import GetSearchSuggestOptions
from client.models.moderation_suggest_response import ModerationSuggestResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧をご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クラスのインスタンスを作成します
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  （オプション）
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.get_search_suggest(tenant_id, GetSearchSuggestOptions(text_search=text_search, sso=sso))
        print("The response of ModerationApi->get_search_suggest:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_suggest: %s\n" % e)

get_search_users

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
value	string	query	いいえ
sso	string	query	いいえ

応答

返却: ModerationUserSearchResponse

例

get_search_users 例

Copy

import client
from client.api.moderation_api import GetSearchUsersOptions
from client.models.moderation_user_search_response import ModerationUserSearchResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、すべてのサポートされている設定パラメータのリストを確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    value = 'value_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_search_users(tenant_id, GetSearchUsersOptions(value=value, sso=sso))
        print("The response of ModerationApi->get_search_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_search_users: %s\n" % e)

get_trust_factor

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: GetUserTrustFactorResponse

例

get_trust_factor の例

Copy

import client
from client.api.moderation_api import GetTrustFactorOptions
from client.models.get_user_trust_factor_response import GetUserTrustFactorResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご覧ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_trust_factor(tenant_id, GetTrustFactorOptions(user_id=user_id, sso=sso))
        print("The response of ModerationApi->get_trust_factor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_trust_factor: %s\n" % e)

get_user_ban_preference

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes
sso	string	query	No

Response

Returns: APIModerateGetUserBanPreferencesResponse

Example

get_user_ban_preference の例

Copy

import client
from client.models.api_moderate_get_user_ban_preferences_response import APIModerateGetUserBanPreferencesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧をご確認ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_user_ban_preference(tenant_id, sso=sso)
        print("The response of ModerationApi->get_user_ban_preference:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_user_ban_preference: %s\n" % e)

get_user_internal_profile

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	query	No
sso	string	query	No

レスポンス

返却: GetUserInternalProfileResponse

例

get_user_internal_profile 例

Copy

import client
from client.api.moderation_api import GetUserInternalProfileOptions
from client.models.get_user_internal_profile_response import GetUserInternalProfileResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータのリストを確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_user_internal_profile(tenant_id, GetUserInternalProfileOptions(comment_id=comment_id, sso=sso))
        print("The response of ModerationApi->get_user_internal_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->get_user_internal_profile: %s\n" % e)

post_adjust_comment_votes

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

返却: AdjustVotesResponse

例

post_adjust_comment_votes の例

Copy

import client
from client.api.moderation_api import PostAdjustCommentVotesOptions
from client.models.adjust_comment_votes_params import AdjustCommentVotesParams
from client.models.adjust_votes_response import AdjustVotesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が得られます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    adjust_comment_votes_params = client.AdjustCommentVotesParams() # AdjustCommentVotesParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, PostAdjustCommentVotesOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_adjust_comment_votes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_adjust_comment_votes: %s\n" % e)

post_api_export

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
text-search	string	query	いいえ
byIPFromComment	string	query	いいえ
filters	string	query	いいえ
searchFilters	string	query	いいえ
sorts	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: ModerationExportResponse

例

post_api_export 例

Copy

import client
from client.api.moderation_api import PostApiExportOptions
from client.models.moderation_export_response import ModerationExportResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# すべてのサポートされている構成パラメータのリストは configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (オプション)
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  (オプション)
    filters = 'filters_example' # str |  (オプション)
    search_filters = 'search_filters_example' # str |  (オプション)
    sorts = 'sorts_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.post_api_export(tenant_id, PostApiExportOptions(text_search=text_search, by_ip_from_comment=by_ip_from_comment, filters=filters, search_filters=search_filters, sorts=sorts, sso=sso))
        print("The response of ModerationApi->post_api_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_api_export: %s\n" % e)

post_ban_user_from_comment

Parameters

名前	タイプ	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
banEmail	boolean	query	いいえ
banEmailDomain	boolean	query	いいえ
banIP	boolean	query	いいえ
deleteAllUsersComments	boolean	query	いいえ
bannedUntil	string	query	いいえ
isShadowBan	boolean	query	いいえ
updateId	string	query	いいえ
banReason	string	query	いいえ
sso	string	query	いいえ

Response

返却: BanUserFromCommentResult

例

post_ban_user_from_comment の例

Copy

import client
from client.api.moderation_api import PostBanUserFromCommentOptions
from client.models.ban_user_from_comment_result import BanUserFromCommentResult
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    ban_email = True # bool |  (optional)
    ban_email_domain = True # bool |  (optional)
    ban_ip = True # bool |  (optional)
    delete_all_users_comments = True # bool |  (optional)
    banned_until = 'banned_until_example' # str |  (optional)
    is_shadow_ban = True # bool |  (optional)
    update_id = 'update_id_example' # str |  (optional)
    ban_reason = 'ban_reason_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_ban_user_from_comment(tenant_id, comment_id, PostBanUserFromCommentOptions(ban_email=ban_email, ban_email_domain=ban_email_domain, ban_ip=ban_ip, delete_all_users_comments=delete_all_users_comments, banned_until=banned_until, is_shadow_ban=is_shadow_ban, update_id=update_id, ban_reason=ban_reason, sso=sso))
        print("The response of ModerationApi->post_ban_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_ban_user_from_comment: %s\n" % e)

post_ban_user_undo

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

post_ban_user_undo 例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.ban_user_undo_params import BanUserUndoParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    ban_user_undo_params = client.BanUserUndoParams() # BanUserUndoParams | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, sso=sso)
        print("The response of ModerationApi->post_ban_user_undo:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_ban_user_undo: %s\n" % e)

post_bulk_pre_ban_summary

パラメータ

名前	型	場所	必要
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

応答

Returns: BulkPreBanSummary

例

post_bulk_pre_ban_summary の例

Copy

import client
from client.api.moderation_api import PostBulkPreBanSummaryOptions
from client.models.bulk_pre_ban_params import BulkPreBanParams
from client.models.bulk_pre_ban_summary import BulkPreBanSummary
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータのリストを確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_pre_ban_params = client.BulkPreBanParams() # BulkPreBanParams | 
    include_by_user_id_and_email = True # bool |  (optional)
    include_by_ip = True # bool |  (optional)
    include_by_email_domain = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, PostBulkPreBanSummaryOptions(include_by_user_id_and_email=include_by_user_id_and_email, include_by_ip=include_by_ip, include_by_email_domain=include_by_email_domain, sso=sso))
        print("The response of ModerationApi->post_bulk_pre_ban_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_bulk_pre_ban_summary: %s\n" % e)

post_comments_by_ids

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

応答

Returns: ModerationAPIChildCommentsResponse

例

post_comments_by_ids 例

Copy

import client
from client.models.comments_by_ids_params import CommentsByIdsParams
from client.models.moderation_api_child_comments_response import ModerationAPIChildCommentsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての構成パラメータの一覧をご確認ください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comments_by_ids_params = client.CommentsByIdsParams() # CommentsByIdsParams | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, sso=sso)
        print("The response of ModerationApi->post_comments_by_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_comments_by_ids: %s\n" % e)

post_flag_comment

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

返却: APIEmptyResponse

例

post_flag_comment 例

Copy

import client
from client.api.moderation_api import PostFlagCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_flag_comment(tenant_id, comment_id, PostFlagCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_flag_comment: %s\n" % e)

post_remove_comment

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

返り値: PostRemoveCommentApiResponse

例

post_remove_comment の例

Copy

import client
from client.api.moderation_api import PostRemoveCommentOptions
from client.models.post_remove_comment_api_response import PostRemoveCommentApiResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  （オプション）
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.post_remove_comment(tenant_id, comment_id, PostRemoveCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_remove_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_remove_comment: %s\n" % e)

post_restore_deleted_comment

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: APIEmptyResponse

例

post_restore_deleted_comment 例

Copy

import client
from client.api.moderation_api import PostRestoreDeletedCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.post_restore_deleted_comment(tenant_id, comment_id, PostRestoreDeletedCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_restore_deleted_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_restore_deleted_comment: %s\n" % e)

post_set_comment_approval_status

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
approved	boolean	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返り値: SetCommentApprovedResponse

例

post_set_comment_approval_status の例

Copy

import client
from client.api.moderation_api import PostSetCommentApprovalStatusOptions
from client.models.set_comment_approved_response import SetCommentApprovedResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py にサポートされているすべての設定パラメータの一覧があります。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    approved = True # bool |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_set_comment_approval_status(tenant_id, comment_id, PostSetCommentApprovalStatusOptions(approved=approved, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_approval_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_approval_status: %s\n" % e)

post_set_comment_review_status

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
reviewed	boolean	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

post_set_comment_review_status 例

Copy

import client
from client.api.moderation_api import PostSetCommentReviewStatusOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# すべてのサポートされている構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    reviewed = True # bool |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_set_comment_review_status(tenant_id, comment_id, PostSetCommentReviewStatusOptions(reviewed=reviewed, broadcast_id=broadcast_id, sso=sio))
        print("The response of ModerationApi->post_set_comment_review_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_review_status: %s\n" % e)

post_set_comment_spam_status

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Response

Returns: APIEmptyResponse

Example

post_set_comment_spam_status 例

Copy

import client
from client.api.moderation_api import PostSetCommentSpamStatusOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータのリストを確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    spam = True # bool |  (optional) → (オプション)
    perm_not_spam = True # bool |  (optional) → (オプション)
    broadcast_id = 'broadcast_id_example' # str |  (optional) → (オプション)
    sso = 'sso_example' # str |  (optional) → (オプション)
    try:
        api_response = api_instance.post_set_comment_spam_status(tenant_id, comment_id, PostSetCommentSpamStatusOptions(spam=spam, perm_not_spam=perm_not_spam, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_spam_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_spam_status: %s\n" % e)

post_set_comment_text

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

応答

返却: SetCommentTextResponse

例

post_set_comment_text の例

Copy

import client
from client.api.moderation_api import PostSetCommentTextOptions
from client.models.set_comment_text_params import SetCommentTextParams
from client.models.set_comment_text_response import SetCommentTextResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    set_comment_text_params = client.SetCommentTextParams() # SetCommentTextParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, PostSetCommentTextOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_set_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_set_comment_text: %s\n" % e)

post_un_flag_comment

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Response

戻り値: APIEmptyResponse

Example

post_un_flag_comment の例

Copy

import client
from client.api.moderation_api import PostUnFlagCommentOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストを開始
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_un_flag_comment(tenant_id, comment_id, PostUnFlagCommentOptions(broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->post_un_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_un_flag_comment: %s\n" % e)

post_vote

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

返却: VoteResponse

例

post_vote 例

Copy

import client
from client.api.moderation_api import PostVoteOptions
from client.models.vote_response import VoteResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての構成パラメータの一覧が確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クラスのインスタンスを作成する
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str |  (optional)
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.post_vote(tenant_id, comment_id, PostVoteOptions(direction=direction, broadcast_id=broadcast_id, sso=sso))
        print("ModerationApi->post_vote のレスポンス:\n")
        pprint(api_response)
    except Exception as e:
        print("ModerationApi->post_vote の呼び出し中に例外が発生しました: %s\n" % e)

put_award_badge

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
badgeId	string	query	はい
userId	string	query	いいえ
commentId	string	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返り値: AwardUserBadgeResponse

例

put_award_badge 例

Copy

import client
from client.api.moderation_api import PutAwardBadgeOptions
from client.models.award_user_badge_response import AwardUserBadgeResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py にサポートされているすべての構成パラメータの一覧があります。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    badge_id = 'badge_id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    comment_id = 'comment_id_example' # str |  (オプション)
    broadcast_id = 'broadcast_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.put_award_badge(tenant_id, badge_id, PutAwardBadgeOptions(user_id=user_id, comment_id=comment_id, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->put_award_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_award_badge: %s\n" % e)

put_close_thread

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

応答

返却: APIEmptyResponse

例

put_close_thread の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.put_close_thread(tenant_id, url_id, sso=sso)
        print("The response of ModerationApi->put_close_thread:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_close_thread: %s\n" % e)

put_remove_badge

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

応答

Returns: RemoveUserBadgeResponse

例

put_remove_badge の例

Copy

import client
from client.api.moderation_api import PutRemoveBadgeOptions
from client.models.remove_user_badge_response import RemoveUserBadgeResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照してください。サポートされているすべての設定パラメータの一覧があります。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    badge_id = 'badge_id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    comment_id = 'comment_id_example' # str |  (オプション)
    broadcast_id = 'broadcast_id_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.put_remove_badge(tenant_id, badge_id, PutRemoveBadgeOptions(user_id=user_id, comment_id=comment_id, broadcast_id=broadcast_id, sso=sso))
        print("The response of ModerationApi->put_remove_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_remove_badge: %s\n" % e)

put_reopen_thread

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

応答

戻り値: APIEmptyResponse

例

put_reopen_thread の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメーターのリストが確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.put_reopen_thread(tenant_id, url_id, sso=sso)
        print("The response of ModerationApi->put_reopen_thread:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->put_reopen_thread: %s\n" % e)

set_trust_factor

Parameters

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
trustFactor	string	query	いいえ
sso	string	query	いいえ

Response

戻り値: SetUserTrustFactorResponse

例

set_trust_factor の例

Copy

import client
from client.api.moderation_api import SetTrustFactorOptions
from client.models.set_user_trust_factor_response import SetUserTrustFactorResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    trust_factor = 'trust_factor_example' # str |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.set_trust_factor(tenant_id, SetTrustFactorOptions(user_id=user_id, trust_factor=trust_factor, sso=sso))
        print("The response of ModerationApi->set_trust_factor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->set_trust_factor: %s\n" % e)

create_moderator

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateModeratorResponse

例

create_moderator の例

Copy

import client
from client.models.create_moderator_body import CreateModeratorBody
from client.models.create_moderator_response import CreateModeratorResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例は以下に示されています。
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_moderator_body = client.CreateModeratorBody() # CreateModeratorBody | 
    try:
        api_response = api_instance.create_moderator(tenant_id, create_moderator_body)
        print("The response of DefaultApi->create_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_moderator: %s\n" % e)

delete_moderator

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
sendEmail	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

delete_moderator の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。あなたの認証ケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとのコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    send_email = 'send_email_example' # str |  (オプション)
    try:
        api_response = api_instance.delete_moderator(tenant_id, id, send_email=send_email)
        print("The response of DefaultApi->delete_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_moderator: %s\n" % e)

get_moderator

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetModeratorResponse

例

get_moderator の例

Copy

import client
from client.models.get_moderator_response import GetModeratorResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 以下に各認証方法の例を示します。
# ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、下記のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_moderator(tenant_id, id)
        print("The response of DefaultApi->get_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderator: %s\n" % e)

get_moderators

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetModeratorsResponse

例

get_moderators の例

Copy

import client
from client.models.get_moderators_response import GetModeratorsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方法の例を以下に示します。
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーにプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  （任意）
    try:
        api_response = api_instance.get_moderators(tenant_id, skip=skip)
        print("The response of DefaultApi->get_moderators:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderators: %s\n" % e)

send_invite

パラメータ

名前	型	Location	必須
tenantId	string	query	はい
id	string	path	はい
fromName	string	query	はい

レスポンス

戻り値: APIEmptyResponse

例

send_invite の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証・認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。自分の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要であれば API キーに対するプレフィックス（例: Bearer）を設定するには以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    from_name = 'from_name_example' # str | 
    try:
        api_response = api_instance.send_invite(tenant_id, id, from_name)
        print("The response of DefaultApi->send_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_invite: %s\n" % e)

update_moderator

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_moderator の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_moderator_body import UpdateModeratorBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 各認証方法の例を以下に示します。
# あなたの認証ユースケースを満たす例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_moderator_body = client.UpdateModeratorBody() # UpdateModeratorBody | 
    try:
        api_response = api_instance.update_moderator(tenant_id, id, update_moderator_body)
        print("The response of DefaultApi->update_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_moderator: %s\n" % e)

delete_notification_count

パラメーター

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: APIEmptyResponse

例

delete_notification_count の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例は以下に示しています。
# 自身の認証ユースケースに合う例を使用してください。
# APIキー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_notification_count(tenant_id, id)
        print("The response of DefaultApi->delete_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_notification_count: %s\n" % e)

get_cached_notification_count

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetCachedNotificationCountResponse

例

get_cached_notification_count の例

Copy

import client
from client.models.get_cached_notification_count_response import GetCachedNotificationCountResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例を以下に示します。 
# ご利用の認証ケースに適した例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キー用のプレフィックス（例: Bearer）を設定するには、以下の行のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_cached_notification_count(tenant_id, id)
        print("The response of DefaultApi->get_cached_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_cached_notification_count: %s\n" % e)

get_notification_count

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No

レスポンス

Returns: GetNotificationCountResponse

例

get_notification_count の例

Copy

import client
from client.api.default_api import GetNotificationCountOptions
from client.models.get_notification_count_response import GetNotificationCountResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認してください。
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に示されています。認証ユースケースに合致する例を使用してください。
# APIキー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    url_id = 'url_id_example' # str |  (オプション)
    from_comment_id = 'from_comment_id_example' # str |  (オプション)
    viewed = True # bool |  (オプション)
    type = 'type_example' # str |  (オプション)
    try:
        api_response = api_instance.get_notification_count(tenant_id, GetNotificationCountOptions(user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type))
        print("The response of DefaultApi->get_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notification_count: %s\n" % e)

get_notifications

パラメータ

名前	タイプ	ロケーション	必須
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No
skip	number	query	No

レスポンス

返り値: GetNotificationsResponse

例

get_notifications の例

Copy

import client
from client.api.default_api import GetNotificationsOptions
from client.models.get_notifications_response import GetNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
# クライアントは認証と認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って。
# 各認証方法の例が以下に示されています。適切な例を使用してください
# あなたの認証ユースケースに合致するもの。
# APIキー認証を設定します: api_key
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
# APIクライアントのインスタンスでコンテキストに入ります
# APIクラスのインスタンスを作成します
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    from_comment_id = 'from_comment_id_example' # str |  (optional)
    viewed = True # bool |  (optional)
    type = 'type_example' # str |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_notifications(tenant_id, GetNotificationsOptions(user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type, skip=skip))
        print("The response of DefaultApi->get_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notifications: %s\n" % e)

update_notification

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

返却値: APIEmptyResponse

例

update_notification の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_notification_body import UpdateNotificationBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証・認可パラメータを設定する必要があります。
# 以下に各認証方式の例を示します。自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーに接頭辞（例: Bearer）を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_notification_body = client.UpdateNotificationBody() # UpdateNotificationBody | 
    user_id = 'user_id_example' # str |  （任意）
    try:
        api_response = api_instance.update_notification(tenant_id, id, update_notification_body, user_id=user_id)
        print("The response of DefaultApi->update_notification:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_notification: %s\n" % e)

create_v1_page_react

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
title	string	query	いいえ

レスポンス

戻り値: CreateV1PageReact

例

create_v1_page_react の例

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    title = 'title_example' # str |  (オプション)
    try:
        api_response = api_instance.create_v1_page_react(tenant_id, url_id, title=title)
        print("The response of PublicApi->create_v1_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_v1_page_react: %s\n" % e)

create_v2_page_react

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
urlId	string	query	はい
id	string	query	はい
title	string	query	いいえ

レスポンス

戻り値: CreateV1PageReact

例

create_v2_page_react の例

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    id = 'id_example' # str | 
    title = 'title_example' # str |  (optional)
    try:
        api_response = api_instance.create_v2_page_react(tenant_id, url_id, id, title=title)
        print("The response of PublicApi->create_v2_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_v2_page_react: %s\n" % e)

delete_v1_page_react

パラメータ

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes

レスポンス

戻り値: CreateV1PageReact

例

delete_v1_page_react の例

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメーターの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.delete_v1_page_react(tenant_id, url_id)
        print("The response of PublicApi->delete_v1_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_v1_page_react: %s\n" % e)

delete_v2_page_react

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
urlId	string	query	はい
id	string	query	はい

レスポンス

戻り値: CreateV1PageReact

例

delete_v2_page_react の例

Copy

import client
from client.models.create_v1_page_react import CreateV1PageReact
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入る
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_v2_page_react(tenant_id, url_id, id)
        print("The response of PublicApi->delete_v2_page_react:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_v2_page_react: %s\n" % e)

get_v1_page_likes

パラメータ

Name	Type	Location	Required	Description
tenantId	string	path	はい
urlId	string	query	はい

レスポンス

戻り値: GetV1PageLikes

例

get_v1_page_likes の例

Copy

import client
from client.models.get_v1_page_likes import GetV1PageLikes
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_v1_page_likes(tenant_id, url_id)
        print("The response of PublicApi->get_v1_page_likes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_v1_page_likes: %s\n" % e)

get_v2_page_react_users

パラメータ

Name	Type	Location	Required
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

レスポンス

戻り値: GetV2PageReactUsersResponse

例

get_v2_page_react_users の例

Copy

import client
from client.models.get_v2_page_react_users_response import GetV2PageReactUsersResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
        print("The response of PublicApi->get_v2_page_react_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_v2_page_react_users: %s\n" % e)

get_v2_page_reacts

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes

レスポンス

戻り値: GetV2PageReacts

例

get_v2_page_reacts の例

Copy

import client
from client.models.get_v2_page_reacts import GetV2PageReacts
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_v2_page_reacts(tenant_id, url_id)
        print("The response of PublicApi->get_v2_page_reacts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_v2_page_reacts: %s\n" % e)

add_page

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: AddPageAPIResponse

例

add_page の例

Copy

import client
from client.models.add_page_api_response import AddPageAPIResponse
from client.models.create_api_page_data import CreateAPIPageData
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例は下記に示しています。ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_api_page_data = client.CreateAPIPageData() # CreateAPIPageData | 
    try:
        api_response = api_instance.add_page(tenant_id, create_api_page_data)
        print("The response of DefaultApi->add_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_page: %s\n" % e)

delete_page

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: DeletePageAPIResponse

例

delete_page の例

Copy

import client
from client.models.delete_page_api_response import DeletePageAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。以下の例から
# あなたの認証ユースケースに合うものを使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて下の行をコメント解除して API キーの接頭辞（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_page(tenant_id, id)
        print("The response of DefaultApi->delete_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_page: %s\n" % e)

get_offline_users

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	ページ URL 識別子（サーバー側でクリーンアップされたもの）。
afterName	string	query	No	カーソル: 前回のレスポンスから nextAfterName を渡します。
afterUserId	string	query	No	カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合に、名前の同点でエントリが除外されないようにするために必須です。

Response

Returns: PageUsersOfflineResponse

Example

get_offline_users の例

Copy

import client
from client.api.public_api import GetOfflineUsersOptions
from client.models.page_users_offline_response import PageUsersOfflineResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# すべてのサポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | ページ URL 識別子（サーバー側でクリーンアップされたもの）。
    after_name = 'after_name_example' # str | カーソル: 前回のレスポンスから nextAfterName を渡します。（オプション）
    after_user_id = 'after_user_id_example' # str | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合に、名前の同点でエントリが除外されないようにするために必須です。（オプション）
    try:
        api_response = api_instance.get_offline_users(tenant_id, url_id, GetOfflineUsersOptions(after_name=after_name, after_user_id=after_user_id))
        print("The response of PublicApi->get_offline_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_offline_users: %s\n" % e)

get_online_users

現在オンラインのページ閲覧者: 現在ページにサブスクライブされているWebSocketセッションを持つユーザーです。
anonCount + totalCount を返します（部屋全体の購読者数で、列挙しない匿名閲覧者も含みます）。

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	ページURLの識別子（サーバー側でクリーンアップ済み）。
afterName	string	query	No	カーソル: 前回の応答から nextAfterName を渡す。
afterUserId	string	query	No	カーソルのタイブレーカー: 前回の応答から nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。

Response

返却: PageUsersOnlineResponse

Example

get_online_usersの例

Copy

import client
from client.api.public_api import GetOnlineUsersOptions
from client.models.page_users_online_response import PageUsersOnlineResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | ページURLの識別子（サーバー側でクリーンアップ済み）。
    after_name = 'after_name_example' # str | カーソル: 前回の応答から nextAfterName を渡す。 (optional)
    after_user_id = 'after_user_id_example' # str | カーソルのタイブレーカー: 前回の応答から nextAfterUserId を渡す。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。 (optional)
    try:
        api_response = api_instance.get_online_users(tenant_id, url_id, GetOnlineUsersOptions(after_name=after_name, after_user_id=after_user_id))
        print("The response of PublicApi->get_online_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_online_users: %s\n" % e)

get_page_by_urlid

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
urlId	string	query	はい

レスポンス

戻り値: GetPageByURLIdAPIResponse

例

get_page_by_urlid の例

Copy

import client
from client.models.get_page_by_urlid_api_response import GetPageByURLIdAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証と認可のパラメータを設定する必要があります。
# 各認証方式の例を以下に示します。あなたの認証ユースケースに合う例を使用してください。
#
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_page_by_urlid(tenant_id, url_id)
        print("The response of DefaultApi->get_page_by_urlid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_page_by_urlid: %s\n" % e)

get_pages

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Response

戻り値: GetPagesAPIResponse

例

get_pages の例

Copy

import client
from client.models.get_pages_api_response import GetPagesAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方法の例は以下に示されています。
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーにプレフィックス（例: Bearer）を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを用いてコンテキストを作成します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_pages(tenant_id)
        print("The response of DefaultApi->get_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pages: %s\n" % e)

get_pages_public

テナントのページを一覧取得します。FChat デスクトップクライアントがルームリストを生成する際に使用されます。
enableFChat が各ページの解決されたカスタム設定で true であることが必要です。
SSO が必要なページは、リクエストしたユーザーのグループアクセスに基づいてフィルタリングされます。

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
cursor	string	query	No	前回のリクエストで `nextCursor` として返された不透明なページネーションカーソルです。同じ `sortBy` に紐付けられます。
limit	integer	query	No	1..200、デフォルトは 50
q	string	query	No	オプションの大文字小文字を区別しないタイトルプレフィックスフィルタです。
sortBy	string	query	No	ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
hasComments	boolean	query	No	true の場合、少なくとも1件のコメントがあるページのみ返します。

レスポンス

返却: GetPublicPagesResponse

例

get_pages_public 例

Copy

import client
from client.api.public_api import GetPagesPublicOptions
from client.models.get_public_pages_response import GetPublicPagesResponse
from client.models.pages_sort_by import PagesSortBy
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての設定パラメータの一覧が確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    cursor = 'cursor_example' # str | 前回のリクエストで `nextCursor` として返された不透明なページネーションカーソルです。同じ `sortBy` に紐付けられます。(オプション)
    limit = 56 # int | 1..200、デフォルト 50 (オプション)
    q = 'q_example' # str | オプションの大文字小文字を区別しないタイトルプレフィックスフィルタです。(オプション)
    sort_by = client.PagesSortBy() # PagesSortBy | ソート順。`updatedAt`（デフォルト、最新が最初）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。(オプション)
    has_comments = True # bool | true の場合、少なくとも1件のコメントがあるページのみ返します。(オプション)
    try:
        api_response = api_instance.get_pages_public(tenant_id, GetPagesPublicOptions(cursor=cursor, limit=limit, q=q, sort_by=sort_by, has_comments=has_comments))
        print("The response of PublicApi->get_pages_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_pages_public: %s\n" % e)

get_users_info

テナント向けの一括ユーザー情報。userIds を指定すると、User / SSOUser から表示用の情報を返します。コメントウィジェットが、presence イベントで出現したユーザーを補完するために使用します。ページコンテキストがない場合：プライバシーは一律に適用され、非公開プロフィールはマスクされます。

パラメータ

Name	Type	Location	Required	Description
tenantId	string	path	はい
ids	string	query	はい	カンマ区切りの userIds。

レスポンス

戻り値: PageUsersInfoResponse

例

get_users_info の例

Copy

import client
from client.models.page_users_info_response import PageUsersInfoResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    ids = 'ids_example' # str | カンマ区切りの userIds。
    try:
        api_response = api_instance.get_users_info(tenant_id, ids)
        print("The response of PublicApi->get_users_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_users_info: %s\n" % e)

patch_page

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: PatchPageAPIResponse

例

patch_page の例

Copy

import client
from client.models.patch_page_api_response import PatchPageAPIResponse
from client.models.update_api_page_data import UpdateAPIPageData
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。自分の認証ケースに合う例を使用してください。
# APIキー認証を設定する: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_api_page_data = client.UpdateAPIPageData() # UpdateAPIPageData | 
    try:
        api_response = api_instance.patch_page(tenant_id, id, update_api_page_data)
        print("The response of DefaultApi->patch_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_page: %s\n" % e)

delete_pending_webhook_event

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却値: APIEmptyResponse

例

delete_pending_webhook_event の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って、認証および認可のパラメータを設定する必要があります。
# 以下に各認証方式の例を示します。ご自身のユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_pending_webhook_event(tenant_id, id)
        print("The response of DefaultApi->delete_pending_webhook_event:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_pending_webhook_event: %s\n" % e)

get_pending_webhook_event_count

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

応答

返却: GetPendingWebhookEventCountResponse

例

get_pending_webhook_event_count の例

Copy

import client
from client.api.default_api import GetPendingWebhookEventCountOptions
from client.models.get_pending_webhook_event_count_response import GetPendingWebhookEventCountResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# すべてのサポートされている設定パラメータの一覧は configuration.py を参照してください
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください
# 各認証方式の例が以下に提供されています。ご利用の認証ケースに合う例を使用してください
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  # （オプション）
    external_id = 'external_id_example' # str |  # （オプション）
    event_type = 'event_type_example' # str |  # （オプション）
    type = 'type_example' # str |  # （オプション）
    domain = 'domain_example' # str |  # （オプション）
    attempt_count_gt = 3.4 # float |  # （オプション）
    try:
        api_response = api_instance.get_pending_webhook_event_count(tenant_id, GetPendingWebhookEventCountOptions(comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt))
        print("The response of DefaultApi->get_pending_webhook_event_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_event_count: %s\n" % e)

get_pending_webhook_events

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No
skip	number	query	No

応答

Returns: GetPendingWebhookEventsResponse

例

get_pending_webhook_events の例

Copy

import client
from client.api.default_api import GetPendingWebhookEventsOptions
from client.models.get_pending_webhook_events_response import GetPendingWebhookEventsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って
# 各認証方法の例が以下に提供されています。その中から
# あなたの認証ユースケースに合致する例を使用してください。
# API キー認証を設定します: api_key
# 必要に応じて、以下のコメントを外して API キーのプレフィックス (例: Bearer) を設定してください
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (optional)
    external_id = 'external_id_example' # str |  (optional)
    event_type = 'event_type_example' # str |  (optional)
    type = 'type_example' # str |  (optional)
    domain = 'domain_example' # str |  (optional)
    attempt_count_gt = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_pending_webhook_events(tenant_id, GetPendingWebhookEventsOptions(comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt, skip=skip))
        print("The response of DefaultApi->get_pending_webhook_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_events: %s\n" % e)

create_question_config

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: CreateQuestionConfigResponse

例

create_question_config の例

Copy

import client
from client.models.create_question_config_body import CreateQuestionConfigBody
from client.models.create_question_config_response import CreateQuestionConfigResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方法の例を以下に示します。 
# 自分の認証ユースケースに合う例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーにプレフィックス（例: Bearer）を設定するには以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_question_config_body = client.CreateQuestionConfigBody() # CreateQuestionConfigBody | 
    try:
        api_response = api_instance.create_question_config(tenant_id, create_question_config_body)
        print("The response of DefaultApi->create_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_config: %s\n" % e)

delete_question_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

delete_question_config の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例は下記に示します。自分の認証ユースケースを満たす
# 例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーの接頭辞（例: Bearer）を設定するには、下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_config(tenant_id, id)
        print("The response of DefaultApi->delete_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_config: %s\n" % e)

get_question_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返り値: GetQuestionConfigResponse

例

get_question_config の例

Copy

import client
from client.models.get_question_config_response import GetQuestionConfigResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従ってください。
# 以下に各認証方式の例を示します。
# ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は、下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_config(tenant_id, id)
        print("The response of DefaultApi->get_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_config: %s\n" % e)

get_question_configs

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

返却: GetQuestionConfigsResponse

例

get_question_configs の例

Copy

import client
from client.models.get_question_configs_response import GetQuestionConfigsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントはAPIサーバーのセキュリティポリシーに従って認証および認可のパラメータを設定する必要があります。
# 各認証方法の例を以下に示します。ご利用の認証ケースに合った例を使用してください。
# APIキー認証を設定する: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスを使用するコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (オプション)
    try:
        api_response = api_instance.get_question_configs(tenant_id, skip=skip)
        print("The response of DefaultApi->get_question_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_configs: %s\n" % e)

update_question_config

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_question_config の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_question_config_body import UpdateQuestionConfigBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って設定してください。
# 以下に各認証方式の例を示します。
# ご利用の認証ユースケースに合う例を使用してください。
# API キー認証を構成します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_config_body = client.UpdateQuestionConfigBody() # UpdateQuestionConfigBody | 
    try:
        api_response = api_instance.update_question_config(tenant_id, id, update_question_config_body)
        print("The response of DefaultApi->update_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_config: %s\n" % e)

create_question_result

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateQuestionResultResponse

例

create_question_result の例

Copy

import client
from client.models.create_question_result_body import CreateQuestionResultBody
from client.models.create_question_result_response import CreateQuestionResultResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# これは API サーバーのセキュリティポリシーに従って行ってください。
# 以下に各認証方法の例を示します。 
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを生成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_question_result_body = client.CreateQuestionResultBody() # CreateQuestionResultBody | 
    try:
        api_response = api_instance.create_question_result(tenant_id, create_question_result_body)
        print("The response of DefaultApi->create_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_result: %s\n" % e)

delete_question_result

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_question_result の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証と認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。あなたのユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_result(tenant_id, id)
        print("The response of DefaultApi->delete_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_result: %s\n" % e)

get_question_result

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetQuestionResultResponse

例

get_question_result の例

Copy

import client
from client.models.get_question_result_response import GetQuestionResultResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。自分のユースケースに合った例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_result(tenant_id, id)
        print("The response of DefaultApi->get_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_result: %s\n" % e)

get_question_results

パラメータ

名前	種類	場所	必須
tenantId	string	query	Yes
urlId	string	query	No
userId	string	query	No
startDate	string	query	No
questionId	string	query	No
questionIds	string	query	No
skip	number	query	No

レスポンス

Returns: GetQuestionResultsResponse

例

get_question_results の例

Copy

import client
from client.api.default_api import GetQuestionResultsOptions
from client.models.get_question_results_response import GetQuestionResultsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# すべてのサポートされている設定パラメータのリストは configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります
# 各認証方法の例が以下に提供されています。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str |  （オプション）
    user_id = 'user_id_example' # str |  （オプション）
    start_date = 'start_date_example' # str |  （オプション）
    question_id = 'question_id_example' # str |  （オプション）
    question_ids = 'question_ids_example' # str |  （オプション）
    skip = 3.4 # float |  （オプション）
    try:
        api_response = api_instance.get_question_results(tenant_id, GetQuestionResultsOptions(url_id=url_id, user_id=user_id, start_date=start_date, question_id=question_id, question_ids=question_ids, skip=skip))
        print("The response of DefaultApi->get_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_results: %s\n" % e)

update_question_result

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

update_question_result の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_question_result_body import UpdateQuestionResultBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# これは API サーバーのセキュリティポリシーに従って行ってください。
# 各認証方式の例は以下に示しています。自分の認証ユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キー用の接頭辞（例: Bearer）を設定するには、以下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用するコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_result_body = client.UpdateQuestionResultBody() # UpdateQuestionResultBody | 
    try:
        api_response = api_instance.update_question_result(tenant_id, id, update_question_result_body)
        print("The response of DefaultApi->update_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_result: %s\n" % e)

aggregate_question_results

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
questionId	string	query	いいえ
questionIds	array	query	いいえ
urlId	string	query	いいえ
timeBucket	string	query	いいえ
startDate	string	query	いいえ
forceRecalculate	boolean	query	いいえ

レスポンス

返り値: AggregateQuestionResultsResponse

例

aggregate_question_results の例

Copy

import client
from client.api.default_api import AggregateQuestionResultsOptions
from client.models.aggregate_question_results_response import AggregateQuestionResultsResponse
from client.models.aggregate_time_bucket import AggregateTimeBucket
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定しなければなりません
# API サーバーのセキュリティポリシーに従って。
# 各認証方法の例が以下に提供されています。使用する例は
# あなたの認証ユースケースに合致するものです。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  （オプション）
    question_ids = ['question_ids_example'] # List[str] |  （オプション）
    url_id = 'url_id_example' # str |  （オプション）
    time_bucket = client.AggregateTimeBucket() # AggregateTimeBucket |  （オプション）
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  （オプション）
    force_recalculate = True # bool |  （オプション）
    try:
        api_response = api_instance.aggregate_question_results(tenant_id, AggregateQuestionResultsOptions(question_id=question_id, question_ids=question_ids, url_id=url_id, time_bucket=time_bucket, start_date=start_date, force_recalculate=force_recalculate))
        print("The response of DefaultApi->aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->aggregate_question_results: %s\n" % e)

bulk_aggregate_question_results

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
forceRecalculate	boolean	query	いいえ

レスポンス

戻り値: BulkAggregateQuestionResultsResponse

例

bulk_aggregate_question_results の例

Copy

import client
from client.models.bulk_aggregate_question_results_request import BulkAggregateQuestionResultsRequest
from client.models.bulk_aggregate_question_results_response import BulkAggregateQuestionResultsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例は以下に示しています。ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーにプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_aggregate_question_results_request = client.BulkAggregateQuestionResultsRequest() # BulkAggregateQuestionResultsRequest | 
    force_recalculate = True # bool |  （オプション）
    try:
        api_response = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, force_recalculate=force_recalculate)
        print("The response of DefaultApi->bulk_aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->bulk_aggregate_question_results: %s\n" % e)

combine_comments_with_question_results

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No
minValue	number	query	No
maxValue	number	query	No
limit	number	query	No

レスポンス

返り値: CombineQuestionResultsWithCommentsResponse

例

combine_comments_with_question_results 例

Copy

import client
from client.api.default_api import CombineCommentsWithQuestionResultsOptions
from client.models.combine_question_results_with_comments_response import CombineQuestionResultsWithCommentsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です。
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります。
# APIサーバーのセキュリティポリシーに従ってください。
# 以下に各認証方法の例が提供されています。
# ご自身の認証ユースケースに合うものを使用してください。
# APIキー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じてAPIキーのプレフィックス（例: Bearer）を設定する場合は、下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  (optional)
    question_ids = ['question_ids_example'] # List[str] |  (optional)
    url_id = 'url_id_example' # str |  (optional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    force_recalculate = True # bool |  (optional)
    min_value = 3.4 # float |  (optional)
    max_value = 3.4 # float |  (optional)
    limit = 3.4 # float |  (optional)
    try:
        api_response = api_instance.combine_comments_with_question_results(tenant_id, CombineCommentsWithQuestionResultsOptions(question_id=question_id, question_ids=question_ids, url_id=url_id, start_date=start_date, force_recalculate=force_recalculate, min_value=min_value, max_value=max_value, limit=limit))
        print("The response of DefaultApi->combine_comments_with_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->combine_comments_with_question_results: %s\n" % e)

add_sso_user

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

返却値: AddSSOUserAPIResponse

例

add_sso_user の例

Copy

import client
from client.models.add_sso_user_api_response import AddSSOUserAPIResponse
from client.models.create_apisso_user_data import CreateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされるすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例を以下に示します。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストを開きます
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_apisso_user_data = client.CreateAPISSOUserData() # CreateAPISSOUserData | 
    try:
        api_response = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
        print("The response of DefaultApi->add_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_sso_user: %s\n" % e)

delete_sso_user

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
id	string	path	はい
deleteComments	boolean	query	いいえ
commentDeleteMode	string	query	いいえ

レスポンス

戻り値: DeleteSSOUserAPIResponse

例

delete_sso_user の例

Copy

import client
from client.api.default_api import DeleteSsoUserOptions
from client.models.delete_sso_user_api_response import DeleteSSOUserAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります
# 各認証方法の例が以下に示されています。認証ユースケースに合った例を使用してください
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = True # bool |  (optional)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (optional)
    try:
        api_response = api_instance.delete_sso_user(tenant_id, id, DeleteSsoUserOptions(delete_comments=delete_comments, comment_delete_mode=comment_delete_mode))
        print("The response of DefaultApi->delete_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_sso_user: %s\n" % e)

get_sso_user_by_email

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
email	string	path	はい

レスポンス

戻り値: GetSSOUserByEmailAPIResponse

例

get_sso_user_by_email の例

Copy

import client
from client.models.get_sso_user_by_email_api_response import GetSSOUserByEmailAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、既定値は https://fastcomments.com です
# サポートされているすべての構成パラメーターの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメーターを設定する必要があります
# これは API サーバーのセキュリティポリシーに従って行ってください。
# 以下に各認証方式の例を示します。
# ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーに対するプレフィックス（例: Bearer）を設定するには下の行のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    email = 'email_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_email(tenant_id, email)
        print("The response of DefaultApi->get_sso_user_by_email:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_email: %s\n" % e)

get_sso_user_by_id

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetSSOUserByIdAPIResponse

例

get_sso_user_by_id の例

Copy

import client
from client.models.get_sso_user_by_id_api_response import GetSSOUserByIdAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例は下に示されています。使用する認証方式の例を選んでください。
# API キー認証を設定する: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要であれば下の行のコメントアウトを外して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入る
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_id(tenant_id, id)
        print("The response of DefaultApi->get_sso_user_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_id: %s\n" % e)

get_sso_users

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
skip	integer	query	いいえ

レスポンス

戻り値: GetSSOUsersResponse

例

get_sso_users の例

Copy

import client
from client.models.get_sso_users_response import GetSSOUsersResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方法の例を以下に示します。下の例から
# ご自身の認証ユースケースに合うものを使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス (例: Bearer) を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 56 # int |  (オプション)
    try:
        api_response = api_instance.get_sso_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_sso_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_users: %s\n" % e)

patch_sso_user

パラメーター

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
updateComments	boolean	query	いいえ

レスポンス

戻り値: PatchSSOUserAPIResponse

例

patch_sso_user の例

Copy

import client
from client.models.patch_sso_user_api_response import PatchSSOUserAPIResponse
from client.models.update_apisso_user_data import UpdateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを設定する必要があります
# これは API サーバーのセキュリティポリシーに従って行ってください。
# 各認証方式の例を以下に示します。
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定する: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  （オプション）
    try:
        api_response = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->patch_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_sso_user: %s\n" % e)

put_sso_user

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
updateComments	boolean	query	いいえ

レスポンス

戻り値: PutSSOUserAPIResponse

例

put_sso_user の例

Copy

import client
from client.models.put_sso_user_api_response import PutSSOUserAPIResponse
from client.models.update_apisso_user_data import UpdateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証・認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。自分の認証ケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要な場合は下のコメントアウトを解除して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスのコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  （オプション）
    try:
        api_response = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->put_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->put_sso_user: %s\n" % e)

create_subscription

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateSubscriptionAPIResponse

例

create_subscription の例

Copy

import client
from client.models.create_api_user_subscription_data import CreateAPIUserSubscriptionData
from client.models.create_subscription_api_response import CreateSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。
# 要件に合うものを使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_api_user_subscription_data = client.CreateAPIUserSubscriptionData() # CreateAPIUserSubscriptionData | 
    try:
        api_response = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
        print("The response of DefaultApi->create_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_subscription: %s\n" % e)

delete_subscription

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

戻り値: DeleteSubscriptionAPIResponse

例

delete_subscription の例

Copy

import client
from client.models.delete_subscription_api_response import DeleteSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、既定値は https://fastcomments.com です
# サポートされているすべての設定パラメータについては configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例は以下に示します。自身の認証ユースケースに合った例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには下の行のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    try:
        api_response = api_instance.delete_subscription(tenant_id, id, user_id=user_id)
        print("The response of DefaultApi->delete_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_subscription: %s\n" % e)

get_subscriptions

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
userId	string	query	いいえ

レスポンス

返却値: GetSubscriptionsAPIResponse

例

get_subscriptions の例

Copy

import client
from client.models.get_subscriptions_api_response import GetSubscriptionsAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方法の例は以下に示されています。
# ご使用の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    try:
        api_response = api_instance.get_subscriptions(tenant_id, user_id=user_id)
        print("The response of DefaultApi->get_subscriptions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_subscriptions: %s\n" % e)

update_subscription

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

戻り値: UpdateSubscriptionAPIResponse

例

update_subscription の例

Copy

import client
from client.models.update_api_user_subscription_data import UpdateAPIUserSubscriptionData
from client.models.update_subscription_api_response import UpdateSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証・認可パラメータを構成する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例は以下に示しています。ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーの接頭辞（例: Bearer）を設定するには、以下のコメントアウトを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_api_user_subscription_data = client.UpdateAPIUserSubscriptionData() # UpdateAPIUserSubscriptionData | 
    user_id = 'user_id_example' # str |  (任意)
    try:
        api_response = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, user_id=user_id)
        print("The response of DefaultApi->update_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_subscription: %s\n" % e)

get_tenant_daily_usages

パラメータ

名前	型	ロケーション	必要
tenantId	string	query	はい
yearNumber	number	query	いいえ
monthNumber	number	query	いいえ
dayNumber	number	query	いいえ
skip	number	query	いいえ

レスポンス

返却: GetTenantDailyUsagesResponse

例

get_tenant_daily_usages の例

Copy

import client
from client.api.default_api import GetTenantDailyUsagesOptions
from client.models.get_tenant_daily_usages_response import GetTenantDailyUsagesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての構成パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って。
# 各認証方法の例が以下に提供されています。使用例は
# あなたの認証ユースケースに合致するものを使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    year_number = 3.4 # float |  (optional)
    month_number = 3.4 # float |  (optional)
    day_number = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_tenant_daily_usages(tenant_id, GetTenantDailyUsagesOptions(year_number=year_number, month_number=month_number, day_number=day_number, skip=skip))
        print("The response of DefaultApi->get_tenant_daily_usages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_daily_usages: %s\n" % e)

create_tenant_package

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateTenantPackageResponse

例

create_tenant_package の例

Copy

import client
from client.models.create_tenant_package_body import CreateTenantPackageBody
from client.models.create_tenant_package_response import CreateTenantPackageResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# 使用可能な設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# これは API サーバーのセキュリティポリシーに従って行ってください。
# 以下に各認証方式の例を示します。 
# 自分の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_package_body = client.CreateTenantPackageBody() # CreateTenantPackageBody | 
    try:
        api_response = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
        print("The response of DefaultApi->create_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_package: %s\n" % e)

delete_tenant_package

パラメータ

名前	型	ロケーション	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却値: APIEmptyResponse

例

delete_tenant_package の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、省略した場合のデフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証・認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。ご利用の認証方法に合う例をお使いください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーにプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_tenant_package(tenant_id, id)
        print("The response of DefaultApi->delete_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant_package: %s\n" % e)

get_tenant_package

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: GetTenantPackageResponse

例

get_tenant_package の例

Copy

import client
from client.models.get_tenant_package_response import GetTenantPackageResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバのセキュリティポリシーに従って認証および認可のパラメータを設定する必要があります。
# 各認証方式の例は以下に示しています。自分の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_package(tenant_id, id)
        print("The response of DefaultApi->get_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_package: %s\n" % e)

get_tenant_packages

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
skip	number	query	No

レスポンス

戻り値: GetTenantPackagesResponse

例

get_tenant_packages の例

Copy

import client
from client.models.get_tenant_packages_response import GetTenantPackagesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、既定値は https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。 
# 自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (オプション)
    try:
        api_response = api_instance.get_tenant_packages(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_packages: %s\n" % e)

replace_tenant_package

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

replace_tenant_package 例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.replace_tenant_package_body import ReplaceTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下のコメントアウトを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_package_body = client.ReplaceTenantPackageBody() # ReplaceTenantPackageBody | 
    try:
        api_response = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
        print("The response of DefaultApi->replace_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_package: %s\n" % e)

update_tenant_package

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_tenant_package の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_tenant_package_body import UpdateTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。自分の利用ケースに合う例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ったコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_package_body = client.UpdateTenantPackageBody() # UpdateTenantPackageBody | 
    try:
        api_response = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
        print("The response of DefaultApi->update_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_package: %s\n" % e)

create_tenant_user

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: CreateTenantUserResponse

例

create_tenant_user の例

Copy

import client
from client.models.create_tenant_user_body import CreateTenantUserBody
from client.models.create_tenant_user_response import CreateTenantUserResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って設定してください。
# 各認証方式の例は下に示します。ご利用の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて下の行のコメントを外して、API キーにプレフィックス（例：Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストを作成します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_user_body = client.CreateTenantUserBody() # CreateTenantUserBody | 
    try:
        api_response = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
        print("The response of DefaultApi->create_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_user: %s\n" % e)

delete_tenant_user

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

レスポンス

返却: APIEmptyResponse

例

delete_tenant_user の例

Copy

import client
from client.api.default_api import DeleteTenantUserOptions
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って、認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に示されているので、認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定する場合は、以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = 'delete_comments_example' # str |  (optional)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (optional)
    try:
        api_response = api_instance.delete_tenant_user(tenant_id, id, DeleteTenantUserOptions(delete_comments=delete_comments, comment_delete_mode=comment_delete_mode))
        print("The response of DefaultApi->delete_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant_user: %s\n" % e)

get_tenant_user

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetTenantUserResponse

例

get_tenant_user の例

Copy

import client
from client.models.get_tenant_user_response import GetTenantUserResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可のパラメータを設定する必要があります。
# 各認証方法の例を下に示します。自分の認証ユースケースに合った例を使用してください。
# API キー認証を設定する: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キー用のプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入る
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_user(tenant_id, id)
        print("The response of DefaultApi->get_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_user: %s\n" % e)

get_tenant_users

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetTenantUsersResponse

例

get_tenant_users の例

Copy

import client
from client.models.get_tenant_users_response import GetTenantUsersResponse
from client.rest import ApiException
from pprint import pprint
# ホストを定義することは任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください
# 各認証方式の例が以下に示されています。
# ご自身の認証ユースケースに合う例を使用してください
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下の行のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_tenant_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_users: %s\n" % e)

replace_tenant_user

パラメータ

Name	Type	Location	必須
tenantId	string	query	はい
id	string	path	はい
updateComments	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

replace_tenant_user の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.replace_tenant_user_body import ReplaceTenantUserBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります。
# これらは API サーバーのセキュリティポリシーに従って設定してください。
# 各認証方式の例を以下に示します。
# ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用するコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_user_body = client.ReplaceTenantUserBody() # ReplaceTenantUserBody | 
    update_comments = 'update_comments_example' # str |  （オプション）
    try:
        api_response = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->replace_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_user: %s\n" % e)

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	はい
id	string	path	はい
redirectURL	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

send_login_link の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例は以下に示します。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要な場合、API キーのプレフィックス（例: Bearer）を設定するには下記のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    redirect_url = 'redirect_url_example' # str |  (任意)
    try:
        api_response = api_instance.send_login_link(tenant_id, id, redirect_url=redirect_url)
        print("The response of DefaultApi->send_login_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_login_link: %s\n" % e)

update_tenant_user

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
updateComments	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

update_tenant_user の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_tenant_user_body import UpdateTenantUserBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは、API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 以下に各認証方法の例を示します。自分の認証ユースケースに合う例を使用してください。
# API キー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには以下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ったコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_user_body = client.UpdateTenantUserBody() # UpdateTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (任意)
    try:
        api_response = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->update_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_user: %s\n" % e)

create_tenant

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: CreateTenantResponse

例

create_tenant の例

Copy

import client
from client.models.create_tenant_body import CreateTenantBody
from client.models.create_tenant_response import CreateTenantResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方式の例を以下に示します。自分の認証ユースケースに合う例を使ってください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要であれば、API キーに対するプレフィックス（例: Bearer）を設定するために以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_body = client.CreateTenantBody() # CreateTenantBody | 
    try:
        api_response = api_instance.create_tenant(tenant_id, create_tenant_body)
        print("The response of DefaultApi->create_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant: %s\n" % e)

delete_tenant

Parameters

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
sure	string	query	いいえ

レスポンス

返却値: APIEmptyResponse

例

delete_tenant の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って
# 認証および認可のパラメータを設定する必要があります。
# 各認証方式の例を以下に示します。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーの接頭辞（例: Bearer）を設定するには下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    sure = 'sure_example' # str |  （省略可能）
    try:
        api_response = api_instance.delete_tenant(tenant_id, id, sure=sure)
        print("The response of DefaultApi->delete_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant: %s\n" % e)

get_tenant

パラメーター

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetTenantResponse

例

get_tenant の例

Copy

import client
from client.models.get_tenant_response import GetTenantResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメーターの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメーターを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。
# ご自身の認証ユースケースに合った例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キー用のプレフィックス（例: Bearer）を設定するには以下のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant(tenant_id, id)
        print("The response of DefaultApi->get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant: %s\n" % e)

get_tenants

Parameters

名前	タイプ	場所	必須
tenantId	string	query	はい
meta	string	query	いいえ
skip	number	query	いいえ

Response

返り値: GetTenantsResponse

Example

get_tenants の例

Copy

import client
from client.api.default_api import GetTenantsOptions
from client.models.get_tenants_response import GetTenantsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って。
# 各認証方法の例が以下に提供されています。
# 使用ケースに合う例を使用してください。
# APIキー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定する場合は以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    meta = 'meta_example' # str |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_tenants(tenant_id, GetTenantsOptions(meta=meta, skip=skip))
        print("The response of DefaultApi->get_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenants: %s\n" % e)

update_tenant

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_tenant の例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.models.update_tenant_body import UpdateTenantBody
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、省略した場合のデフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例を以下に示します。利用する認証方法に合わせて該当する例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーにプレフィックス（例: Bearer）を設定する場合は以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_body = client.UpdateTenantBody() # UpdateTenantBody | 
    try:
        api_response = api_instance.update_tenant(tenant_id, id, update_tenant_body)
        print("The response of DefaultApi->update_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant: %s\n" % e)

change_ticket_state

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
userId	string	query	はい
id	string	path	はい

レスポンス

戻り値: ChangeTicketStateResponse

例

change_ticket_state の例

Copy

import client
from client.models.change_ticket_state_body import ChangeTicketStateBody
from client.models.change_ticket_state_response import ChangeTicketStateResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを
# APIサーバーのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例を以下に示します。あなたの認証ユースケースに合った例を使用してください。
# APIキー認証の設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    id = 'id_example' # str | 
    change_ticket_state_body = client.ChangeTicketStateBody() # ChangeTicketStateBody | 
    try:
        api_response = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
        print("The response of DefaultApi->change_ticket_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->change_ticket_state: %s\n" % e)

create_ticket

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
userId	string	query	はい

レスポンス

返却: CreateTicketResponse

例

create_ticket の例

Copy

import client
from client.models.create_ticket_body import CreateTicketBody
from client.models.create_ticket_response import CreateTicketResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って。
# 各認証方式の例を以下に示します。 
# 自分の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キー用のプレフィックス（例: Bearer）を設定するために以下の行のコメントアウトを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを用いたコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    create_ticket_body = client.CreateTicketBody() # CreateTicketBody | 
    try:
        api_response = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
        print("The response of DefaultApi->create_ticket:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_ticket: %s\n" % e)

get_ticket

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

戻り値: GetTicketResponse

例

get_ticket の例

Copy

import client
from client.models.get_ticket_response import GetTicketResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可のパラメータを設定する必要があります。
# 以下に各認証方式の例を示します。下の例から
# あなたの認証ユースケースに合うものを使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーにプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (オプション)
    try:
        api_response = api_instance.get_ticket(tenant_id, id, user_id=user_id)
        print("The response of DefaultApi->get_ticket:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ticket: %s\n" % e)

get_tickets

Parameters

名前	タイプ	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
state	number	query	いいえ
skip	number	query	いいえ
limit	number	query	いいえ

Response

返却: GetTicketsResponse

Example

get_tickets の例

Copy

import client
from client.api.default_api import GetTicketsOptions
from client.models.get_tickets_response import GetTicketsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照すると、サポートされているすべての構成パラメータの一覧が確認できます。
# クライアントは API サーバーのセキュリティポリシーに従って、認証と認可のパラメータを設定する必要があります。
# 各認証方法の例が以下に提供されています。ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定します: api_key
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    state = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    limit = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_tickets(tenant_id, GetTicketsOptions(user_id=user_id, state=state, skip=skip, limit=limit))
        print("The response of DefaultApi->get_tickets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tickets: %s\n" % e)

get_translations

パラメータ

名前	型	場所	必須
namespace	string	path	はい
component	string	path	はい
locale	string	query	いいえ
useFullTranslationIds	boolean	query	いいえ

レスポンス

返り値: GetTranslationsResponse

例

get_translations の例

Copy

import client
from client.api.public_api import GetTranslationsOptions
from client.models.get_translations_response import GetTranslationsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# 設定可能なすべての構成パラメータの一覧は configuration.py を参照してください
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    namespace = 'namespace_example' # str | 
    component = 'component_example' # str | 
    locale = 'locale_example' # str |  (optional)
    use_full_translation_ids = True # bool |  (optional)
    try:
        api_response = api_instance.get_translations(namespace, component, GetTranslationsOptions(locale=locale, use_full_translation_ids=use_full_translation_ids))
        print("The response of PublicApi->get_translations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_translations: %s\n" % e)

upload_image

Upload and resize an image

Parameters

名前	型	場所	必須	説明
tenantId	string	path	はい
sizePreset	string	query	いいえ	サイズプリセット: 「Default」(1000x1000px) または「CrossPlatform」(一般的なデバイス向けにサイズを作成)
urlId	string	query	いいえ	アップロードが行われるページの ID、設定用

Response

戻り値: UploadImageResponse

例

upload_image 例

Copy

import client
from client.api.public_api import UploadImageOptions
from client.models.size_preset import SizePreset
from client.models.upload_image_response import UploadImageResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py でサポートされているすべての設定パラメータの一覧を確認できます。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    file = None # bytes | 
    size_preset = client.SizePreset() # SizePreset | サイズプリセット: \"Default\" (1000x1000px) または \"CrossPlatform\" (一般的なデバイス向けにサイズを作成) (optional)
    url_id = 'url_id_example' # str | アップロードが行われるページの ID、設定用 (optional)
    try:
        api_response = api_instance.upload_image(tenant_id, file, UploadImageOptions(size_preset=size_preset, url_id=url_id))
        print("The response of PublicApi->upload_image:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->upload_image: %s\n" % e)

get_user_badge_progress_by_id

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIGetUserBadgeProgressResponse

例

get_user_badge_progress_by_id の例

Copy

import client
from client.models.api_get_user_badge_progress_response import APIGetUserBadgeProgressResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、既定値は https://fastcomments.com です
# サポートされているすべての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは、認証と認可のパラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 各認証方式の例を以下に示します。ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーのプレフィックス（例: Bearer）を設定するには下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスとともにコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_id(tenant_id, id)
        print("The response of DefaultApi->get_user_badge_progress_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_id: %s\n" % e)

get_user_badge_progress_by_user_id

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
userId	string	path	はい

レスポンス

戻り値: APIGetUserBadgeProgressResponse

例

get_user_badge_progress_by_user_id の例

Copy

import client
from client.models.api_get_user_badge_progress_response import APIGetUserBadgeProgressResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータについては configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを構成する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 以下に各認証方法の例を示します。ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要な場合は下の行のコメントアウトを外して API キーのプレフィックス（例: Bearer）を設定してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを伴うコンテキストを開きます
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
        print("The response of DefaultApi->get_user_badge_progress_by_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_user_id: %s\n" % e)

get_user_badge_progress_list

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
userId	string	query	No
limit	number	query	No
skip	number	query	No

レスポンス

戻り値: APIGetUserBadgeProgressListResponse

例

get_user_badge_progress_list の例

Copy

import client
from client.api.default_api import GetUserBadgeProgressListOptions
from client.models.api_get_user_badge_progress_list_response import APIGetUserBadgeProgressListResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを設定する必要があります
# APIサーバーのセキュリティポリシーに従って
# 各認証方式の例が以下に提供されています。
# ご自身の認証ユースケースに合う例を使用してください。
# APIキー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  （オプション）
    limit = 3.4 # float |  （オプション）
    skip = 3.4 # float |  （オプション）
    try:
        api_response = api_instance.get_user_badge_progress_list(tenant_id, GetUserBadgeProgressListOptions(user_id=user_id, limit=limit, skip=skip))
        print("The response of DefaultApi->get_user_badge_progress_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_list: %s\n" % e)

create_user_badge

パラメータ

名前	型	ロケーション	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: APICreateUserBadgeResponse

例

create_user_badge の例

Copy

import client
from client.models.api_create_user_badge_response import APICreateUserBadgeResponse
from client.models.create_user_badge_params import CreateUserBadgeParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証と認可のパラメータを
# API サーバーのセキュリティポリシーに従って設定する必要があります。
# 以下に各認証方法の例を示します。使用する例は
# あなたの認証ユースケースを満たすものを選んでください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_user_badge_params = client.CreateUserBadgeParams() # CreateUserBadgeParams | 
    try:
        api_response = api_instance.create_user_badge(tenant_id, create_user_badge_params)
        print("The response of DefaultApi->create_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_user_badge: %s\n" % e)

delete_user_badge

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptySuccessResponse

例

delete_user_badge の例

Copy

import client
from client.models.api_empty_success_response import APIEmptySuccessResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、省略するとデフォルトは https://fastcomments.com になります
# サポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従って設定してください。
# 各認証方法の例を以下に示します。
# ご自身の認証ユースケースに合った例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キーにプレフィックス（例: Bearer）を設定するには下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_user_badge(tenant_id, id)
        print("The response of DefaultApi->delete_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_user_badge: %s\n" % e)

get_user_badge

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIGetUserBadgeResponse

例

get_user_badge の例

Copy

import client
from client.models.api_get_user_badge_response import APIGetUserBadgeResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされている全ての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを構成する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。ご自身のユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーにプレフィックス（例: Bearer）を設定するには以下の行のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使ってコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge(tenant_id, id)
        print("The response of DefaultApi->get_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge: %s\n" % e)

get_user_badges

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
userId	string	query	No
badgeId	string	query	No
type	number	query	No
displayedOnComments	boolean	query	No
limit	number	query	No
skip	number	query	No

レスポンス

返却: APIGetUserBadgesResponse

例

get_user_badges の例

Copy

import client
from client.api.default_api import GetUserBadgesOptions
from client.models.api_get_user_badges_response import APIGetUserBadgesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# すべてのサポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを構成する必要があります
# API サーバーのセキュリティポリシーに従って
# 各認証方法の例が以下に提供されています。
# ご自身の認証ユースケースに合致する例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str |
    user_id = 'user_id_example' # str |  (オプション)
    badge_id = 'badge_id_example' # str |  (オプション)
    type = 3.4 # float |  (オプション)
    displayed_on_comments = True # bool |  (オプション)
    limit = 3.4 # float |  (オプション)
    skip = 3.4 # float |  (オプション)
    try:
        api_response = api_instance.get_user_badges(tenant_id, GetUserBadgesOptions(user_id=user_id, badge_id=badge_id, type=type, displayed_on_comments=displayed_on_comments, limit=limit, skip=skip))
        print("The response of DefaultApi->get_user_badges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badges: %s\n" % e)

update_user_badge

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptySuccessResponse

例

update_user_badge の例

Copy

import client
from client.models.api_empty_success_response import APIEmptySuccessResponse
from client.models.update_user_badge_params import UpdateUserBadgeParams
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 以下に各認証方式の例を示します。
# ご自身の認証ユースケースに合った例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーに対するプレフィックス（例: Bearer）を設定するには以下のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_user_badge_params = client.UpdateUserBadgeParams() # UpdateUserBadgeParams | 
    try:
        api_response = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
        print("The response of DefaultApi->update_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_user_badge: %s\n" % e)

get_user_notification_count

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: GetUserNotificationCountResponse

例

get_user_notification_count の例

Copy

import client
from client.models.get_user_notification_count_response import GetUserNotificationCountResponse
from client.rest import ApiException
from pprint import pprint
# ホストの指定は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使ってコンテキストに入る
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->get_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notification_count: %s\n" % e)

get_user_notifications

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
urlId	string	query	No	現在のページが購読されているかどうかを判定するために使用します。
pageSize	integer	query	No
afterId	string	query	No
includeContext	boolean	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
includeTranslations	boolean	query	No
includeTenantNotifications	boolean	query	No
sso	string	query	No

レスポンス

戻り値: GetMyNotificationsResponse

例

get_user_notifications の例

Copy

import client
from client.api.public_api import GetUserNotificationsOptions
from client.models.get_my_notifications_response import GetMyNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 現在のページが購読されているかどうかを判定するために使用します。(オプション)
    page_size = 56 # int |  (オプション)
    after_id = 'after_id_example' # str |  (オプション)
    include_context = True # bool |  (オプション)
    after_created_at = 56 # int |  (オプション)
    unread_only = True # bool |  (オプション)
    dm_only = True # bool |  (オプション)
    no_dm = True # bool |  (オプション)
    include_translations = True # bool |  (オプション)
    include_tenant_notifications = True # bool |  (オプション)
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.get_user_notifications(tenant_id, GetUserNotificationsOptions(url_id=url_id, page_size=page_size, after_id=after_id, include_context=include_context, after_created_at=after_created_at, unread_only=unread_only, dm_only=dm_only, no_dm=no_dm, include_translations=include_translations, include_tenant_notifications=include_tenant_notifications, sso=sso))
        print("The response of PublicApi->get_user_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notifications: %s\n" % e)

reset_user_notification_count

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返却値: ResetUserNotificationsResponse

例

reset_user_notification_count の例

Copy

import client
from client.models.reset_user_notifications_response import ResetUserNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、省略した場合のデフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  （オプション）
    try:
        api_response = api_instance.reset_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->reset_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->reset_user_notification_count: %s\n" % e)

reset_user_notifications

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
afterId	string	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
sso	string	query	No

応答

戻り値: ResetUserNotificationsResponse

Example

reset_user_notifications 例

Copy

import client
from client.api.public_api import ResetUserNotificationsOptions
from client.models.reset_user_notifications_response import ResetUserNotificationsResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成する
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (optional)
    after_created_at = 56 # int |  (optional)
    unread_only = True # bool |  (optional)
    dm_only = True # bool |  (optional)
    no_dm = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.reset_user_notifications(tenant_id, ResetUserNotificationsOptions(after_id=after_id, after_created_at=after_created_at, unread_only=unread_only, dm_only=dm_only, no_dm=no_dm, sso=soo))
        print("The response of PublicApi->reset_user_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->reset_user_notifications: %s\n" % e)

update_user_notification_comment_subscription_status

特定のコメントに対する通知を有効または無効にします。

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
notificationId	string	path	Yes
optedInOrOut	string	path	Yes
commentId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse

例

update_user_notification_comment_subscription_status の例

Copy

import client
from client.models.update_user_notification_comment_subscription_status_response import UpdateUserNotificationCommentSubscriptionStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされている全ての構成パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを用いてコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    opted_in_or_out = 'opted_in_or_out_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, sso=sso)
        print("The response of PublicApi->update_user_notification_comment_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_comment_subscription_status: %s\n" % e)

update_user_notification_page_subscription_status

ページの通知を有効または無効にします。ユーザーがページを購読していると、新しいルートコメントに対して通知が作成され、また

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
urlId	string	query	はい
url	string	query	はい
pageTitle	string	query	はい
subscribedOrUnsubscribed	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: UpdateUserNotificationPageSubscriptionStatusResponse

例

update_user_notification_page_subscription_status の例

Copy

import client
from client.models.update_user_notification_page_subscription_status_response import UpdateUserNotificationPageSubscriptionStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの指定は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスを使用してコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    url = 'url_example' # str | 
    page_title = 'page_title_example' # str | 
    subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example' # str | 
    sso = 'sso_example' # str |  (オプション)
    try:
        api_response = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, sso=sso)
        print("The response of PublicApi->update_user_notification_page_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_page_subscription_status: %s\n" % e)

update_user_notification_status

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
notificationId	string	path	はい
newStatus	string	path	はい
sso	string	query	いいえ

レスポンス

返却値: UpdateUserNotificationStatusResponse

例

update_user_notification_status の例

Copy

import client
from client.models.update_user_notification_status_response import UpdateUserNotificationStatusResponse
from client.rest import ApiException
from pprint import pprint
# ホストの指定は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスを使用してコンテキストを開始します
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    new_status = 'new_status_example' # str | 
    sso = 'sso_example' # str |  (任意)
    try:
        api_response = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, sso=sso)
        print("The response of PublicApi->update_user_notification_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_status: %s\n" % e)

get_user_presence_statuses

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
urlIdWS	string	query	はい
userIds	string	query	はい

レスポンス

戻り値: GetUserPresenceStatusesResponse

例

get_user_presence_statuses の例

Copy

import client
from client.models.get_user_presence_statuses_response import GetUserPresenceStatusesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# APIクライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # APIクラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id_ws = 'url_id_ws_example' # str | 
    user_ids = 'user_ids_example' # str | 
    try:
        api_response = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
        print("The response of PublicApi->get_user_presence_statuses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_presence_statuses: %s\n" % e)

search_users

パラメータ

名前	型	位置	必須
tenantId	string	path	Yes
urlId	string	query	Yes
usernameStartsWith	string	query	No
mentionGroupIds	array	query	No
sso	string	query	No
searchSection	string	query	No

レスポンス

Returns: SearchUsersResult

例

search_users の例

Copy

import client
from client.api.public_api import SearchUsersOptions
from client.models.search_users_result import SearchUsersResult
from client.rest import ApiException
from pprint import pprint
# ホストを定義することは任意で、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    username_starts_with = 'username_starts_with_example' # str |  (optional)
    mention_group_ids = ['mention_group_ids_example'] # List[str] |  (optional)
    sso = 'sso_example' # str |  (optional)
    search_section = 'search_section_example' # str |  (optional)
    try:
        api_response = api_instance.search_users(tenant_id, url_id, SearchUsersOptions(username_starts_with=username_starts_with, mention_group_ids=mention_group_ids, sso=sso, search_section=search_section))
        print("The response of PublicApi->search_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->search_users: %s\n" % e)

get_user

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: GetUserResponse

例

get_user の例

Copy

import client
from client.models.get_user_response import GetUserResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は省略可能で、デフォルトは https://fastcomments.com です
# サポートされている設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可パラメータを設定する必要があります
# API サーバーのセキュリティポリシーに従ってください。
# 以下に各認証方式の例を示します。
# ご自身の認証ユースケースに合う例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて以下のコメントアウトを外して、API キーのプレフィックス（例: Bearer）を設定します
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスを使用するコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user(tenant_id, id)
        print("The response of DefaultApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user: %s\n" % e)

create_vote

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	query	Yes
direction	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

応答

戻り値: VoteResponse

例

create_vote の例

Copy

import client
from client.api.default_api import CreateVoteOptions
from client.models.vote_response import VoteResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py を参照して、サポートされているすべての設定パラメータの一覧を確認してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは、API サーバーのセキュリティ ポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に提供されています。認証ユースケースに適合する例を使用してください。
# APIキー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、APIキーのプレフィックス（例: Bearer）を設定するには、以下のコメントを解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.create_vote(tenant_id, comment_id, direction, CreateVoteOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->create_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_vote: %s\n" % e)

delete_vote

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
editKey	string	query	いいえ

レスポンス

戻り値: VoteDeleteResponse

例

delete_vote の例

Copy

import client
from client.models.vote_delete_response import VoteDeleteResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは認証および認可のパラメータを設定する必要があります
# これらは API サーバのセキュリティポリシーに従ってください。
# 各認証方式の例を以下に示します。
# ご自身の認証ユースケースに合う例を使用してください。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーの接頭辞（例: Bearer）を設定するために以下の行のコメントを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    edit_key = 'edit_key_example' # str |  (オプション)
    try:
        api_response = api_instance.delete_vote(tenant_id, id, edit_key=edit_key)
        print("The response of DefaultApi->delete_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_vote: %s\n" % e)

get_votes

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
urlId	string	query	はい

レスポンス

戻り値: GetVotesResponse

例

get_votes の例

Copy

import client
from client.models.get_votes_response import GetVotesResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義は任意で、デフォルトは https://fastcomments.com です
# サポートされているすべての設定パラメータの一覧は configuration.py を参照してください。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 以下に各認証方式の例を示します。あなたのユースケースに合った例を使用してください。
# API キー認証を設定: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて API キー用のプレフィックス（例: Bearer）を設定するには下をコメント解除してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# API クライアントのインスタンスでコンテキストに入ります
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_votes(tenant_id, url_id)
        print("The response of DefaultApi->get_votes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_votes: %s\n" % e)

get_votes_for_user

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
urlId	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

レスポンス

戻り値: GetVotesForUserResponse

例

get_votes_for_user 例

Copy

import client
from client.api.default_api import GetVotesForUserOptions
from client.models.get_votes_for_user_response import GetVotesForUserResponse
from client.rest import ApiException
from pprint import pprint
# ホストの定義はオプションで、デフォルトは https://fastcomments.com です
# configuration.py にはサポートされているすべての構成パラメータの一覧があります。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# クライアントは API サーバーのセキュリティポリシーに従って認証および認可パラメータを設定する必要があります。
# 各認証方法の例が以下に示されていますので、使用ケースに合った例を使用してください。
# API キー認証を設定します: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 必要に応じて、API キーのプレフィックス（例: Bearer）を設定するには、以下のコメントアウトを外してください
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # API クラスのインスタンスを作成します
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.get_votes_for_user(tenant_id, url_id, GetVotesForUserOptions(user_id=user_id, anon_user_id=anon_user_id))
        print("The response of DefaultApi->get_votes_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_votes_for_user: %s\n" % e)

お困りですか？

Python SDK に関して問題が発生したり質問がある場合は、次をご利用ください：

貢献

貢献は歓迎します！貢献ガイドラインについてはGitHubリポジトリをご覧ください。

言語 🇯🇵 日本語

はじめに

ドキュメント

集計

監査ログ

認証

コメントでブロック

ブロックされたコメントの確認

コメント

ユーザーのコメント

ドメイン設定

メールテンプレート

イベントログ

フィード投稿

コメントのフラグ

GIF

ハッシュタグ

モデレーション

モデレーター

通知数

通知

ページリアクション

ページ

保留中のWebhookイベント

質問設定

質問結果

質問結果の集計

SSOユーザー

サブスクリプション

テナントの日次使用量

テナントパッケージ

テナントユーザー

テナント

チケット

翻訳

画像アップロード

ユーザーバッジ進捗

ユーザーバッジ

ユーザー通知

在席状況

ユーザー検索

ユーザー

投票

FastComments の Python SDK

リポジトリ

インストール

Install from GitHub

Library Contents

Public vs Secured APIs

クイックスタート

Using Authenticated APIs (DefaultApi)

Using Public APIs (PublicApi)

Using the Moderation Dashboard (ModerationApi)

Using SSO (Single Sign-On)

Common Issues

注意事項

ブロードキャストID

要件

aggregate

パラメータ

レスポンス

例

get_audit_logs

パラメータ

レスポンス

例

logout_public

レスポンス

例

block_from_comment_public

パラメータ

レスポンス

例

un_block_comment_public

パラメータ

レスポンス

例

checked_comments_for_blocked

パラメータ

レスポンス