FastComments Python SDK

這是 FastComments 的官方 Python SDK。

FastComments API 的官方 Python SDK

儲存庫

安裝

PyPI

pip install fastcomments

函式庫內容

此函式庫包含兩個模組：生成的 API 客戶端與核心 Python 函式庫，後者包含手寫的工具以便更容易使用 API，包括 SSO 支援。

公開與受保護的 API

對於 API 客戶端，有兩個類別，DefaultApi 和 PublicApi。DefaultApi 包含需要您的 API 金鑰的方法，而 PublicApi 包含可以直接從瀏覽器、行動裝置等在未經驗證的情況下呼叫的 API。

快速開始

使用已驗證的 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/api"

# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key = {"ApiKeyAuth": "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(
        tenant_id="YOUR_TENANT_ID",
        create_apisso_user_data=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"

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

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

使用 SSO（單一登入）

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

from sso import FastCommentsSSO, SecureSSOUserData

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

# Create SSO instance with your API secret
sso = FastCommentsSSO.new_secure(
    api_secret="YOUR_API_SECRET",
    user_data=user_data
)

# Generate the SSO token
sso_token = sso.create_token()

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

For simple SSO (less secure, for testing):

from sso import FastCommentsSSO, SimpleSSOUserData

user_data = SimpleSSOUserData(
    user_id="user-123",
    email="user@example.com"
)

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

常見問題

401 "missing-api-key" error：請在建立 DefaultApi 實例之前，確認已設定 config.api_key = {"ApiKeyAuth": "YOUR_KEY"}。
Wrong API class：對於伺服器端需驗證的請求，請使用 DefaultApi；對於用戶端/公開的請求，請使用 PublicApi。
Import errors：請確定您是從正確的模組匯入：
- API client: from client import ...
- SSO utilities: from sso import ...

備註

廣播 ID

您會看到在某些 API 呼叫中需要傳入 broadcast_id。當您接收到事件時，會收到這個 ID 回傳，因此如果您打算在客戶端採用樂觀更新（您大概會想這麼做，因為它提供最佳體驗），就可以利用這個 ID 判斷是否忽略該事件。此處請傳入一個 UUID。該 ID 應足夠唯一，以免在同一個瀏覽器會話中出現兩次。

需求

Python >= 3.8
urllib3 >= 1.25.3
python-dateutil >= 2.8.2
pydantic >= 2.0.0
typing-extensions >= 4.0.0

彙總

彙總文件，透過分組（若提供 groupBy）並套用多種運算。支援不同的運算（例如 sum、countDistinct、avg 等）。

參數

名稱	Type	Location	必填
tenantId	string	query	是
parentTenantId	string	query	否
includeStats	boolean	query	否

回應

回傳: AggregationResponse

範例

aggregate 範例

Copy

import client
from client.models.aggregation_request import AggregationRequest
from client.models.aggregation_response import AggregationResponse
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 | 
    aggregation_request = client.AggregationRequest() # AggregationRequest | 
    parent_tenant_id = 'parent_tenant_id_example' # str |  (可選)
    include_stats = True # bool |  (可選)
    try:
        api_response = api_instance.aggregate(tenant_id, aggregation_request, 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)

取得稽核日誌

參數

Name	Type	Location	Required
tenantId	string	query	是
limit	number	query	否
skip	number	query	否
order	string	query	否
after	number	query	否
before	number	query	否

回應

回傳: GetAuditLogs200Response

範例

get_audit_logs 範例

Copy

import client
from client.models.get_audit_logs200_response import GetAuditLogs200Response
from client.models.sortdir import SORTDIR
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 | 
    limit = 3.4 # float |  （選用）
    skip = 3.4 # float |  （選用）
    order = client.SORTDIR() # SORTDIR |  （選用）
    after = 3.4 # float |  （選用）
    before = 3.4 # float |  （選用）
    try:
        api_response = api_instance.get_audit_logs(tenant_id, 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)

公開封鎖評論來源

參數

名稱	類型	位置	必填
tenantId	string	查詢	是
commentId	string	路徑	是
sso	string	查詢	否

回應

回傳： BlockFromCommentPublic200Response

範例

block_from_comment_public 範例

Copy

import client
from client.models.block_from_comment_public200_response import BlockFromCommentPublic200Response
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"
)
# 使用 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 | 
    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)

公開解除封鎖評論

參數

名稱	類型	位置	必填
tenantId	string	查詢	是
commentId	string	路徑	是
sso	string	查詢	否

回應

回傳: UnBlockCommentPublic200Response

範例

un_block_comment_public 範例

Copy

import client
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.models.un_block_comment_public200_response import UnBlockCommentPublic200Response
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 | 
    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)

檢查已封鎖的評論

參數

Name	Type	Location	Required	Description
tenantId	string	query	Yes
commentIds	string	query	Yes	以逗號分隔的評論 ID 列表。
sso	string	query	No

回應

Returns: CheckedCommentsForBlocked200Response

範例

checked_comments_for_blocked 範例

Copy

import client
from client.models.checked_comments_for_blocked200_response import CheckedCommentsForBlocked200Response
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 | 
    comment_ids = 'comment_ids_example' # str | 以逗號分隔的評論 ID 列表。
    sso = 'sso_example' # str | （可選）
    try:
        api_response = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, sso=sso)
        print("The response of PublicApi->checked_comments_for_blocked:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->checked_comments_for_blocked: %s\n" % e)

從評論封鎖使用者

參數

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

回應

回傳: BlockFromCommentPublic200Response

範例

block_user_from_comment 範例

Copy

import client
from client.models.block_from_comment_params import BlockFromCommentParams
from client.models.block_from_comment_public200_response import BlockFromCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# 定義 host 為選用，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全性政策。
# 下方提供每種驗證方法的範例，
# 請使用符合您驗證使用案例的範例。
# 設定 API key 授權：api_key
# 如有需要，取消註解下列程式以設定 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 | 
    block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (選用)
    anon_user_id = 'anon_user_id_example' # str |  (選用)
    try:
        api_response = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, 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)

建立公開評論

參數

名稱	Type	位置	必填
tenantId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
sessionId	string	query	否
sso	string	query	否

回應

回傳：CreateCommentPublic200Response

範例

create_comment_public 範例

Copy

import client
from client.models.comment_data import CommentData
from client.models.create_comment_public200_response import CreateCommentPublic200Response
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 | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_data = client.CommentData() # CommentData | 
    session_id = 'session_id_example' # str |  (選用)
    sso = 'sso_example' # str |  (選用)
    try:
        api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, 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	是
id	string	path	是
contextUserId	string	query	否
isLive	boolean	query	否

回應

回傳: DeleteComment200Response

範例

delete_comment 範例

Copy

import client
from client.models.delete_comment200_response import DeleteComment200Response
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 | 
    context_user_id = 'context_user_id_example' # str |  （可選）
    is_live = True # bool |  （可選）
    try:
        api_response = api_instance.delete_comment(tenant_id, id, 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)

刪除公開評論

參數

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

回應

回傳: DeleteCommentPublic200Response

範例

delete_comment_public 範例

Copy

import client
from client.models.delete_comment_public200_response import DeleteCommentPublic200Response
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 | 
    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, 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)

刪除評論投票

參數

Name	Type	Location	Required
tenantId	string	path	是
commentId	string	path	是
voteId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

回應

回傳: DeleteCommentVote200Response

範例

delete_comment_vote 範例

Copy

import client
from client.models.delete_comment_vote200_response import DeleteCommentVote200Response
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 |  (可選)
    sso = 'sso_example' # str |  (可選)
    try:
        api_response = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, 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)

檢舉評論

參數

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

回應

回傳: FlagComment200Response

範例

flag_comment 範例

Copy

import client
from client.models.flag_comment200_response import FlagComment200Response
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 | 
    user_id = 'user_id_example' # str |  (可選)
    anon_user_id = 'anon_user_id_example' # str |  (可選)
    try:
        api_response = api_instance.flag_comment(tenant_id, id, 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)

取得評論

參數

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

回應

回傳: GetComment200Response

範例

get_comment 範例

Copy

import client
from client.models.get_comment200_response import GetComment200Response
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 | 
    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)

取得評論內容

參數

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

回應

回傳: GetCommentText200Response

範例

get_comment_text 範例

Copy

import client
from client.models.get_comment_text200_response import GetCommentText200Response
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 | 
    comment_id = 'comment_id_example' # str | 
    edit_key = 'edit_key_example' # str |  （可選）
    sso = 'sso_example' # str |  （可選）
    try:
        api_response = api_instance.get_comment_text(tenant_id, comment_id, 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	否

回應

回傳: GetCommentVoteUserNames200Response

範例

get_comment_vote_user_names 範例

Copy

import client
from client.models.get_comment_vote_user_names200_response import GetCommentVoteUserNames200Response
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 | 
    dir = 56 # int | 
    sso = 'sso_example' # str |  (optional)
    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)

取得評論清單

參數

Name	Type	Location	Required
tenantId	string	query	是
page	integer	query	否
limit	integer	query	否
skip	integer	query	否
asTree	boolean	query	否
skipChildren	integer	query	否
limitChildren	integer	query	否
maxTreeDepth	integer	query	否
urlId	string	query	否
userId	string	query	否
anonUserId	string	query	否
contextUserId	string	query	否
hashTag	string	query	否
parentId	string	query	否
direction	string	query	否

回應

回傳: GetComments200Response

範例

get_comments 範例

Copy

import client
from client.models.get_comments200_response import GetComments200Response
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:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 56 # int |  (可選)
    limit = 56 # int |  (可選)
    skip = 56 # int |  (可選)
    as_tree = True # bool |  (可選)
    skip_children = 56 # int |  (可選)
    limit_children = 56 # int |  (可選)
    max_tree_depth = 56 # int |  (可選)
    url_id = 'url_id_example' # str |  (可選)
    user_id = 'user_id_example' # str |  (可選)
    anon_user_id = 'anon_user_id_example' # str |  (可選)
    context_user_id = 'context_user_id_example' # str |  (可選)
    hash_tag = 'hash_tag_example' # str |  (可選)
    parent_id = 'parent_id_example' # str |  (可選)
    direction = client.SortDirections() # SortDirections |  (可選)
    try:
        api_response = api_instance.get_comments(tenant_id, 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)
        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)

取得公開評論

req tenantId urlId

參數

名稱	類型	位置	必填
tenantId	string	path	是
urlId	string	query	是
page	integer	query	否
direction	string	query	否
sso	string	query	否
skip	integer	query	否
skipChildren	integer	query	否
limit	integer	query	否
limitChildren	integer	query	否
countChildren	boolean	query	否
fetchPageForCommentId	string	query	否
includeConfig	boolean	query	否
countAll	boolean	query	否
includei10n	boolean	query	否
locale	string	query	否
modules	string	query	否
isCrawler	boolean	query	否
includeNotificationCount	boolean	query	否
asTree	boolean	query	否
maxTreeDepth	integer	query	否
useFullTranslationIds	boolean	query	否
parentId	string	query	否
searchText	string	query	否
hashTags	array	query	否
userId	string	query	否
customConfigStr	string	query	否
afterCommentId	string	query	否
beforeCommentId	string	query	否

回應

回傳: GetCommentsPublic200Response

範例

get_comments_public 範例

Copy

import client
from client.models.get_comments_public200_response import GetCommentsPublic200Response
from client.models.sort_directions import SortDirections
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 | 
    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, 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)

鎖定評論

參數

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

回應

回傳: LockComment200Response

範例

lock_comment 範例

Copy

import client
from client.models.lock_comment200_response import LockComment200Response
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 | 
    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)

置頂評論

參數

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

回應

回傳: PinComment200Response

範例

pin_comment 範例

Copy

import client
from client.models.pin_comment200_response import PinComment200Response
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)

儲存評論

參數

Name	Type	Location	Required
tenantId	string	query	是
isLive	boolean	query	否
doSpamCheck	boolean	query	否
sendEmails	boolean	query	否
populateNotifications	boolean	query	否

回應

回傳: SaveComment200Response

範例

save_comment 範例

Copy

import client
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comment200_response import SaveComment200Response
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_comment_params = client.CreateCommentParams() # CreateCommentParams | 
    is_live = True # bool |  (選用)
    do_spam_check = True # bool |  (選用)
    send_emails = True # bool |  (選用)
    populate_notifications = True # bool |  (選用)
    try:
        api_response = api_instance.save_comment(tenant_id, create_comment_params, 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)

批次儲存評論

參數

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

回應

回傳: SaveComment200Response

範例

save_comments_bulk 範例

Copy

import client
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comment200_response import SaveComment200Response
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 | 
    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, 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)

設定評論內容

參數

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

回應

回傳: SetCommentText200Response

範例

set_comment_text 範例

Copy

import client
from client.models.comment_text_update_request import CommentTextUpdateRequest
from client.models.set_comment_text200_response import SetCommentText200Response
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 | 
    comment_text_update_request = client.CommentTextUpdateRequest() # CommentTextUpdateRequest | 
    edit_key = 'edit_key_example' # str |  （可選）
    sso = 'sso_example' # str |  （可選）
    try:
        api_response = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, edit_key=edit_key, sso=sso)
        print("The response of PublicApi->set_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->set_comment_text: %s\n" % e)

解除從評論封鎖使用者

參數

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

回應

回傳：UnBlockCommentPublic200Response

範例

un_block_user_from_comment 範例

Copy

import client
from client.models.un_block_comment_public200_response import UnBlockCommentPublic200Response
from client.models.un_block_from_comment_params import UnBlockFromCommentParams
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 | 
    id = 'id_example' # str | 
    un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, 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)

取消檢舉評論

參數

名稱	類型	位置	必填
tenantId	string	query	是
id	string	path	是
userId	string	query	否
anonUserId	string	query	否

回應

回傳: FlagComment200Response

範例

un_flag_comment 範例

Copy

import client
from client.models.flag_comment200_response import FlagComment200Response
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 | 
    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, 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	否

回應

回傳：LockComment200Response

範例

un_lock_comment 範例

Copy

import client
from client.models.lock_comment200_response import LockComment200Response
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 | 
    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)

取消置頂評論

參數

名稱	Type	Location	必填
tenantId	string	path	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

回應

回傳：PinComment200Response

範例

un_pin_comment 範例

Copy

import client
from client.models.pin_comment200_response import PinComment200Response
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_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)

更新評論

參數

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
contextUserId	string	query	否
doSpamCheck	boolean	query	否
isLive	boolean	query	否

回應

回傳：FlagCommentPublic200Response

範例

update_comment 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.pick_api_comment_updatable_comment_fields import PickAPICommentUpdatableCommentFields
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 | 
    body = client.PickAPICommentUpdatableCommentFields() # PickAPICommentUpdatableCommentFields | 
    context_user_id = 'context_user_id_example' # str |  (選用)
    do_spam_check = True # bool |  (選用)
    is_live = True # bool |  (選用)
    try:
        api_response = api_instance.update_comment(tenant_id, id, body, 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)

對評論投票

參數

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

回應

回傳: VoteComment200Response

範例

vote_comment 範例

Copy

import client
from client.models.vote_body_params import VoteBodyParams
from client.models.vote_comment200_response import VoteComment200Response
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 | 
    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, 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)

新增網域設定

參數

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

回應

回傳：AddDomainConfig200Response

範例

add_domain_config 範例

Copy

import client
from client.models.add_domain_config200_response import AddDomainConfig200Response
from client.models.add_domain_config_params import AddDomainConfigParams
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 | 
    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	是

回應

回傳: DeleteDomainConfig200Response

範例

delete_domain_config 範例

Copy

import client
from client.models.delete_domain_config200_response import DeleteDomainConfig200Response
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 | 
    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	是

回應

回傳: GetDomainConfig200Response

範例

get_domain_config 範例

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
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 | 
    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)

取得網域設定清單

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回應

回傳: GetDomainConfigs200Response

範例

get_domain_configs 範例

Copy

import client
from client.models.get_domain_configs200_response import GetDomainConfigs200Response
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 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)

部分更新網域設定

參數

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

回應

回傳: GetDomainConfig200Response

範例

patch_domain_config 範例

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.models.patch_domain_config_params import PatchDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# 定義主機為選用，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依照 API 伺器器的安全性策略來設定驗證與授權參數。
# 下方提供每種驗證方式的範例，請使用符合您驗證需求的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，取消註解下列內容以設定 API 金鑰的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 用戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_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)

覆寫網域設定

參數

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

回應

回傳: GetDomainConfig200Response

範例

put_domain_config 範例

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.models.update_domain_config_params import UpdateDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# 定義 host 是可選的，預設為 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
# 以符合 API 伺服器的安全性政策。
# 下方提供了每種驗證方法的範例，使用可符合您驗證情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_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	是

回應

回傳: CreateEmailTemplate200Response

範例

create_email_template 範例

Copy

import client
from client.models.create_email_template200_response import CreateEmailTemplate200Response
from client.models.create_email_template_body import CreateEmailTemplateBody
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_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)

刪除電子郵件範本

參數

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

回傳

回傳：FlagCommentPublic200Response

範例

delete_email_template 範例

Copy

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

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

參數

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

回應

回傳: FlagCommentPublic200Response

範例

delete_email_template_render_error 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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)

取得電子郵件範本

參數

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

回應

回傳: GetEmailTemplate200Response

範例

get_email_template 範例

Copy

import client
from client.models.get_email_template200_response import GetEmailTemplate200Response
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）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
# 使用 API 客戶端實例進入一個上下文
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 | 
    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	是

回應

回傳: GetEmailTemplateDefinitions200Response

範例

get_email_template_definitions 範例

Copy

import client
from client.models.get_email_template_definitions200_response import GetEmailTemplateDefinitions200Response
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 | 
    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)

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

參數

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

回應

Returns: GetEmailTemplateRenderErrors200Response

範例

get_email_template_render_errors 範例

Copy

import client
from client.models.get_email_template_render_errors200_response import GetEmailTemplateRenderErrors200Response
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 | 
    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)

取得電子郵件範本清單

參數

Name	Type	Location	Required	Description
tenantId	string	query	是
skip	number	query	否

回應

回傳: GetEmailTemplates200Response

範例

get_email_templates 範例

Copy

import client
from client.models.get_email_templates200_response import GetEmailTemplates200Response
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 | 
    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	否

回應

回傳： RenderEmailTemplate200Response

範例

render_email_template 範例

Copy

import client
from client.models.render_email_template200_response import RenderEmailTemplate200Response
from client.models.render_email_template_body import RenderEmailTemplateBody
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）
# 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 | 
    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)

更新電子郵件範本

參數

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

回應

回傳：FlagCommentPublic200Response

範例

update_email_template 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 伺服器的安全政策。
# 下方提供了每種驗證方法的範例，請使用符合您驗證需求的範例。
# 設定 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_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	是

回應

回傳: GetEventLog200Response

範例

get_event_log 範例

Copy

import client
from client.models.get_event_log200_response import GetEventLog200Response
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 | 
    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)
        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	是

回應

回傳: GetEventLog200Response

範例

get_global_event_log 範例

Copy

import client
from client.models.get_event_log200_response import GetEventLog200Response
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_global_event_log(tenant_id, url_id, user_id_ws, start_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)

建立動態貼文

參數

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

回應

回傳: CreateFeedPost200Response

範例

create_feed_post 範例

Copy

import client
from client.models.create_feed_post200_response import CreateFeedPost200Response
from client.models.create_feed_post_params import CreateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# 定義主機是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全性政策。
# 下方提供每種授權方法的範例，請
# 使用符合您授權使用情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 ApiClient 實例進入一個上下文
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, broadcast_id=broadcast_id, is_live=is_live, do_spam_check=do_spam_check, skip_dup_check=skip_dup_check)
        print("The response of DefaultApi->create_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_feed_post: %s\n" % e)

建立公開的動態貼文

參數

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

回應

回傳: CreateFeedPostPublic200Response

範例

create_feed_post_public 範例

Copy

import client
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_post_public200_response import CreateFeedPostPublic200Response
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 |  （可選）
    sso = 'sso_example' # str |  （可選）
    try:
        api_response = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, 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)

刪除公開動態貼文

參數

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

回應

回傳: DeleteFeedPostPublic200Response

範例

delete_feed_post_public 範例

Copy

import client
from client.models.delete_feed_post_public200_response import DeleteFeedPostPublic200Response
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 | 
    post_id = 'post_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (選用)
    sso = 'sso_example' # str |  (選用)
    try:
        api_response = api_instance.delete_feed_post_public(tenant_id, post_id, 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

參數

名稱	類型	位置	必填
tenantId	string	query	是
afterId	string	query	否
limit	integer	query	否
tags	array	query	否

回應

回傳: GetFeedPosts200Response

範例

get_feed_posts 範例

Copy

import client
from client.models.get_feed_posts200_response import GetFeedPosts200Response
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 | 
    after_id = 'after_id_example' # str |  (可選)
    limit = 56 # int |  (可選)
    tags = ['tags_example'] # List[str] |  (可選)
    try:
        api_response = api_instance.get_feed_posts(tenant_id, 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	是
afterId	string	query	否
limit	integer	query	否
tags	array	query	否
sso	string	query	否
isCrawler	boolean	query	否
includeUserInfo	boolean	query	否

回應

回傳: GetFeedPostsPublic200Response

範例

get_feed_posts_public 範例

Copy

import client
from client.models.get_feed_posts_public200_response import GetFeedPostsPublic200Response
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 | 
    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, after_id=after_id, limit=limit, tags=tags, sso=sso, is_crawler=is_crawler, include_user_info=include_user_info)
        print("The response of PublicApi->get_feed_posts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_public: %s\n" % e)

取得動態貼文統計

參數

Name	Type	Location	Required
tenantId	string	路徑	是
postIds	array	查詢	是
sso	string	查詢	否

回應

回傳: GetFeedPostsStats200Response

範例

get_feed_posts_stats 範例

Copy

import client
from client.models.get_feed_posts_stats200_response import GetFeedPostsStats200Response
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 | 
    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)

取得使用者公開反應

參數

Name	Type	Location	Required
tenantId	string	path	Yes
postIds	array	query	No
sso	string	query	No

回應

回傳：GetUserReactsPublic200Response

範例

get_user_reacts_public 範例

Copy

import client
from client.models.get_user_reacts_public200_response import GetUserReactsPublic200Response
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 | 
    post_ids = ['post_ids_example'] # List[str] |  （可選）
    sso = 'sso_example' # str |  （可選）
    try:
        api_response = api_instance.get_user_reacts_public(tenant_id, 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)

對公開動態貼文反應

參數

Name	Type	Location	Required
tenantId	string	path	是
postId	string	path	是
isUndo	boolean	query	否
broadcastId	string	query	否
sso	string	query	否

回應

回傳: ReactFeedPostPublic200Response

範例

react_feed_post_public 範例

Copy

import client
from client.models.react_body_params import ReactBodyParams
from client.models.react_feed_post_public200_response import ReactFeedPostPublic200Response
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 | 
    post_id = 'post_id_example' # str | 
    react_body_params = client.ReactBodyParams() # ReactBodyParams | 
    is_undo = True # bool |  (可選)
    broadcast_id = 'broadcast_id_example' # str |  (可選)
    sso = 'sso_example' # str |  (可選)
    try:
        api_response = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, 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)

更新動態貼文

參數

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

回應

回傳: FlagCommentPublic200Response

範例

update_feed_post 範例

Copy

import client
from client.models.feed_post import FeedPost
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# 設定主機為選用，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 下方提供各種驗證方法的範例，
# 請使用符合您驗證情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 用戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    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)

更新公開動態貼文

參數

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

回應

回傳: CreateFeedPostPublic200Response

範例

update_feed_post_public 範例

Copy

import client
from client.models.create_feed_post_public200_response import CreateFeedPostPublic200Response
from client.models.update_feed_post_params import UpdateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# 設定主機是可選的，預設為 https://fastcomments.com
# 有關所有支援的設定參數清單，請參閱 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    update_feed_post_params = client.UpdateFeedPostParams() # UpdateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, 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)

公開檢舉評論

參數

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

回應

回傳: FlagCommentPublic200Response

範例

flag_comment_public 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# 設定主機為選用，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的配置參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 以 API 客戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    is_flagged = True # bool | 
    sso = 'sso_example' # str |  (選用)
    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)

新增標籤

參數

Name	Type	Location	Required	Description
tenantId	string	query	否

回應

回傳: AddHashTag200Response

範例

add_hash_tag 範例

Copy

import client
from client.models.add_hash_tag200_response import AddHashTag200Response
from client.models.create_hash_tag_body import CreateHashTagBody
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 |  (optional)
    create_hash_tag_body = client.CreateHashTagBody() # CreateHashTagBody |  (optional)
    try:
        api_response = api_instance.add_hash_tag(tenant_id=tenant_id, create_hash_tag_body=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)

批次新增標籤

參數

Name	Type	Location	Required	Description
tenantId	string	query	No

回應

回傳: AddHashTagsBulk200Response

範例

add_hash_tags_bulk 範例

Copy

import client
from client.models.add_hash_tags_bulk200_response import AddHashTagsBulk200Response
from client.models.bulk_create_hash_tags_body import BulkCreateHashTagsBody
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 | （選用）
    bulk_create_hash_tags_body = client.BulkCreateHashTagsBody() # BulkCreateHashTagsBody | （選用）
    try:
        api_response = api_instance.add_hash_tags_bulk(tenant_id=tenant_id, bulk_create_hash_tags_body=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)

刪除標籤

參數

Name	Type	Location	Required	Description
tag	string	path	是
tenantId	string	query	否

回應

回傳: FlagCommentPublic200Response

範例

delete_hash_tag 範例

Copy

import client
from client.models.delete_hash_tag_request import DeleteHashTagRequest
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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)
    tag = 'tag_example' # str | 
    tenant_id = 'tenant_id_example' # str |  (選用)
    delete_hash_tag_request = client.DeleteHashTagRequest() # DeleteHashTagRequest |  (選用)
    try:
        api_response = api_instance.delete_hash_tag(tag, tenant_id=tenant_id, delete_hash_tag_request=delete_hash_tag_request)
        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)

取得標籤

參數

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

回應

回傳: GetHashTags200Response

範例

get_hash_tags 範例

Copy

import client
from client.models.get_hash_tags200_response import GetHashTags200Response
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 | 
    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)

部分更新標籤

參數

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

回應

回傳: PatchHashTag200Response

範例

patch_hash_tag 範例

Copy

import client
from client.models.patch_hash_tag200_response import PatchHashTag200Response
from client.models.update_hash_tag_body import UpdateHashTagBody
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)
    tag = 'tag_example' # str | 
    tenant_id = 'tenant_id_example' # str |  (選用)
    update_hash_tag_body = client.UpdateHashTagBody() # UpdateHashTagBody |  (選用)
    try:
        api_response = api_instance.patch_hash_tag(tag, tenant_id=tenant_id, update_hash_tag_body=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)

建立管理員

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回傳

回傳：CreateModerator200Response

範例

create_moderator 範例

Copy

import client
from client.models.create_moderator200_response import CreateModerator200Response
from client.models.create_moderator_body import CreateModeratorBody
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_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)

刪除管理員

參數

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

回應

回傳: FlagCommentPublic200Response

範例

delete_moderator 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# 定義 host 為選填，預設為 https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依據 API 伺服器的安全性政策設定驗證與授權參數。
# 下方提供各種驗證方法的範例，請使用符合您驗證情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，取消註解下列以設定 API 金鑰的前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 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 | 
    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)

取得管理員

參數

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

回應

回傳: GetModerator200Response

範例

get_moderator 範例

Copy

import client
from client.models.get_moderator200_response import GetModerator200Response
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 | 
    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)

取得管理員清單

參數

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

回應

回傳: GetModerators200Response

範例

get_moderators 範例

Copy

import client
from client.models.get_moderators200_response import GetModerators200Response
from client.rest import ApiException
from pprint import pprint
# 定義主機是可選的，預設為 https://fastcomments.com
# 有關所有支援的設定參數清單，請參閱 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須根據 API 伺服器的安全政策
# 設定驗證與授權參數。
# 下方提供每種授權方法的範例，請使用能滿足您
# 的授權使用情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    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	是

回應

回傳: FlagCommentPublic200Response

範例

send_invite 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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	查詢	是
id	string	路徑	是

回應

回傳: FlagCommentPublic200Response

範例

update_moderator 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_moderator_body import UpdateModeratorBody
from client.rest import ApiException
from pprint import pprint
# 定義主機為可選，預設值為 https://fastcomments.com
# 請參閱 configuration.py，了解所有支援的設定參數。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 下方提供每種授權方法的範例，請使用
# 適用於您授權使用情境的範例。
# 設定 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_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)

刪除通知計數

參數

名稱	類型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

回應

回傳: FlagCommentPublic200Response

範例

delete_notification_count 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# 定義主機是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依據 API 伺服器的安全性政策設定驗證與授權參數
# 下方提供了每種授權方法的範例，請使用
# 能符合您授權使用情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 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_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	是

回應

回傳: GetCachedNotificationCount200Response

範例

get_cached_notification_count 範例

Copy

import client
from client.models.get_cached_notification_count200_response import GetCachedNotificationCount200Response
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_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)

取得通知計數

參數

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No

回應

回傳: GetNotificationCount200Response

範例

get_notification_count 範例

Copy

import client
from client.models.get_notification_count200_response import GetNotificationCount200Response
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 | 
    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)
    try:
        api_response = api_instance.get_notification_count(tenant_id, user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type)
        print("The response of DefaultApi->get_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notification_count: %s\n" % e)

取得通知

參數

Name	Type	Location	Required
tenantId	string	query	是
userId	string	query	否
urlId	string	query	否
fromCommentId	string	query	否
viewed	boolean	query	否
type	string	query	否
skip	number	query	否

回應

回傳：GetNotifications200Response

範例

get_notifications 範例

Copy

import client
from client.models.get_notifications200_response import GetNotifications200Response
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 實例進入 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 |  (可選)
    url_id = 'url_id_example' # str |  (可選)
    from_comment_id = 'from_comment_id_example' # str |  (可選)
    viewed = True # bool |  (可選)
    type = 'type_example' # str |  (可選)
    skip = 3.4 # float |  (可選)
    try:
        api_response = api_instance.get_notifications(tenant_id, 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)

更新通知

參數

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

回應

回傳: FlagCommentPublic200Response

範例

update_notification 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 伺服器的安全政策。
# 下方提供每種驗證方法的範例，請使用
# 符合您使用情境的範例。
# 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 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)

新增頁面

參數

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)

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

部分更新頁面

參數

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

參數

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

回應

回傳：FlagCommentPublic200Response

範例

delete_pending_webhook_event 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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 事件數量

參數

Name	Type	Location	Required
tenantId	string	query	是
commentId	string	query	否
externalId	string	query	否
eventType	string	query	否
type	string	query	否
domain	string	query	否
attemptCountGT	number	query	否

回應

回傳: GetPendingWebhookEventCount200Response

範例

get_pending_webhook_event_count 範例

Copy

import client
from client.models.get_pending_webhook_event_count200_response import GetPendingWebhookEventCount200Response
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 | 
    comment_id = 'comment_id_example' # str |  (可選)
    external_id = 'external_id_example' # str |  (可選)
    event_type = 'event_type_example' # str |  (可選)
    type = 'type_example' # str |  (可選)
    domain = 'domain_example' # str |  (可選)
    attempt_count_gt = 3.4 # float | (可選)
    try:
        api_response = api_instance.get_pending_webhook_event_count(tenant_id, 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 事件

參數

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

回應

回傳: GetPendingWebhookEvents200Response

範例

get_pending_webhook_events 範例

Copy

import client
from client.models.get_pending_webhook_events200_response import GetPendingWebhookEvents200Response
from client.rest import ApiException
from pprint import pprint
# 定義主機是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依據 API 伺服器的安全性策略設定認證與授權參數。
# 每種驗證方法的範例已在下方提供，請使用符合您驗證案例的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消註解下方以為 API 金鑰設定前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 用戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (選用)
    external_id = 'external_id_example' # str |  (選用)
    event_type = 'event_type_example' # str |  (選用)
    type = 'type_example' # str |  (選用)
    domain = 'domain_example' # str |  (選用)
    attempt_count_gt = 3.4 # float |  (選用)
    skip = 3.4 # float |  (選用)
    try:
        api_response = api_instance.get_pending_webhook_events(tenant_id, 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)

建立問卷設定

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回傳

回傳: CreateQuestionConfig200Response

範例

create_question_config 範例

Copy

import client
from client.models.create_question_config200_response import CreateQuestionConfig200Response
from client.models.create_question_config_body import CreateQuestionConfigBody
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 | 
    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	是

回應

回傳: FlagCommentPublic200Response

範例

delete_question_config 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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)

取得問卷設定

參數

名稱	類型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

回應

回傳: GetQuestionConfig200Response

範例

get_question_config 範例

Copy

import client
from client.models.get_question_config200_response import GetQuestionConfig200Response
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 | 
    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	Yes
skip	number	query	No

回應

回傳: GetQuestionConfigs200Response

範例

get_question_configs 範例

Copy

import client
from client.models.get_question_configs200_response import GetQuestionConfigs200Response
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 | 
    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)

更新問卷設定

參數

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

回應

回傳: FlagCommentPublic200Response

範例

update_question_config 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_question_config_body import UpdateQuestionConfigBody
from client.rest import ApiException
from pprint import pprint
# 定義主機是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須根據 API 伺服器的安全性政策來設定驗證與授權參數。
# 下方提供每種驗證方法的範例，請使用符合您驗證使用情境的範例。
# 設定 API 金鑰授權：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消註解下方以為 API 金鑰設定前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客戶端實例進入一個上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_config_body = client.UpdateQuestionConfigBody() # UpdateQuestionConfigBody | 
    try:
        api_response = api_instance.update_question_config(tenant_id, id, update_question_config_body)
        print("The response of DefaultApi->update_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_config: %s\n" % e)

建立問卷結果

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回應

回傳：CreateQuestionResult200Response

範例

create_question_result 範例

Copy

import client
from client.models.create_question_result200_response import CreateQuestionResult200Response
from client.models.create_question_result_body import CreateQuestionResultBody
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）
# 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	Yes
id	string	path	Yes

回應

回傳: FlagCommentPublic200Response

範例

delete_question_result 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 的實例進入一個 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_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)

取得問卷結果

參數

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

回應

Returns: GetQuestionResult200Response

範例

get_question_result 範例

Copy

import client
from client.models.get_question_result200_response import GetQuestionResult200Response
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_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)

取得問卷結果清單

參數

Name	Type	Location	Required
tenantId	string	query	是
urlId	string	query	否
userId	string	query	否
startDate	string	query	否
questionId	string	query	否
questionIds	string	query	否
skip	number	query	否

回應

回傳： GetQuestionResults200Response

範例

get_question_results 範例

Copy

import client
from client.models.get_question_results200_response import GetQuestionResults200Response
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 | 
    url_id = 'url_id_example' # str |  (可選)
    user_id = 'user_id_example' # str |  (可選)
    start_date = 'start_date_example' # str |  (可選)
    question_id = 'question_id_example' # str |  (可選)
    question_ids = 'question_ids_example' # str |  (可選)
    skip = 3.4 # float |  (可選)
    try:
        api_response = api_instance.get_question_results(tenant_id, 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	Yes
id	string	path	Yes

回應

回傳: FlagCommentPublic200Response

範例

update_question_result 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_question_result_body import UpdateQuestionResultBody
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"]
# 如有需要，取消註解下列內容以設定前綴 (e.g. Bearer) 用於 API 金鑰
# 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)

彙總問卷結果

參數

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

回應

回傳: AggregateQuestionResults200Response

範例

aggregate_question_results 範例

Copy

import client
from client.models.aggregate_question_results200_response import AggregateQuestionResults200Response
from client.models.aggregate_time_bucket import AggregateTimeBucket
from client.rest import ApiException
from pprint import pprint
# 定義主機為可選，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須依據 API 伺服器的安全性政策設定驗證與授權參數。
# 下方提供每種驗證方法的範例，請使用符合您驗證需求的範例。
# 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 | 
    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, 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	Yes
forceRecalculate	boolean	query	No

回應

回傳: BulkAggregateQuestionResults200Response

範例

bulk_aggregate_question_results 範例

Copy

import client
from client.models.bulk_aggregate_question_results200_response import BulkAggregateQuestionResults200Response
from client.models.bulk_aggregate_question_results_request import BulkAggregateQuestionResultsRequest
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 | 
    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	否

回應

回傳: CombineCommentsWithQuestionResults200Response

範例

combine_comments_with_question_results 範例

Copy

import client
from client.models.combine_comments_with_question_results200_response import CombineCommentsWithQuestionResults200Response
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 | 
    question_id = 'question_id_example' # str |  (可選)
    question_ids = ['question_ids_example'] # List[str] |  (可選)
    url_id = 'url_id_example' # str |  (可選)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (可選)
    force_recalculate = True # bool |  (可選)
    min_value = 3.4 # float |  (可選)
    max_value = 3.4 # float |  (可選)
    limit = 3.4 # float |  (可選)
    try:
        api_response = api_instance.combine_comments_with_question_results(tenant_id, 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 使用者

參數

Name	Type	Location	Required
tenantId	string	查詢	是
id	string	路徑	是
deleteComments	boolean	查詢	否
commentDeleteMode	string	查詢	否

回應

回傳: DeleteSSOUserAPIResponse

範例

delete_sso_user 範例

Copy

import client
from client.models.delete_sso_user_api_response import DeleteSSOUserAPIResponse
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 | 
    delete_comments = True # bool |  (可選)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (可選)
    try:
        api_response = api_instance.delete_sso_user(tenant_id, id, 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)

以電子郵件取得 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	是
skip	integer	query	否

回應

回傳: GetSSOUsers200Response

範例

get_sso_users 範例

Copy

import client
from client.models.get_sso_users200_response import GetSSOUsers200Response
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 | 
    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	是
yearNumber	number	query	否
monthNumber	number	query	否
dayNumber	number	query	否
skip	number	query	否

回應

回傳： GetTenantDailyUsages200Response

範例

get_tenant_daily_usages 範例

Copy

import client
from client.models.get_tenant_daily_usages200_response import GetTenantDailyUsages200Response
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 | 
    year_number = 3.4 # float |  (可選)
    month_number = 3.4 # float |  (可選)
    day_number = 3.4 # float |  (可選)
    skip = 3.4 # float |  (可選)
    try:
        api_response = api_instance.get_tenant_daily_usages(tenant_id, 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	是

回應

回傳: CreateTenantPackage200Response

範例

create_tenant_package 範例

Copy

import client
from client.models.create_tenant_package200_response import CreateTenantPackage200Response
from client.models.create_tenant_package_body import CreateTenantPackageBody
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
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 | 
    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	是

回應

回傳: FlagCommentPublic200Response

範例

delete_tenant_package 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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.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

回應

回傳: GetTenantPackage200Response

範例

get_tenant_package 範例

Copy

import client
from client.models.get_tenant_package200_response import GetTenantPackage200Response
from client.rest import ApiException
from pprint import pprint
# 定義主機是可選的，預設為 https://fastcomments.com
# 請參閱 configuration.py 以取得所有支援的設定參數清單。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 下方提供每種驗證方法的範例，請使用符合您驗證情境的範例。
# 以符合您的驗證使用情境。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，解除註解下方以為 API 金鑰設定前綴（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_package(tenant_id, id)
        print("The response of DefaultApi->get_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_package: %s\n" % e)

取得租戶方案清單

參數

Name	Type	Location	Required	Description
tenantId	string	query	是
skip	number	query	否

回應

回傳: GetTenantPackages200Response

範例

get_tenant_packages 範例

Copy

import client
from client.models.get_tenant_packages200_response import GetTenantPackages200Response
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 | 
    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)

取代租戶方案

參數

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

回應

回傳：FlagCommentPublic200Response

範例

replace_tenant_package 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.replace_tenant_package_body import ReplaceTenantPackageBody
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 | 
    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)

更新租戶方案

參數

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

回應

回傳: FlagCommentPublic200Response

範例

update_tenant_package 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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'
# 使用 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_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)

建立租戶使用者

參數

Name	Type	Location	Required	Description
tenantId	string	query	是

回應

返回: CreateTenantUser200Response

範例

create_tenant_user 範例

Copy

import client
from client.models.create_tenant_user200_response import CreateTenantUser200Response
from client.models.create_tenant_user_body import CreateTenantUserBody
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_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)

刪除租戶使用者

參數

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
deleteComments	string	query	否
commentDeleteMode	string	query	否

回應

傳回: FlagCommentPublic200Response

範例

delete_tenant_user 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    delete_comments = 'delete_comments_example' # str |  (可選)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (可選)
    try:
        api_response = api_instance.delete_tenant_user(tenant_id, id, 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)

取得租戶使用者

參數

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

回應

回傳: GetTenantUser200Response

範例

get_tenant_user 範例

Copy

import client
from client.models.get_tenant_user200_response import GetTenantUser200Response
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 | 
    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)

取得租戶使用者清單

參數

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

回應

回傳: GetTenantUsers200Response

範例

get_tenant_users 範例

Copy

import client
from client.models.get_tenant_users200_response import GetTenantUsers200Response
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 |  (選用)
    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)

取代租戶使用者

參數

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

回應

回傳：FlagCommentPublic200Response

範例

replace_tenant_user 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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"]
# 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 | 
    replace_tenant_user_body = client.ReplaceTenantUserBody() # ReplaceTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (optional)
    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	否

回應

回傳: FlagCommentPublic200Response

範例

send_login_link 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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)

更新租戶使用者

參數

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

回應

回傳: FlagCommentPublic200Response

範例

update_tenant_user 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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
# 若需要，取消註解以下內容以設定 API 金鑰的前綴 (例如 Bearer)
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 進入包含 API 用戶端實例的上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_user_body = client.UpdateTenantUserBody() # UpdateTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (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)

建立租戶

參數

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

回應

回傳: CreateTenant200Response

範例

create_tenant 範例

Copy

import client
from client.models.create_tenant200_response import CreateTenant200Response
from client.models.create_tenant_body import CreateTenantBody
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 | 
    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)

刪除租戶

參數

Name	Type	Location	Required
tenantId	string	query	是
id	string	path	是
sure	string	query	否

回應

回傳: FlagCommentPublic200Response

範例

delete_tenant 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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 | 
    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	是

回應

回傳: GetTenant200Response

範例

get_tenant 範例

Copy

import client
from client.models.get_tenant200_response import GetTenant200Response
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(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	Yes
meta	string	query	No
skip	number	query	No

回應

回傳: GetTenants200Response

範例

get_tenants 範例

Copy

import client
from client.models.get_tenants200_response import GetTenants200Response
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
# 根據 API 伺服器的安全性策略，客戶端必須設定驗證與授權參數。
# Examples for each auth method are provided below, use the example that
# 下面提供每種驗證方法的範例，請使用符合您驗證需求的範例。
# 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
# 使用 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 | 
    meta = 'meta_example' # str |  （選用）
    skip = 3.4 # float |  （選用）
    try:
        api_response = api_instance.get_tenants(tenant_id, 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)

更新租戶

參數

名稱	類型	位置	必要	描述
tenantId	string	query	Yes
id	string	path	Yes

回應

回傳: FlagCommentPublic200Response

範例

update_tenant 範例

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
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'
# 以 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_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	path	Yes
sizePreset	string	query	No	大小預設： "Default" (1000x1000px) 或 "CrossPlatform" (為熱門裝置建立尺寸)
urlId	string	query	No	上傳發生來源的頁面 id，用於配置

回應

回傳: UploadImageResponse

範例

upload_image 範例

Copy

import client
from client.models.size_preset import SizePreset
from client.models.upload_image_response import UploadImageResponse
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 | 
    file = None # bytearray | 
    size_preset = client.SizePreset() # SizePreset | Size preset: \"Default\" (1000x1000px) or \"CrossPlatform\" (creates sizes for popular devices) (optional)
    url_id = 'url_id_example' # str | 上傳發生的頁面 id，用於配置 (可選)
    try:
        api_response = api_instance.upload_image(tenant_id, file, 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	Yes
id	string	path	Yes

回應

回傳: GetUserBadgeProgressById200Response

範例

get_user_badge_progress_by_id 範例

Copy

import client
from client.models.get_user_badge_progress_by_id200_response import GetUserBadgeProgressById200Response
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.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	是

回應

返回: GetUserBadgeProgressById200Response

範例

get_user_badge_progress_by_user_id 範例

Copy

import client
from client.models.get_user_badge_progress_by_id200_response import GetUserBadgeProgressById200Response
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
# 如有需要，取消註解下列程式以設定 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 | 
    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)

取得使用者徽章進度清單

參數

名稱	Type	位置	必填
tenantId	string	query	是
userId	string	query	否
limit	number	query	否
skip	number	query	否

回應

回傳：GetUserBadgeProgressList200Response

範例

get_user_badge_progress_list 範例

Copy

import client
from client.models.get_user_badge_progress_list200_response import GetUserBadgeProgressList200Response
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 | 
    user_id = 'user_id_example' # str |  (可選)
    limit = 3.4 # float |  (可選)
    skip = 3.4 # float |  (可選)
    try:
        api_response = api_instance.get_user_badge_progress_list(tenant_id, 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)

建立使用者徽章

參數

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

回應

回傳：CreateUserBadge200Response

範例

create_user_badge 範例

Copy

import client
from client.models.create_user_badge200_response import CreateUserBadge200Response
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)

刪除使用者徽章

參數

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

回應

回傳：UpdateUserBadge200Response

範例

delete_user_badge 範例

Copy

import client
from client.models.update_user_badge200_response import UpdateUserBadge200Response
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.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)

取得使用者徽章

參數

名稱	類型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

回應

回傳: GetUserBadge200Response

範例

get_user_badge 範例

Copy

import client
from client.models.get_user_badge200_response import GetUserBadge200Response
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_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	query	是
userId	string	query	否
badgeId	string	query	否
type	number	query	否
displayedOnComments	boolean	query	否
limit	number	query	否
skip	number	query	否

回應

回傳: GetUserBadges200Response

範例

get_user_badges 範例

Copy

import client
from client.models.get_user_badges200_response import GetUserBadges200Response
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 |  (可選)
    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, 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)

更新使用者徽章

參數

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

回應

回傳: UpdateUserBadge200Response

範例

update_user_badge 範例

Copy

import client
from client.models.update_user_badge200_response import UpdateUserBadge200Response
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'
# 使用 API 客戶端實例進入上下文
with client.ApiClient(configuration) as api_client:
    # 建立 API 類別的實例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_user_badge_params = client.UpdateUserBadgeParams() # UpdateUserBadgeParams | 
    try:
        api_response = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
        print("The response of DefaultApi->update_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_user_badge: %s\n" % e)

取得使用者通知計數

參數

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

回應

回傳: GetUserNotificationCount200Response

範例

get_user_notification_count 範例

Copy

import client
from client.models.get_user_notification_count200_response import GetUserNotificationCount200Response
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 | 
    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)

取得使用者通知

參數

Name	Type	Location	Required
tenantId	string	query	是
pageSize	integer	query	否
afterId	string	query	否
includeContext	boolean	query	否
afterCreatedAt	integer	query	否
unreadOnly	boolean	query	否
dmOnly	boolean	query	否
noDm	boolean	query	否
includeTranslations	boolean	query	否
sso	string	query	否

回應

回傳: GetUserNotifications200Response

範例

get_user_notifications Example

Copy

import client
from client.models.get_user_notifications200_response import GetUserNotifications200Response
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 | 
    page_size = 56 # int |  (選填)
    after_id = 'after_id_example' # str |  (選填)
    include_context = True # bool |  (選填)
    after_created_at = 56 # int |  (選填)
    unread_only = True # bool |  (選填)
    dm_only = True # bool |  (選填)
    no_dm = True # bool |  (選填)
    include_translations = True # bool |  (選填)
    sso = 'sso_example' # str |  (選填)
    try:
        api_response = api_instance.get_user_notifications(tenant_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, 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)

重設使用者通知計數

參數

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

回應

回傳: ResetUserNotifications200Response

範例

reset_user_notification_count 範例

Copy

import client
from client.models.reset_user_notifications200_response import ResetUserNotifications200Response
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.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	是
afterId	string	query	否
afterCreatedAt	integer	query	否
unreadOnly	boolean	query	否
dmOnly	boolean	query	否
noDm	boolean	query	否
sso	string	query	否

回應

回傳：ResetUserNotifications200Response

範例

reset_user_notifications 範例

Copy

import client
from client.models.reset_user_notifications200_response import ResetUserNotifications200Response
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 | 
    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, 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)

更新使用者評論訂閱狀態

啟用或停用特定留言的通知。

參數

Name	Type	Location	Required
tenantId	string	query	是
notificationId	string	path	是
optedInOrOut	string	path	是
commentId	string	query	是
sso	string	query	否

回應

回傳: UpdateUserNotificationStatus200Response

範例

update_user_notification_comment_subscription_status 範例

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
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 | 
    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	否

回傳

回傳: UpdateUserNotificationStatus200Response

範例

update_user_notification_page_subscription_status 範例

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
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 | 
    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)

更新使用者通知狀態

參數

Name	Type	Location	Required
tenantId	string	query	是
notificationId	string	path	是
newStatus	string	path	是
sso	string	query	否

回應

回傳: UpdateUserNotificationStatus200Response

範例

update_user_notification_status 範例

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
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 | 
    notification_id = 'notification_id_example' # str | 
    new_status = 'new_status_example' # str | 
    sso = 'sso_example' # str |  (可選)
    try:
        api_response = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, sso=sso)
        print("The response of PublicApi->update_user_notification_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_status: %s\n" % e)

取得使用者在線狀態

參數

名稱	類型	位置	必填
tenantId	string	query	是
urlIdWS	string	query	是
userIds	string	query	是

回應

回傳: GetUserPresenceStatuses200Response

範例

get_user_presence_statuses 範例

Copy

import client
from client.models.get_user_presence_statuses200_response import GetUserPresenceStatuses200Response
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	是
urlId	string	query	是
usernameStartsWith	string	query	是
mentionGroupIds	array	query	否
sso	string	query	否

回應

回傳：SearchUsers200Response

範例

search_users 範例

Copy

import client
from client.models.search_users200_response import SearchUsers200Response
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 | 
    username_starts_with = 'username_starts_with_example' # str | 
    mention_group_ids = ['mention_group_ids_example'] # List[str] |  (可選)
    sso = 'sso_example' # str |  (可選)
    try:
        api_response = api_instance.search_users(tenant_id, url_id, username_starts_with, mention_group_ids=mention_group_ids, sso=sso)
        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)

取得使用者

參數

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

回應

回傳: GetUser200Response

範例

get_user 範例

Copy

import client
from client.models.get_user200_response import GetUser200Response
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_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	是
commentId	string	query	是
direction	string	query	是
userId	string	query	否
anonUserId	string	query	否

回應

回傳: VoteComment200Response

範例

create_vote 範例

Copy

import client
from client.models.vote_comment200_response import VoteComment200Response
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
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 | 
    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, 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	否

回應

回傳: DeleteCommentVote200Response

範例

delete_vote 範例

Copy

import client
from client.models.delete_comment_vote200_response import DeleteCommentVote200Response
from client.rest import ApiException
from pprint import pprint
# 定義主機為選用，預設為 https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 用戶端必須設定驗證與授權參數
# 以符合 API 伺服器的安全政策。
# 下方提供每種驗證方法的範例，
# 請使用符合您驗證使用情境的範例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    edit_key = 'edit_key_example' # str |  (optional)
    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	是

回應

回傳: GetVotes200Response

範例

get_votes 範例

Copy

import client
from client.models.get_votes200_response import GetVotes200Response
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 | 
    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	是
urlId	string	query	是
userId	string	query	否
anonUserId	string	query	否

回應

回傳: GetVotesForUser200Response

範例

get_votes_for_user 範例

Copy

import client
from client.models.get_votes_for_user200_response import GetVotesForUser200Response
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"]
# 如有需要，取消註解下列內容以設定前綴（例如 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 | 
    url_id = 'url_id_example' # str | 
    user_id = 'user_id_example' # str |  (可選)
    anon_user_id = 'anon_user_id_example' # str |  (可選)
    try:
        api_response = api_instance.get_votes_for_user(tenant_id, url_id, 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 儲存庫以取得貢獻指南。

語言 🇹🇼 繁體中文

開始使用

文件

彙總

稽核日誌

從評論封鎖

檢查被封鎖的評論

評論

網域設定

電子郵件範本

事件日誌

動態貼文

檢舉評論

標籤

管理員

通知計數

通知

頁面

待處理的 Webhook 事件

問卷設定

問卷結果

問卷結果彙總

SSO 使用者

訂閱

租戶每日使用量

租戶方案

租戶使用者

租戶

上傳圖片

使用者徽章進度

使用者徽章

使用者通知

使用者在線狀態

使用者搜尋

使用者

投票

FastComments Python SDK

儲存庫

安裝

PyPI

函式庫內容

公開與受保護的 API

快速開始

使用已驗證的 API (DefaultApi)

使用公開 API (PublicApi)

使用 SSO（單一登入）

常見問題

備註

廣播 ID

需求

彙總

參數

回應

範例

取得稽核日誌

參數

回應

範例

公開封鎖評論來源

參數

回應

範例

公開解除封鎖評論

參數

回應

範例

檢查已封鎖的評論

參數

回應

範例

從評論封鎖使用者

參數

回應

範例

建立公開評論

參數

回應

範例

刪除評論

參數