FastComments 的 Python SDK

這是 FastComments 的官方 Python SDK。

FastComments API 的官方 Python SDK

儲存庫

安裝

從 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 也附有已編譯的 wheel，如果你想直接安裝二進位制套件，可使用它。

程式庫內容

此程式庫包含兩個模組：產生的 API 客戶端以及包含手寫工具函式的核心 Python 程式庫，讓使用 API 更加便利，並支援 SSO。

公開與保護 API

對於 API 客戶端，有三個類別，DefaultApi、PublicApi 與 ModerationApi。DefaultApi 包含需要 API 金鑰的方法，PublicApi 包含可直接從瀏覽器／行動裝置等無需驗證即可呼叫的方法。ModerationApi 提供完整且快速的即時審查 API 套件。每個 ModerationApi 方法都接受 sso 參數，並可透過 SSO 或 FastComments.com 的會話 cookie 進行驗證。

快速開始

使用已驗證的 API (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

使用公共 API (PublicApi)

公共端點不需要驗證：

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}")

使用審核儀表板 (ModerationApi)

ModerationApi 為審核員儀表板提供功能。方法透過傳遞 sso 令牌以審核員的身份呼叫：

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}")

使用 SSO（單一登入）

SDK 包含用於產生安全 SSO 令牌的工具：

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}")

簡易 SSO（較不安全，僅供測試）：

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()

常見問題

401 "missing-api-key" 錯誤：在建立 DefaultApi 實例之前，請確保已設定 config.api_key = {"api_key": "YOUR_KEY"}。
錯誤的 API 類別：對於伺服器端已驗證的請求使用 DefaultApi，對於客戶端/公共請求使用 PublicApi，對於審核員儀表板請求使用 ModerationApi。
匯入錯誤：請確保從正確的模組匯入：
- API 客戶端：from client import ...
- SSO 工具：from sso import ...

注意事項

廣播 ID

您會看到在某些 API 呼叫中需要傳入 broadcast_id。當您接收到事件時，會收到這個 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"

彙總

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

參數

名稱	類型	位置	必填
tenantId	string	query	是
parentTenantId	string	query	否
includeStats	boolean	query	否

回應

返回：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 以取得所有支援的設定參數清單。
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 客戶端實例進入 context
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)

取得稽核日誌

參數

名稱	類型	位置	必填
tenantId	string	query	是
limit	number	query	否
skip	number	query	否
order	string	query	否
after	number	query	否
before	number	query	否

回應

返回：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 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客戶端必須依照 API 伺服器的安全政策設定驗證與授權參數
# 每種驗證方法的範例如下，請使用符合您驗證需求的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，請取消註解以下程式碼以設定 API 金鑰的前綴（例如 Bearer） for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 以 API 客戶端實例進入 context
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    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)

登出（公開）

回應

回傳: 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)

從留言封鎖（公開）

參數

名稱	型別	位置	必填
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
# 指定 host 為可選，預設為 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)

取消封鎖留言（公開）

參數

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
# Defining the host is optional and defaults to https://fastcomments.com
# 定義 host 為選用，預設為 https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
# 使用 API client 的實例進入一個上下文
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    # 建立 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)

檢查被封鎖的留言

參數

名稱	類型	位置	必填	描述
tenantId	string	query	是
commentIds	string	query	是	以逗號分隔的 comment ids 列表。
sso	string	query	否

回應

回傳: 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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 ApiClient 的實例進入上下文
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 | 以逗號分隔的 comment ids 列表。
    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)

從留言封鎖使用者

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

回應

回傳: 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 以取得所有支援的設定參數清單。
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 | 
    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)

建立留言（公開）

參數

名稱	型別	位置	必填
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 |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

刪除留言

參數

名稱	類型	位置	必填
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） 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 | 
    context_user_id = 'context_user_id_example' # str |  （可選）
    is_live = True # bool |  （可選）
    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)

刪除留言（公開）

參數

名稱	類型	位置	必填
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

回應

返回：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)

刪除留言投票

參數

名稱	類型	位置	必需
tenantId	string	path	是
commentId	string	path	是
voteId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

回應

返回：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"
)
# 使用 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 | 
    vote_id = 'vote_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

檢舉留言

參數

名稱	類型	位置	必填
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
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如需設定前綴（例如 Bearer）給 API 金鑰，請取消註解以下行
# 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.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)

取得留言

參數

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

回應

回傳: APIGetCommentResponse

範例

get_comment 範例

Copy

import client
from client.models.api_get_comment_response import APIGetCommentResponse
from client.rest import ApiException
from pprint import pprint
# 定義 host 是可選的，預設為 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 | 
    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)

取得留言內容

參數

名稱	類型	位置	必填
tenantId	string	path	Yes
commentId	string	path	Yes
editKey	string	query	No
sso	string	query	No

回應

返回：PublicAPIGetCommentTextResponse

範例

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
# 定義 host 為可選項，預設值為 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)

取得留言投票使用者名稱

參數

名稱	類型	位置	必填
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
# 設定 host 為選用，預設為 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)

取得留言列表

參數

名稱	類型	位置	必填
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 以取得所有支援的設定參數列表。
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 | 
    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)

取得留言（公開）

請求 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	否

回應

返回: 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 |  (可選)
    direction = client.SortDirections() # SortDirections |  (可選)
    sso = 'sso_example' # str |  (可選)
    skip = 56 # int |  (可選)
    skip_children = 56 # int |  (可選)
    limit = 56 # int |  (可選)
    limit_children = 56 # int |  (可選)
    count_children = True # bool |  (可選)
    fetch_page_for_comment_id = 'fetch_page_for_comment_id_example' # str |  (可選)
    include_config = True # bool |  (可選)
    count_all = True # bool |  (可選)
    includei10n = True # bool |  (可選)
    locale = 'locale_example' # str |  (可選)
    modules = 'modules_example' # str |  (可選)
    is_crawler = True # bool |  (可選)
    include_notification_count = True # bool |  (可選)
    as_tree = True # bool |  (可選)
    max_tree_depth = 56 # int |  (可選)
    use_full_translation_ids = True # bool |  (可選)
    parent_id = 'parent_id_example' # str |  (可選)
    search_text = 'search_text_example' # str |  (可選)
    hash_tags = ['hash_tags_example'] # List[str] |  (可選)
    user_id = 'user_id_example' # str |  (可選)
    custom_config_str = 'custom_config_str_example' # str |  (可選)
    after_comment_id = 'after_comment_id_example' # str |  (可選)
    before_comment_id = 'before_comment_id_example' # str |  (可選)
    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)

鎖定留言

參數

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

回應

回傳: APIEmptyResponse

範例

lock_comment 範例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 ApiClient 的實例進入一個上下文
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)

置頂留言

參數

名稱	類型	位置	必填
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

回應

回傳：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
# 定義 host 為選用，預設值為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 ApiClient 的實例進入一個上下文
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)

儲存留言

參數

名稱	類型	位置	必填
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 以取得所有支援的設定參數清單。
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 客戶端實例進入 context
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() # 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)

批次儲存留言

Parameters

名稱	類型	位置	必填
tenantId	string	query	是
isLive	boolean	query	否
doSpamCheck	boolean	query	否
sendEmails	boolean	query	否
populateNotifications	boolean	query	否

Response

返回：SaveCommentsBulkResponse

Example

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 以取得所有支援的設定參數列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客戶端必須依照 API 伺服器的安全策略設定驗證與授權參數
# 以下提供每種驗證方式的範例，請使用符合您驗證需求的範例。
# 設定 API Key 授權: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消註解以下行以設定 API Key 的前綴（例如 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_comment_params = [client.CreateCommentParams()] # List[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_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)

設定留言內容

參數

名稱	類型	位置	必填
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

回傳

返回: 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 |  (optional)
    sso = 'sso_example' # str |  (optional)
    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("PublicApi->set_comment_text 的回應:\n")
        pprint(api_response)
    except Exception as e:
        print("呼叫 PublicApi->set_comment_text 時發生例外: %s\n" % e)

解除對留言的使用者封鎖

參數

名稱	類型	位置	必填
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 以了解所有支援的設定參數列表。
# 客戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 以下提供每種驗證方法的範例，使用符合您驗證需求的範例。
# 滿足您的驗證使用情境。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如需設定前綴（例如 Bearer）給 API 金鑰，請取消註解以下程式碼
# 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)

取消檢舉留言

參數

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

回應

返回: 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
# 定義 host 為可選，預設為 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 | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  （可選）
    anon_user_id = 'anon_user_id_example' # str |  （可選）
    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)

解鎖留言

參數

名稱	類型	位置	必填
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
# 指定 host 是可選的，預設值為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 ApiClient 實例建立上下文
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)

取消置頂留言

參數

Name	Type	Location	Required
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
# 定義 host 是可選的，預設為 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)

更新留言

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
doSpamCheck	boolean	query	No
isLive	boolean	query	No

回應

返回：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 以取得所有支援的設定參數清單。
# 客戶端必須依照 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 | 
    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)

對留言投票

參數

名稱	類型	位置	必填
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)

取得使用者的留言

參數

名稱	類型	位置	必填
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"
)
# 進入含有 API 客戶端實例的上下文
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)

新增網域設定

參數

名稱	類型	位置	必填	說明
tenantId	string	query	是

回應

回傳: 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
# 定義 host 是可選的，預設為 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 client 的實例上下文中
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)

刪除網域設定

參數

Name	Type	Location	Required	Description
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
# 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.
# 下方提供每種驗證方法的範例，
# 使用符合您驗證情境的範例。
# 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.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)

取得網域設定

參數

名稱	型別	位置	必填	說明
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
# 定義 host 是可選的，預設為 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 = '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)

取得網域設定列表

參數

名稱	類型	位置	必填	說明
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
# 定義 host 是可選的，預設為 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 key 設定前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API client 實例進入一個上下文
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)

部分更新網域設定

參數

名稱	類型	位置	必填	說明
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
# 設定 host 為選項，預設為 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'
# 使用 ApiClient 的實例建立一個上下文
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)

取代網域設定

參數

名稱	類型	位置	必需	說明
tenantId	string	query	是
domainToUpdate	string	path	是

回應

回傳: 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
# 定義 host 是可選的，預設為 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'
# 使用 ApiClient 實例進入一個上下文
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)

建立電子郵件範本

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回應

回傳: 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
# 請參閱 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_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)

刪除電子郵件範本

參數

名稱	類型	位置	必填	說明
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
# 定義主機為可選，預設為 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_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)

刪除電子郵件範本渲染錯誤

參數

名稱	類型	位置	必填
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
# 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 | 
    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)

取得電子郵件範本

參數

名稱	Type	Location	必填	說明
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
# 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.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)

取得電子郵件範本定義

參數

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
# 定義 host 為選用，預設為 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
# 如有需要，取消註解下列內容以設定 API 金鑰的前綴（例如 Bearer）
# Enter a context with an instance of the API client
# 使用 API client 實例進入一個上下文
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    # 建立 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)

取得電子郵件範本渲染錯誤

參數

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
skip	number	query	否

回傳

Returns: 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
# Defining the host is optional and defaults to https://fastcomments.com
# 有關全部支援的設定參數列表，請見 configuration.py。
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.
# 用戶端必須根據 API 伺服器的安全政策設定驗證與授權參數。
# 下方提供了每種授權方法的範例，請使用符合您授權情境的範例。
# Configure API key authorization: api_key
# 設定 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
# 若需要，取消註解下方以為 API 金鑰設定前綴（例如 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 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    skip = 3.4 # float |  (可選)
    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)

取得電子郵件範本列表

參數

名稱	類型	位置	必填	說明
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
# 設定 host 是選用的，預設為 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)

渲染電子郵件範本

參數

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
# 定義 host 是可選的，預設為 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'
# 以 ApiClient 實例進入一個上下文
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)

更新電子郵件範本

參數

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

回應

回傳: 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
# 設定 host 為選用，預設為 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 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 | 
    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)

取得事件記錄

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_event_log 範例

Copy

import client
from client.models.get_event_log_response import GetEventLogResponse
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"
)
# 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.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_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)

取得全域事件記錄

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
# 定義 host 是可選的，預設為 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)

建立動態貼文

參數

名稱	型別	位置	必填
tenantId	string	query	是
broadcastId	string	query	否
isLive	boolean	query	否
doSpamCheck	boolean	query	否
skipDupCheck	boolean	query	否

回應

返回：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("DefaultApi->create_feed_post 的回應結果：\n")
        pprint(api_response)
    except Exception as e:
        print("呼叫 DefaultApi->create_feed_post 時發生例外情況：%s\n" % e)

建立動態貼文（公開）

參數

名稱	資料型別	位置	必填
tenantId	string	path	是
broadcastId	string	query	否
sso	string	query	否

回應

回傳：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)

刪除動態貼文（公開）

Parameters

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

Response

Returns: DeleteFeedPostPublicResponse

Example

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 |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

取得動態貼文

req tenantId afterId

參數

Name	Type	Location	Required
tenantId	string	query	Yes
afterId	string	query	No
limit	integer	query	No
tags	array	query	No

回應

返回: 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
# 定義 host 為可選，預設為 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:
    # Create an instance of the API class
    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)

取得動態貼文（公開）

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 |  (可選)
    limit = 56 # int |  (可選)
    tags = ['tags_example'] # List[str] |  (可選)
    sso = 'sso_example' # str |  (可選)
    is_crawler = True # bool |  (可選)
    include_user_info = True # bool |  (可選)
    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("PublicApi->get_feed_posts_public 的回應:\n")
        pprint(api_response)
    except Exception as e:
        print("呼叫 PublicApi->get_feed_posts_public 時發生例外: %s\n" % e)

取得動態貼文統計

參數

Name	Type	Location	Required
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
# 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"
)
# 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.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] | 
    sso = 'sso_example' # str |  (可選)
    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)

取得使用者回應（公開）

參數

名稱	類型	位置	必填
tenantId	string	path	Yes
postIds	array	query	No
sso	string	query	No

回應

返回: UserReactsResponse

範例

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
# 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"
)
# 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.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("The response of PublicApi->get_user_reacts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_reacts_public: %s\n" % e)

回應動態貼文（公開）

參數

名稱	類型	位置	必填
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)

更新動態貼文

參數

名稱	類型	位置	必填	說明
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
# 定義 host 是可選的，預設為 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 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 | 
    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)

更新動態貼文（公開）

參數

名稱	型別	位置	必填
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

回應

返回: CreateFeedPostResponse

範例

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 |  (可選)
    sso = 'sso_example' # str |  (可選)
    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("The response of PublicApi->update_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_feed_post_public: %s\n" % e)

檢舉留言（公開）

參數

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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 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 | 
    is_flagged = True # bool | 
    sso = 'sso_example' # str |  (選填)
    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)

取得大型 GIF

參數

Name	Type	Location	Required	Description
tenantId	string	path	是
largeInternalURLSanitized	string	query	是

回應

回傳: 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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以查看所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 以 API client 的實例建立一個上下文
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)

搜尋 GIF

參數

名稱	類型	位置	必填
tenantId	string	path	是
search	string	query	是
locale	string	query	否
rating	string	query	否
page	number	query	否

回應

返回：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:
    # 建立 API 類別的實例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    search = 'search_example' # str | 
    locale = 'locale_example' # str |  (可選)
    rating = 'rating_example' # str |  (可選)
    page = 3.4 # float |  (可選)
    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 |  (可選)
    rating = 'rating_example' # str |  (可選)
    page = 3.4 # float |  (可選)
    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)

新增標籤

參數

名稱	類型	位置	必填	說明
tenantId	string	query	是

回應

返回：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，以獲得所有支援的設定參數清單。
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_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)

批次新增標籤

參數

名稱	類型	位置	必填	描述
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 伺服器的安全政策。
# 以下提供每種驗證方法的範例，請使用
# 符合您驗證使用情況的範例。
# 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 | 
    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)

刪除標籤

參數

名稱	類型	位置	必填	說明
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:
    # 建立 API 類別的實例
    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)

取得標籤

參數

Name	Type	Location	Required	Description
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
# 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 | 
    page = 3.4 # float |  (optional)
    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)

部分更新標籤

參數

名稱	類型	位置	必填	描述
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 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客戶端必須依照 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 | 
    tag = 'tag_example' # str | 
    update_hash_tag_body = client.UpdateHashTagBody() # UpdateHashTagBody |  (可選)
    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)

刪除審核投票

參數

名稱	類型	位置	必填
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 |  （可選）
    sso = 'sso_example' # str |  （可選）
    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)

取得 API 留言

參數

名稱	類型	位置	必填
tenantId	string	query	是
page	number	query	否
count	number	query	否
text-search	string	query	否
byIPFromComment	string	query	否
filters	string	query	否
searchFilters	string	query	否
sorts	string	query	否
demo	boolean	query	否
sso	string	query	否

回應

返回：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 |  (optional)
    count = 3.4 # float |  (optional)
    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)
    sorts = 'sorts_example' # str |  (optional)
    demo = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

取得 API 匯出狀態

參數

Name	Type	Location	Required
tenantId	string	query	是
batchJobId	string	query	否
sso	string	query	否

回應

返回：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 |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

取得 API ID

參數

名稱	類型	位置	必填
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

回應

Returns: ModerationAPIGetCommentIdsResponse

範例

取得 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 |  （可選）
    by_ip_from_comment = 'by_ip_from_comment_example' # str |  （可選）
    filters = 'filters_example' # str |  （可選）
    search_filters = 'search_filters_example' # str |  （可選）
    after_id = 'after_id_example' # str |  （可選）
    demo = True # bool |  （可選）
    sso = 'sso_example' # str |  （可選）
    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)

取得被封鎖的留言使用者

參數

名稱	類型	位置	必填
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

回應

回傳: 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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參考 configuration.py 取得所有支援的設定參數列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 以 API 客戶端實例建立一個 context
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_ban_users_from_comment(tenant_id, comment_id, sso=sso)
        print("ModerationApi->get_ban_users_from_comment 的回應:\n")
        pprint(api_response)
    except Exception as e:
        print("呼叫 ModerationApi->get_ban_users_from_comment 時發生例外: %s\n" % e)

取得留言封鎖狀態

參數

名稱	類型	位置	必填
tenantId	string	query	是
commentId	string	path	是
sso	string	query	否

回應

返回：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)

取得留言回覆

參數

名稱	類型	位置	必要
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)

取得計數

參數

名稱	類型	位置	必填
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

回應

Returns: 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)

取得多項計數

參數

名稱	類型	位置	必填	描述
tenantId	string	query	Yes
sso	string	query	No

回應

回傳: 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
# 定義 host 為可選，預設為 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)

取得日誌

參數

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

回應

返回：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 客戶端實例建立 context
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)

取得手動徽章

參數

名稱	類型	位置	必填	描述
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"
)
# 使用 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_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)

取得使用者的手動徽章

參數

名稱	類型	位置	必填
tenantId	string	query	是
badgesUserId	string	query	否
commentId	string	query	否
sso	string	query	否

回應

返回：GetUserManualBadgesResponse

範例

取得使用者手動徽章範例

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 |  (optional)
    comment_id = 'comment_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

取得審核留言

參數

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

回應

返回：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)

取得審核留言內容

Parameters

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

Response

回傳：GetCommentTextResponse

Example

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
# 定義 host 是可選的，預設為 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 | 
    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)

取得預封鎖摘要

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

回應

返回: 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"
)
# 以 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_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)

取得搜尋留言摘要

參數

名稱	類型	位置	必填
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 |  (可選)
    filters = 'filters_example' # str |  (可選)
    search_filters = 'search_filters_example' # str |  (可選)
    sso = 'sso_example' # str |  (可選)
    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)

取得搜尋頁面

參數

名稱	類型	位置	必要
tenantId	string	query	是
value	string	query	否
sso	string	query	否

回應

返回：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)

取得搜尋網站

參數

名稱	類型	位置	必填
tenantId	string	query	是
value	string	query	否
sso	string	query	否

回應

回傳：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)
    sso = 'sso_example' # str |  (optional)
    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)

取得搜尋建議

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

Response

Returns: ModerationSuggestResponse

Example

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:
    # 建立 API 類別的實例
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    text_search = 'text_search_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

取得搜尋使用者

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

回應

Returns: 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"
)
# 進入包含 API 客戶端實例的上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.ModerationApi(api_client)
    tenant_id = 'tenant_id_example' # 字串 | 
    value = 'value_example' # 字串 |  （可選）
    sso = 'sso_example' # 字串 |  （可選）
    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)

取得信任因子

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

回應

返回：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 |  （可選）
    sso = 'sso_example' # str |  （可選）
    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)

取得使用者封鎖偏好

參數

名稱	類型	位置	必填	說明
tenantId	string	query	是
sso	string	query	否

回應

返回: APIModerateGetUserBanPreferencesResponse

範例

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
# 定義 host 為可選，預設為 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 |  （可選）
    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)

取得使用者內部資料

參數

名稱	類型	位置	必填
tenantId	string	query	是
commentId	string	query	否
sso	string	query	否

回應

返回：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 |  （可選）
    sso = 'sso_example' # str |  （可選）
    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)

調整留言投票

參數

名稱	類型	位置	必填
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 |  (可選)
    sso = 'sso_example' # str |  (可選)
    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)

觸發 API 匯出

參數

名稱	類型	位置	必填
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)

封鎖使用者（留言）

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

回應

返回：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)

還原封鎖使用者

參數

名稱	類型	位置	必填	描述
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 |  （可選）
    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)

批次預封鎖摘要

參數

名稱	類型	位置	必填
tenantId	string	query	是
includeByUserIdAndEmail	boolean	query	否
includeByIP	boolean	query	否
includeByEmailDomain	boolean	query	否
sso	string	query	否

回應

返回：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
# 定義 host 為可選，預設為 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)

以 ID 批次取得留言

參數

名稱	類型	位置	必要	說明
tenantId	string	query	Yes
sso	string	query	No

回應

返回：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)

送出檢舉留言

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

回應

Returns: 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)

移除留言

參數

名稱	類型	位置	必填
tenantId	string	query	是
commentId	string	path	是
broadcastId	string	query	否
sso	string	query	否

回應

返回: 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
# 定義 host 為可選項，預設為 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_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)

還原已刪除留言

參數

名稱	類型	位置	必填
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"
)
# 進入一個包含 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_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)

設定留言審核狀態

參數

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

回應

返回: 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"
)
# 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 | 
    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)

設定留言檢視狀態

參數

名稱	類型	位置	必填
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 |  (選用)
    broadcast_id = 'broadcast_id_example' # str |  (選用)
    sso = 'sso_example' # str |  (選用)
    try:
        api_response = api_instance.post_set_comment_review_status(tenant_id, comment_id, PostSetCommentReviewStatusOptions(reviewed=reviewed, broadcast_id=broadcast_id, sso=sso))
        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)

設定留言垃圾郵件狀態

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

回應

返回：APIEmptyResponse

範例

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"
)
# 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 | 
    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)

設定留言文字

參數

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

回應

Returns: 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)

送出取消檢舉

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

回應

返回：APIEmptyResponse

範例

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
# 定義 host 是可選的，預設為 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)

發送投票

參數

Name	Type	Location	Required
tenantId	string	query	是
commentId	string	path	是
direction	string	query	否
broadcastId	string	query	否
sso	string	query	否

回應

Returns: 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
# 定義 host 為可選，預設為 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 | 
    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("The response of ModerationApi->post_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModerationApi->post_vote: %s\n" % e)

授予徽章

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

回應

返回: 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)

關閉討論串

Parameters

名稱	類型	位置	必填
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

Response

返回：APIEmptyResponse

Example

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 |  (optional)
    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)

移除徽章

參數

名稱	類型	位置	必填
tenantId	string	query	是
badgeId	string	query	是
userId	string	query	否
commentId	string	query	否
broadcastId	string	query	否
sso	string	query	否

回應

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)

重新開啟討論串

參數

名稱	類型	位置	必填
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"
)
# 以 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 |  (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)

設置信任因子

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

回應

Returns: 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)

建立管理員

參數

名稱	類型	位置	必填	描述
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 伺服器的安全性政策。
# 下方提供每種驗證方法的範例，
# 請使用符合您驗證情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下面註解以設定 API key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API client 的實例進入上下文
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)

刪除管理員

參數

Name	Type	Location	Required
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
# 定義 host 是選用的，預設為 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 | 
    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)

取得管理員

參數

Name	Type	Location	Required	Description
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 伺服器的安全政策。
# 以下在下方提供每種驗證方法的範例，請使用能
# 滿足您驗證使用情境的範例。
# 設定 API 金鑰授權: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如需，請取消註解下方以設定 API 金鑰的前綴（例如 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 | 
    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)

取得管理員列表

參數

Name	Type	Location	Required	Description
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
# 定義 host 為可選，預設為 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 client 實例進入一個上下文
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_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)

發送邀請

參數

名稱	型別	位置	必填
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
# 定義 host 為選用，預設為 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 key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 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 | 
    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)

更新管理員

參數

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
# 設定 host 是可選的，預設為 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'
# 使用 ApiClient 實例進入一個上下文
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)

刪除通知計數

參數

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

回應

回傳: APIEmptyResponse

範例

delete_notification_count 範例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# 定義 host 是可選的，預設為 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)

取得快取通知計數

參數

名稱	類型	位置	必填	描述
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
# 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.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)

取得通知

Parameters

名稱	類型	位置	必填
tenantId	string	query	是
userId	string	query	否
urlId	string	query	否
fromCommentId	string	query	否
viewed	boolean	query	否
type	string	query	否
skip	number	query	否

Response

返回：GetNotificationsResponse

Example

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 伺服器的安全政策。
# 為每種驗證方法提供以下範例，使用符合您驗證使用情境的範例
# 滿足您的驗證需求。
# Configure API key authorization: api_key
# 如有需要，取消註解以下行以設定 API 金鑰的前綴（例如 Bearer）
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
configuration.api_key['api_key'] = os.environ["API_KEY"]
# configuration.api_key_prefix['api_key'] = 'Bearer'
with client.ApiClient(configuration) as api_client:
    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)

更新通知

參數

Name	Type	Location	Required
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
# 定義 host 為選用，預設為 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 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 | 
    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)

建立 v1 頁面回應

參數

Name	Type	Location	Required
tenantId	string	path	Yes
urlId	string	query	Yes
title	string	query	No

回應

回傳: 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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 以 ApiClient 的實例進入一個上下文
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 |  (optional)
    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)

建立 v2 頁面回應

參數

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
# 定義 host 是可選的，預設為 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 |  (可選)
    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)

刪除 v1 頁面回應

參數

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

回應

回傳: 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
# 定義 host 為可選項，預設值為 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)

刪除 v2 頁面回應

參數

名稱	類型	位置	必填
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
# 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"
)
# 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.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)

取得 v1 頁面按讚

參數

名稱	類型	位置	必填	說明
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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以查看所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 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 | 
    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)

取得 v2 頁面回應使用者

參數

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

回應

回傳: 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
# 定義 host 為選用，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有受支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 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 | 
    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)

取得 v2 頁面回應

參數

名稱	類型	位置	必填	說明
tenantId	string	路徑	是
urlId	string	查詢	是

回應

回傳：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
# 設定 host 為選填，預設為 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)

新增頁面

參數

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
# 指定 host 為選用，預設為 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 client 的實例進入一個上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    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)

刪除頁面

參數

Name	Type	Location	Required	Description
tenantId	string	查詢	Yes
id	string	路徑	Yes

回應

回傳: DeletePageAPIResponse

範例

delete_page 範例

Copy

import client
from client.models.delete_page_api_response import DeletePageAPIResponse
from client.rest import ApiException
from pprint import pprint
# 定義 host 為選用，預設為 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'
# 使用 ApiClient 實例進入一個上下文
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)

取得離線使用者

Past commenters on the page who are NOT currently online. Sorted by displayName.
使用此端點於已耗盡 /users/online 後，渲染「Members」區段。
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
在 commenterName 上使用游標分頁：伺服器從 afterName 起，透過 $gt 前進走訪部分 {tenantId, urlId, commenterName} 索引，無需 $skip 成本。

Parameters

名稱	類型	位置	必填	說明
tenantId	string	path	是
urlId	string	query	是	頁面 URL 識別碼（在伺服器端已清理）。
afterName	string	query	否	游標：從前一次回應傳遞 nextAfterName。
afterUserId	string	query	否	游標平手解決：從前一次回應傳遞 nextAfterUserId。當 afterName 被設定時，為必填，以避免名稱相同的項目被遺漏。

Response

返回：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"
)
# 以 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。（可選）
    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)

取得上線使用者

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

名稱	類型	位置	必填	說明
tenantId	string	path	Yes
urlId	string	query	Yes	頁面 URL 識別碼（在伺服器端已清理）。
afterName	string	query	No	游標：傳入先前回應中的 nextAfterName。
afterUserId	string	query	No	游標平衡鍵：傳入先前回應中的 nextAfterUserId。當設定 afterName 時為必填，以避免名稱相同的項目被遺漏。

Response

回傳：PageUsersOnlineResponse

範例

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
# 定義 host 為可選，預設為 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。（可選）
    after_user_id = 'after_user_id_example' # str | 游標平衡鍵：傳入先前回應中的 nextAfterUserId。當設定 afterName 時為必填，以避免名稱相同的項目被遺漏。（可選）
    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)

以 URL ID 取得頁面

參數

名稱	類型	位置	必填	說明
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
# 定義 host 是可選的，預設為 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 key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 ApiClient 實例進入一個上下文
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)

取得頁面列表

參數

名稱	型別	位置	必填	說明
tenantId	string	query	是

回應

回傳：GetPagesAPIResponse

範例

get_pages 範例

Copy

import client
from client.models.get_pages_api_response import GetPagesAPIResponse
from client.rest import ApiException
from pprint import pprint
# 定義 host 為選擇性，預設為 https://fastcomments.com
# 查看 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定認證與授權參數
# 以符合 API 伺服器的安全政策。
# 下方提供每種認證方法的範例，請選擇
# 符合您使用情境的範例。
# 設定 API key 授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，取消註解下方以設定 API key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 ApiClient 實例進入上下文
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)

取得頁面（公開）

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parameters

名稱	類型	位置	必填	說明
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，僅返回至少有一則評論的頁面。

Response

Returns: GetPublicPagesResponse

Example

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` 相關聯。 (optional)
    limit = 56 # int | 1..200，預設 50 (optional)
    q = 'q_example' # str | 可選的大小寫不敏感標題前綴過濾。 (optional)
    sort_by = client.PagesSortBy() # PagesSortBy | 排序方式。`updatedAt`（預設，最新的在前），`commentCount`（評論最多的在前），或 `title`（字母順序）。 (optional)
    has_comments = True # bool | 若為 true，僅返回至少有一則評論的頁面。 (optional)
    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)

取得使用者資訊

租戶的批量使用者資訊。給定 userIds，回傳來自 User / SSOUser 的顯示資訊。此功能供評論小工具使用，以補足剛透過 presence 事件出現的使用者資訊。無頁面上下文：隱私會一致地套用（私人個人檔案會被遮蔽）。

參數

名稱	Type	Location	必填	說明
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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API client 的實例建立一個上下文
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)

部分更新頁面

參數

名稱	類型	位置	必填	說明
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 伺服器的安全性政策。
# 下方提供每種驗證方法的範例，請使用
# 符合您驗證使用情境的範例。
# 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 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 | 
    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)

刪除待處理的 webhook 事件

參數

名稱	類型	位置	必填	說明
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
# 定義 host 是可選的，預設為 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)

取得待處理 webhook 事件計數

參數

名稱	類型	位置	必填
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
# 定義 host 為可選項，預設為 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 |  (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)
    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)

取得待處理 webhook 事件

參數

名稱	類型	位置	必填
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

回應

返回：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 以取得所有支援的設定參數清單。
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 |  (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)

建立問卷設定

參數

名稱	類型	位置	必填	說明
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
# 定義 host 是選用的，預設為 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 key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 在具有 API client 實例的上下文中使用
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)

刪除問卷設定

參數

名稱	類型	位置	必填	說明
tenantId	string	query	是
id	string	path	是

回應

回傳: APIEmptyResponse

範例

delete_question_config 範例

Copy

import client
from client.models.api_empty_response import APIEmptyResponse
from client.rest import ApiException
from pprint import pprint
# 定義 host 是可選的，預設為 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 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 | 
    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)

取得問卷設定

參數

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

回應

回傳: 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
# 定義 host 為選用，預設為 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_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)

取得問卷設定列表

參數

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
# 指定 host 為選用，預設為 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'
# 使用 ApiClient 的執行個體進入上下文
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)

更新問卷設定

參數

Name	Type	Location	Required	Description
tenantId	string	查詢	是
id	string	路徑	是

回應

回傳: 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
# 定義 host 為可選，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須根據 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 | 
    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)

建立問卷結果

參數

Name	Type	Location	Required	Description
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
# 定義 host 為選用，預設為 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 client 的實例進入一個上下文
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)

刪除問卷結果

參數

名稱	類型	位置	必填	說明
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
# 設定 host 為選用，預設為 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_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)

取得問卷結果

參數

名稱	類型	位置	必填	說明
tenantId	string	query	Yes
id	string	path	Yes

回應

回傳: 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
# 定義 host 是可選的，預設為 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_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)

取得問卷結果列表

參數

名稱	類型	位置	必填
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

回應

回傳：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
# 定義 host 為可選，預設為 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 |  (optional)
    user_id = 'user_id_example' # str |  (optional)
    start_date = 'start_date_example' # str |  (optional)
    question_id = 'question_id_example' # str |  (optional)
    question_ids = 'question_ids_example' # str |  (optional)
    skip = 3.4 # float |  (optional)
    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)

更新問卷結果

參數

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

回傳

回傳: 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'
# 使用 ApiClient 實例進入一個上下文
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)

彙總問卷結果

參數

名稱	型別	位置	必填
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

回應

返回：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 以取得所有支援的設定參數列表。
# 客戶端必須根據 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 | 
    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)

批次彙總問卷結果

參數

Name	Type	Location	Required	Description
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 伺服器的安全政策。
# 下方提供每種驗證方法的範例，
# 請使用符合您驗證情境的範例。
# 設定 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_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)

結合留言與問卷結果

參數

名稱	類型	位置	必填
tenantId	string	query	是
questionId	string	query	否
questionIds	array	query	否
urlId	string	query	否
startDate	string	query	否
forceRecalculate	boolean	query	否
minValue	number	query	否
maxValue	number	query	否
limit	number	query	否

回應

返回：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 以取得所有支援的設定參數列表。
# 客戶端必須根據 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)

新增 SSO 使用者

參數

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
# 設定 host 為選用，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依據 API 伺服器的安全政策設定身份驗證與授權參數。
# 下方提供各種驗證方法的範例，請使用符合您驗證需求的範例。
# 設定 API key 授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，取消註解下列以設定 API key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 以 API client 實例開啟一個上下文
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)

刪除 SSO 使用者

Parameters

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

Response

返回：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
# 取消註解以下以設定 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)

以 Email 取得 SSO 使用者

參數

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
# 定義 host 是可選的，預設為 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 client 的實例進入上下文
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)

以 ID 取得 SSO 使用者

參數

Name	Type	Location	Required	Description
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
# 定義 host 是可選的，預設為 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 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 | 
    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)

取得 SSO 使用者列表

參數

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

回應

回傳: 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
# 定義 host 為選用，預設為 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 key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 以 API client 實例建立上下文
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)

部分更新 SSO 使用者

參數

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
# 設定 host 為可選，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依據 API 伺服器的安全政策設定驗證與授權參數
# 下方提供各種驗證方式的範例，請使用符合您驗證需求的範例。
# 設定 API key 授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，取消註解下列內容以設定 API key 的前置字串（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 以 ApiClient 實例進入上下文
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)

取代 SSO 使用者

參數

名稱	類型	位置	必填
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)

建立訂閱

參數

名稱	類型	位置	必填	說明
tenantId	string	query	Yes

回應

回傳: 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
# 定義 host 是可選的，預設為 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_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)

刪除訂閱

參數

Name	Type	Location	Required
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
# 定義 host 是可選的，預設為 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 用戶端實例進入一個 context
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)

取得訂閱列表

參數

Name	Type	Location	Required	Description
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
# 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 | 
    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)

更新訂閱

參數

名稱	類型	位置	必填
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
# 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 | 
    update_api_user_subscription_data = client.UpdateAPIUserSubscriptionData() # UpdateAPIUserSubscriptionData | 
    user_id = 'user_id_example' # str |  (optional)
    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)

取得租戶每日使用量

參數

名稱	類型	位置	必填
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 以取得所有支援的設定參數列表。
# 客戶端必須根據 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 | 
    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)

建立租戶套裝方案

參數

名稱	類型	位置	必填	描述
tenantId	string	query	Yes

回應

回傳: 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
# 如有需要，取消註解下方以設定 API 金鑰的前綴（例如 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)

刪除租戶套裝方案

參數

Name	Type	Location	Required	Description
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
# 定義 host 是可選的，預設為 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 client 的實例進入一個 context
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)

取得租戶套裝方案

參數

名稱	型別	位置	必填	說明
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
# 定義 host 是可選的，預設為 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_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)

取得租戶套裝方案列表

參數

名稱	類型	位置	是否必填	說明
tenantId	string	query	是
skip	number	query	否

回應

回傳: 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
# 定義 host 為選用，預設為 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'
# 使用 ApiClient 的實例進入一個上下文
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)

取代租戶套裝方案

參數

名稱	類型	位置	必填	描述
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）
# 使用 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)

更新租戶套裝方案

參數

Name	Type	Location	Required	Description
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
# 定義 host 是可選的，預設為 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)

建立租戶使用者

參數

名稱	類型	位置	必填	說明
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
# 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 | 
    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)

刪除租戶使用者

參數

名稱	類型	位置	必填
tenantId	string	query	是
id	string	path	是
deleteComments	string	query	否
commentDeleteMode	string	query	否

回應

返回：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
# 定義 host 為可選，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數列表。
# 客戶端必須依照 API 伺服器的安全政策設定驗證與授權參數。
# 以下提供每種驗證方式的範例，請使用符合您驗證需求的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，取消註解下列行以設定前綴（例如 Bearer）給 API 金鑰
# 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)

取得租戶使用者

參數

Name	Type	Location	Required	Description
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
# 定義 host 是可選的，預設為 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 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 | 
    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)

取得租戶使用者列表

參數

Name	Type	Location	Required	Description
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
# 設定 host 為可選，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全性政策。
# 下方提供每種驗證方法的範例，
# 請使用符合您驗證使用情境的範例。
# 設定 API key 授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消註解下列程式以設定 API key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API client 實例進入一個上下文
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_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)

取代租戶使用者

參數

Name	Type	Location	Required
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
# 定義 host 是可選的，預設為 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
# 設定 host 為選用，預設為 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)

更新租戶使用者

參數

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
# 定義 host 非必須，預設為 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_tenant_user_body = client.UpdateTenantUserBody() # UpdateTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (optional)
    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)

建立租戶

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回傳

Returns: 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
# 定義 host 為可選，預設為 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'
# 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_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)

刪除租戶

參數

名稱	類型	位置	必填
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)

取得租戶

參數

名稱	類型	位置	必填	說明
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
# 定義 host 為可選，預設為 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'
# 使用 ApiClient 實例進入一個上下文
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)

取得租戶列表

參數

名稱	類型	位置	必填
tenantId	string	query	是
meta	string	query	否
skip	number	query	否

回應

Returns: GetTenantsResponse

範例

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 以取得所有支援的設定參數清單。
# 用戶端必須依照 API 伺服器的安全政策設定驗證與授權參數
# 於符合 API 伺服器安全政策的情況下。
# 以下提供每種認證方法的範例，使用符合您認證使用情境的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 取消註解以下以設定前綴（例如 Bearer）給 API 金鑰，如有需要
# 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)

更新租戶

參數

Name	Type	Location	Required	Description
tenantId	string	查詢	是
id	string	路徑	是

回應

回傳: 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
# 定義 host 為選用，預設為 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'
# 使用 ApiClient 實例進入執行環境
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)

更改工單狀態

參數

名稱	類型	位置	必填
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
# 定義 host 為選用，預設為 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 client 的實例進入一個上下文
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)

建立工單

參數

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
# 定義 host 是選用的，預設為 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 client 的實例進入一個 context
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)

取得工單

參數

Name	Type	Location	Required
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
# 設定 host 是可選的，預設為 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 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 | 
    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)

取得工單列表

參數

名稱	類型	位置	必填
tenantId	string	query	Yes
userId	string	query	No
state	number	query	No
skip	number	query	No
limit	number	query	No

回應

返回：GetTicketsResponse

範例

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 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依照 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 | 
    user_id = 'user_id_example' # str |  (可選)
    state = 3.4 # float |  (可選)
    skip = 3.4 # float |  (可選)
    limit = 3.4 # float |  (可選)
    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)

取得翻譯

參數

名稱	類型	位置	必填
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 |  (可選)
    use_full_translation_ids = True # bool |  (可選)
    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 and resize an image

參數

Name	Type	Location	Required	Description
tenantId	string	path	Yes
sizePreset	string	query	No	大小預設設定：「Default」 (1000x1000px) 或「CrossPlatform」(為流行裝置建立尺寸)
urlId	string	query	No	上傳發生的頁面 ID，用於配置

回應

Returns: 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)

以 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
# 定義 host 是可選的，預設為 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 client 的實例進入一個上下文 (context)
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)

以使用者 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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 下方提供每種驗證方法的範例，
# 使用滿足您驗證使用情境的範例。
# 設定 API Key 授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下方註解以設定 API Key 的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API Client 實例進入一個上下文
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)

取得使用者徽章進度列表

參數

名稱	類型	位置	必填
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 以取得所有支援的設定參數列表。
# 用戶端必須配置驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 下面提供了每種驗證方法的範例，請使用符合您驗證需求的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消註解以下程式碼以設定 API 金鑰的前綴（例如 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)
    limit = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    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)

建立使用者徽章

參數

Name	Type	Location	Required	Description
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
# 定義 host 是可選的，預設為 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 client 實例進入一個上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    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)

刪除使用者徽章

參數

Name	Type	Location	Required	Description
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 伺服器的安全政策來設定驗證與授權參數。
# 每種驗證方法的範例在下面提供，請使用符合您驗證使用情境的範例。
# 設定 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_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)

取得使用者徽章

參數

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

回應

回傳: 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
# 定義 host 是可選的，預設為 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_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)

取得使用者徽章列表

參數

名稱	類型	位置	必填
tenantId	string	查詢	是
userId	string	查詢	否
badgeId	string	查詢	否
type	number	查詢	否
displayedOnComments	boolean	查詢	否
limit	number	查詢	否
skip	number	查詢	否

回應

Returns: 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 以獲得所有受支援設定參數的清單。
# 客戶端必須依據 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)

更新使用者徽章

參數

名稱	類型	位置	必填	描述
tenantId	string	查詢	是
id	string	路徑	是

回應

回傳: 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
# 定義 host 為選用，預設為 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 | 
    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)

取得使用者通知計數

參數

Name	Type	Location	Required	Description
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"
)
# 使用 ApiClient 實例進入上下文
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)

取得使用者通知

Parameters

Name	Type	Location	Required	Description
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

Response

Returns: GetMyNotificationsResponse

Example

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 | 用於判斷當前頁面是否已訂閱。(optional)
    page_size = 56 # int |  (optional)
    after_id = 'after_id_example' # str |  (optional)
    include_context = True # bool |  (optional)
    after_created_at = 56 # int |  (optional)
    unread_only = True # bool |  (optional)
    dm_only = True # bool |  (optional)
    no_dm = True # bool |  (optional)
    include_translations = True # bool |  (optional)
    include_tenant_notifications = True # bool |  (optional)
    sso = 'sso_example' # str |  (optional)
    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)

重設使用者通知計數

參數

名稱	類型	位置	必填	說明
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 client 的實例進入上下文
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)

重設使用者通知

參數

名稱	類型	位置	必填
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

範例

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"
)
# 以 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 |  (可選)
    after_created_at = 56 # int |  (可選)
    unread_only = True # bool |  (可選)
    dm_only = True # bool |  (可選)
    no_dm = True # bool |  (可選)
    sso = 'sso_example' # str |  (可選)
    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=sso))
        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)

更新使用者留言訂閱狀態

啟用或停用特定評論的通知。

參數

名稱	類型	位置	必填	描述
tenantId	string	query	是
notificationId	string	path	是
optedInOrOut	string	path	是
commentId	string	query	是
sso	string	query	否	(選填)

回應

回傳: 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
# 定義 host 為可選，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 以 API client 的實例進入上下文
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)

更新使用者頁面訂閱狀態

啟用或停用頁面的通知。當使用者訂閱頁面時，系統會在有新的根留言時建立通知，並且還會

參數

名稱	類型	位置	必要
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)

更新使用者通知狀態

參數

名稱	類型	位置	必填
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
# 定義 host 是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API client 的實例進入一個上下文
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 |  (optional)
    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)

取得使用者在線狀態

參數

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)

搜尋使用者

參數

名稱	類型	位置	必填
tenantId	string	path	Yes
urlId	string	query	Yes
usernameStartsWith	string	query	No
mentionGroupIds	array	query	No
sso	string	query	No
searchSection	string	query	No

回應

返回：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
# 定義 host 是可選的，預設為 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.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)

取得使用者

參數

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
# 定義 host 是可選的，預設為 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 | 
    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)

建立投票

參數

Name	Type	Location	Required
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 以取得所有支援的設定參數清單。
# 用戶端必須依照 API 伺服器的安全政策設定驗證與授權參數。
# 下面提供每種認證方式的範例，請使用符合您認證需求的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 取消註解以下行以設定前置詞 (例如 Bearer) 給 API 金鑰，如有需要
# 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 | 
    direction = 'direction_example' # str | 
    user_id = 'user_id_example' # str |  (可選)
    anon_user_id = 'anon_user_id_example' # str |  (可選)
    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)

刪除投票

參數

Name	Type	Location	Required
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
# 定義 host 為選用，預設為 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'
# 使用 ApiClient 的實例建立一個上下文
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)

取得投票

參數

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
# 定義 host 是可選的，預設為 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)

取得使用者的投票

參數

名稱	類型	位置	必填
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'
# 以 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 |  (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

儲存庫

安裝

從 GitHub 安裝

程式庫內容

公開與保護 API

快速開始

使用已驗證的 API (DefaultApi)

使用公共 API (PublicApi)

使用審核儀表板 (ModerationApi)

使用 SSO（單一登入）

常見問題

注意事項

廣播 ID

系統需求

彙總

參數

回應

範例

取得稽核日誌

參數

回應

範例

登出（公開）

回應

範例

從留言封鎖（公開）

參數

回應

範例

取消封鎖留言（公開）

參數

回應

範例

檢查被封鎖的留言

參數

回應