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

# 创建并配置 API 客户端
config = Configuration()
config.host = "https://fastcomments.com/api"

# 必填：设置你的 API 密钥（从 FastComments 仪表板获取）
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}

# 使用配置好的客户端创建 API 实例
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)

# 现在你可以进行已认证的 API 调用
try:
    # 示例：添加 SSO 用户
    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}")
    # 常见错误：
    # - 401：API 密钥丢失或无效
    # - 400：请求验证失败

使用公共 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

# 创建用户数据
user_data = SecureSSOUserData(
    user_id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# 使用你的 API 密钥（secret）创建 SSO 实例
sso = FastCommentsSSO.new_secure(
    api_secret="YOUR_API_SECRET",
    user_data=user_data
)

# 生成 SSO 令牌
sso_token = sso.create_token()

# 在前端使用此令牌或传递给 API 调用
print(f"SSO Token: {sso_token}")

对于简单 SSO（不太安全，仅用于测试）：

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" 错误：确保在创建 DefaultApi 实例之前设置 config.api_key = {"ApiKeyAuth": "YOUR_KEY"}。
错误的 API 类：对服务器端的已认证请求使用 DefaultApi，对客户端/公共请求使用 PublicApi。
导入错误：确保你从正确的模块导入：
- API 客户端：from client import ...
- SSO 实用工具：from sso import ...

注意事项

广播 ID

你会看到在某些 API 调用中需要传递 broadcast_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 等）。

参数

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

响应

返回: AggregationResponse

示例

聚合示例

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
# 定义主机是可选的，默认值为 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 | 
    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
# 定义 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 | 
    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)

在公开评论中屏蔽

参数

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

响应

返回: BlockFromCommentPublic200Response

示例

block_from_comment_public Example

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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (optional)
    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	query	是
commentId	string	path	是
sso	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->un_block_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_block_comment_public: %s\n" % e)

检查被屏蔽的评论

参数

名称	类型	位置	必填	描述
tenantId	string	query	Yes
commentIds	string	query	Yes	以逗号分隔的评论 ID 列表。
sso	string	query	No

响应

返回: 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
# 定义 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_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。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种认证方法的示例，请使用适合您认证场景的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams | 
    user_id = 'user_id_example' # str |  （可选）
    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)

创建公开评论

参数

Name	Type	Location	Required
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
# 定义主机是可选的，默认为 https://fastcomments.com
# 请参阅 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_data = client.CommentData() # CommentData | 
    session_id = 'session_id_example' # str |  (可选)
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, 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)

删除评论

参数

Name	Type	Location	Required
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
# 定义主机是可选的，默认值为 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	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入一个上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (可选)
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, edit_key=edit_key, sso=sso)
        print("The response of PublicApi->delete_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_public: %s\n" % e)

删除评论投票

参数

名称	类型	位置	是否必填
tenantId	string	path	是
commentId	string	path	是
voteId	string	path	是
urlId	string	query	是
broadcastId	string	query	是
editKey	string	query	否
sso	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 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
# 定义主机是可选的，默认值为 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_comment(tenant_id, id)
        print("The response of DefaultApi->get_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comment: %s\n" % e)

获取评论文本

参数

名称	类型	位置	是否必需
tenantId	string	path	是
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 客户端实例进入上下文
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)

获取评论投票用户名称

参数

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

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 参见 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入一个上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    dir = 56 # int | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, sso=sso)
        print("The response of PublicApi->get_comment_vote_user_names:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_vote_user_names: %s\n" % e)

获取评论列表

参数

名称	类型	位置	必需
tenantId	string	query	是
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 服务器的安全策略配置身份验证和授权参数。
# 以下提供了每种认证方法的示例，请使用满足您认证用例的示例。
# 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 | 
    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
# 定义主机是可选的，默认值为 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	是
commentId	string	path	是
broadcastId	string	query	是
sso	string	query	否

响应

返回: LockComment200Response

示例

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"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->lock_comment: %s\n" % e)

置顶评论

参数

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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->pin_comment: %s\n" % e)

保存评论

参数

名称	类型	位置	必填
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 客户端实例进入上下文
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)

批量保存评论

参数

Name	Type	Location	Required
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
# 定义主机是可选的，默认值为 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_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)

设置评论文本

参数

名称	类型	位置	必填
tenantId	string	路径	是
commentId	string	路径	是
broadcastId	string	查询	是
editKey	string	查询	否
sso	string	查询	否

响应

返回：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
# 定义主机是可选的，默认为 https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
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 | 
    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)

取消从评论中屏蔽用户

参数

名称	类型	位置	必需
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用适合您用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面的行以设置 API 密钥的前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams | 
    user_id = 'user_id_example' # str |  （可选）
    anon_user_id = 'anon_user_id_example' # str |  （可选）
    try:
        api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->un_block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_block_user_from_comment: %s\n" % e)

取消标记评论

参数

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

响应

返回: FlagComment200Response

示例

un_flag_comment 示例

Copy

import client
from client.models.flag_comment200_response import FlagComment200Response
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 | 
    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	路径	是
commentId	string	路径	是
broadcastId	string	查询	是
sso	string	查询	否

响应

返回: 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"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_lock_comment: %s\n" % e)

取消置顶评论

参数

名称	类型	位置	必需
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
sso	string	query	No

响应

返回: PinComment200Response

示例

un_pin_comment 示例

Copy

import client
from client.models.pin_comment200_response import PinComment200Response
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建一个 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_pin_comment: %s\n" % e)

更新评论

参数

名称	类型	位置	必需
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
# 定义 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 | 
    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
# 定义主机是可选的，默认为 https://fastcomments.com
# 请参阅 configuration.py 以获取所有支持的配置参数的列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    vote_body_params = client.VoteBodyParams() # VoteBodyParams | 
    session_id = 'session_id_example' # str |  （可选）
    sso = 'sso_example' # str |  （可选）
    try:
        api_response = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, 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	query	是

响应

返回：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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 请参阅 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用适合您使用场景的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    add_domain_config_params = client.AddDomainConfigParams() # AddDomainConfigParams | 
    try:
        api_response = api_instance.add_domain_config(tenant_id, add_domain_config_params)
        print("The response of DefaultApi->add_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_domain_config: %s\n" % e)

删除域配置

参数

Name	Type	Location	Required	Description
tenantId	string	查询	是
domain	string	路径	是

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 为每种认证方法提供了示例，请使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 若需要，为 API 密钥设置前缀（例如 Bearer），取消注释下面一行
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.delete_domain_config(tenant_id, domain)
        print("The response of DefaultApi->delete_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_domain_config: %s\n" % e)

获取域配置

参数

Name	Type	Location	Required	Description
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
# 设置 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 | 
    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 客户端实例进入上下文
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)

替换域配置

参数

名称	类型	位置	必需	描述
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
# 定义主机是可选的，默认为 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 | 
    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)

创建邮件模板

参数

名称	类型	位置	必需	描述
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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方为每种认证方法提供示例，
# 请使用满足您认证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下面注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_email_template_body = client.CreateEmailTemplateBody() # CreateEmailTemplateBody | 
    try:
        api_response = api_instance.create_email_template(tenant_id, create_email_template_body)
        print("The response of DefaultApi->create_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_email_template: %s\n" % e)

删除邮件模板

参数

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
# 定义 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 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_email_template(tenant_id, id)
        print("The response of DefaultApi->delete_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template: %s\n" % e)

删除邮件模板渲染错误

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
errorId	string	path	是

响应

返回: 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
# 定义主机是可选的，默认值为 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 | 
    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)

获取邮件模板

参数

Name	Type	Location	Required	Description
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
# 定义主机是可选的，默认值为 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_email_template(tenant_id, id)
        print("The response of DefaultApi->get_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template: %s\n" % e)

获取邮件模板定义

参数

Name	Type	Location	Required	Description
tenantId	string	query	Yes

响应

返回: 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
# 定义主机是可选的，默认为 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	Yes
id	string	path	Yes
skip	number	query	No

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 参见 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种身份验证方法的示例，请使用适合您身份验证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    skip = 3.4 # float |  (可选)
    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	否

Response

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 查看 configuration.py 获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下面为每种认证方法提供示例，请使用
# 能满足您认证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面的行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  （可选）
    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)

渲染邮件模板

参数

名称	类型	位置	必需	描述
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
# 定义 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 | 
    render_email_template_body = client.RenderEmailTemplateBody() # RenderEmailTemplateBody | 
    locale = 'locale_example' # str |  （可选）
    try:
        api_response = api_instance.render_email_template(tenant_id, render_email_template_body, locale=locale)
        print("The response of DefaultApi->render_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->render_email_template: %s\n" % e)

更新邮件模板

参数

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

响应

返回: 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
# 定义主机是可选的，默认值为 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
# 指定主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    try:
        api_response = api_instance.get_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

参数

名称	类型	位置	必填
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    try:
        api_response = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
        print("The response of PublicApi->get_global_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_global_event_log: %s\n" % e)

创建动态帖子

参数

名称	类型	位置	必需
tenantId	string	query	是
broadcastId	string	query	否
isLive	boolean	query	否
doSpamCheck	boolean	query	否
skipDupCheck	boolean	query	否

响应

返回: 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"]
# 如有需要，取消下面的注释以设置 API 密钥的前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (可选)
    is_live = True # bool |  (可选)
    do_spam_check = True # bool |  (可选)
    skip_dup_check = True # bool |  (可选)
    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)

创建公开动态帖子

参数

Name	Type	Location	Required
tenantId	string	路径	是
broadcastId	string	查询	否
sso	string	查询	否

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 请参阅 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (可选)
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.delete_feed_post_public(tenant_id, post_id, 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
# 定义主机是可选的，默认为 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 | 
    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

参数

Name	Type	Location	Required
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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (可选)
    limit = 56 # int |  (可选)
    tags = ['tags_example'] # List[str] |  (可选)
    sso = 'sso_example' # str |  (可选)
    is_crawler = True # bool |  (可选)
    include_user_info = True # bool |  (可选)
    try:
        api_response = api_instance.get_feed_posts_public(tenant_id, 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)

获取动态帖子统计

参数

名称	类型	位置	必需
tenantId	string	path	是
postIds	array	query	是
sso	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.get_feed_posts_stats(tenant_id, post_ids, sso=sso)
        print("The response of PublicApi->get_feed_posts_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_stats: %s\n" % e)

获取用户公开反应

参数

名称	类型	位置	必填
tenantId	string	path	是
postIds	array	query	否
sso	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] |  (可选)
    sso = 'sso_example' # str |  (可选)
    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	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数的列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    react_body_params = client.ReactBodyParams() # ReactBodyParams | 
    is_undo = True # bool |  (可选)
    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)

更新动态帖子

参数

名称	类型	位置	必需	描述
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
# 定义 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 | 
    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 |  （可选）
    sso = 'sso_example' # str |  （可选）
    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	是
commentId	string	path	是
isFlagged	boolean	query	是
sso	string	query	否

响应

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

添加标签

参数

名称	类型	位置	必需	描述
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
# 指定主机是可选的，默认使用 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_hash_tag_body = client.CreateHashTagBody() # CreateHashTagBody |  (可选)
    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)

批量添加标签

参数

名称	类型	位置	必需	描述
tenantId	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 以下为每种认证方法提供示例，请使用
# 适合您用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，可取消注释下面行为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str |  （可选）
    bulk_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
# 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"
)
# 客户端必须配置身份验证和授权参数
# 以符合 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)
    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)

获取标签

参数

Name	Type	Location	Required	Description
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供每种认证方法的示例，
# 使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 3.4 # float |  (可选)
    try:
        api_response = api_instance.get_hash_tags(tenant_id, page=page)
        print("The response of DefaultApi->get_hash_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_hash_tags: %s\n" % e)

部分更新标签

参数

名称	类型	位置	必需	描述
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
# 定义主机是可选的，默认值为 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)
    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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置认证和授权参数。
# 每种认证方法的示例在下面提供，使用满足您认证用例的示例。
# 配置 API 密钥授权: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面的行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的一个实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_moderator_body = client.CreateModeratorBody() # CreateModeratorBody | 
    try:
        api_response = api_instance.create_moderator(tenant_id, create_moderator_body)
        print("The response of DefaultApi->create_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_moderator: %s\n" % e)

删除版主

参数

Name	Type	Location	Required
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用满足您使用场景的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    send_email = 'send_email_example' # str |  (可选)
    try:
        api_response = api_instance.delete_moderator(tenant_id, id, send_email=send_email)
        print("The response of DefaultApi->delete_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_moderator: %s\n" % e)

获取版主

参数

名称	类型	位置	是否必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: GetModerator200Response

示例

get_moderator 示例

Copy

import client
from client.models.get_moderator200_response import GetModerator200Response
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 | 
    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 服务器的安全策略。
# 下方提供了每种认证方法的示例，
# 使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如果需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (可选)
    try:
        api_response = api_instance.get_moderators(tenant_id, skip=skip)
        print("The response of DefaultApi->get_moderators:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderators: %s\n" % e)

发送邀请

参数

名称	类型	位置	必需
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 服务器的安全策略配置身份验证和授权参数。
# 每种身份验证方法的示例在下面提供，请使用适合您用例的示例。
# 配置 API 密钥授权: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    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)

更新版主

参数

名称	类型	位置	必需	描述
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'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_moderator_body = client.UpdateModeratorBody() # UpdateModeratorBody | 
    try:
        api_response = api_instance.update_moderator(tenant_id, id, update_moderator_body)
        print("The response of DefaultApi->update_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_moderator: %s\n" % e)

删除通知计数

参数

Name	Type	Location	Required	Description
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 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种验证方法的示例，请使用符合您验证需求的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面内容为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_notification_count(tenant_id, id)
        print("The response of DefaultApi->delete_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_notification_count: %s\n" % e)

获取缓存的通知计数

参数

名称	类型	位置	必需	描述
tenantId	string	查询	是
id	string	路径	是

响应

返回: 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
# 定义主机是可选的，默认值为 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_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	是
userId	string	query	否
urlId	string	query	否
fromCommentId	string	query	否
viewed	boolean	query	否
type	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 以下提供了每种身份验证方法的示例，请使用适合您身份验证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (可选)
    url_id = 'url_id_example' # str |  (可选)
    from_comment_id = 'from_comment_id_example' # str |  (可选)
    viewed = True # bool |  (可选)
    type = 'type_example' # str |  (可选)
    try:
        api_response = api_instance.get_notification_count(tenant_id, 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)

获取通知

参数

名称	类型	位置	必需
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
# 定义主机是可选的，默认值为 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 |  (可选)
    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)

更新通知

参数

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

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持的配置参数，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用满足您用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_notification_body = client.UpdateNotificationBody() # UpdateNotificationBody | 
    user_id = 'user_id_example' # str |  (可选)
    try:
        api_response = api_instance.update_notification(tenant_id, id, update_notification_body, user_id=user_id)
        print("The response of DefaultApi->update_notification:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_notification: %s\n" % e)

添加页面

参数

名称	类型	位置	必填	描述
tenantId	string	query	是

响应

返回: AddPageAPIResponse

示例

add_page 示例

Copy

import client
from client.models.add_page_api_response import AddPageAPIResponse
from client.models.create_api_page_data import CreateAPIPageData
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用满足您身份验证用例的示例。
# 配置 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_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	query	是
id	string	path	是

响应

返回： DeletePageAPIResponse

示例

delete_page 示例

Copy

import client
from client.models.delete_page_api_response import DeletePageAPIResponse
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置认证和授权参数
# 并根据 API 服务器的安全策略进行配置。
# 下面提供了每种身份验证方法的示例，使用
# 满足您身份验证使用场景的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用符合您用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_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)

获取页面列表

参数

Name	Type	Location	Required	Description
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
# 定义主机为可选，默认为 https://fastcomments.com
# 有关所有支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置认证和授权参数。
# 以下为每种认证方法的示例，请使用满足您认证用例的示例。
# 配置 API 密钥授权: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如果需要，取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 在上下文中使用 API 客户端实例
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_pages(tenant_id)
        print("The response of DefaultApi->get_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pages: %s\n" % e)

部分更新页面

参数

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

响应

返回: PatchPageAPIResponse

示例

patch_page 示例

Copy

import client
from client.models.patch_page_api_response import PatchPageAPIResponse
from client.models.update_api_page_data import UpdateAPIPageData
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用满足您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_api_page_data = client.UpdateAPIPageData() # UpdateAPIPageData | 
    try:
        api_response = api_instance.patch_page(tenant_id, id, update_api_page_data)
        print("The response of DefaultApi->patch_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_page: %s\n" % e)

删除待处理的 Webhook 事件

参数

名称	类型	位置	必填	描述
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种身份验证方法的示例，请使用满足您用例的示例。
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_pending_webhook_event(tenant_id, id)
        print("The response of DefaultApi->delete_pending_webhook_event:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_pending_webhook_event: %s\n" % e)

获取待处理 Webhook 事件计数

参数

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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置认证和授权参数
# 以符合 API 服务器的安全策略。
# 下面提供了每种认证方法的示例，请使用
# 符合您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面的内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (可选)
    external_id = 'external_id_example' # str |  (可选)
    event_type = 'event_type_example' # str |  (可选)
    type = 'type_example' # str |  (可选)
    domain = 'domain_example' # str |  (可选)
    attempt_count_gt = 3.4 # float |  (可选)
    try:
        api_response = api_instance.get_pending_webhook_event_count(tenant_id, comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt)
        print("The response of DefaultApi->get_pending_webhook_event_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_event_count: %s\n" % e)

获取待处理的 Webhook 事件

参数

名称	类型	位置	必需
tenantId	string	query	是
commentId	string	query	否
externalId	string	query	否
eventType	string	query	否
type	string	query	否
domain	string	query	否
attemptCountGT	number	query	否
skip	number	query	否

响应

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

创建问题配置

参数

名称	类型	位置	必需	描述
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
# 定义主机是可选的，默认为 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 | 
    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)

删除问题配置

参数

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

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 请参阅 configuration.py 获取所有受支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 每种认证方法的示例在下面提供，请使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消下方注释以设置 API 密钥前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_config(tenant_id, id)
        print("The response of DefaultApi->delete_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_config: %s\n" % e)

获取问题配置

参数

Name	Type	Location	Required	Description
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
# 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_config(tenant_id, id)
        print("The response of DefaultApi->get_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_config: %s\n" % e)

获取问题配置列表

参数

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

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下面为每种身份验证方法提供了示例，请使用满足您身份验证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如果需要，取消下面的注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  （可选）
    try:
        api_response = api_instance.get_question_configs(tenant_id, skip=skip)
        print("The response of DefaultApi->get_question_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_configs: %s\n" % e)

更新问题配置

参数

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

创建问题结果

参数

名称	类型	位置	必填	描述
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 服务器的安全策略。
# 下方提供了每种身份验证方法的示例，请使用
# 满足您认证用例的示例。
# 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_question_result_body = client.CreateQuestionResultBody() # CreateQuestionResultBody | 
    try:
        api_response = api_instance.create_question_result(tenant_id, create_question_result_body)
        print("The response of DefaultApi->create_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_result: %s\n" % e)

删除问题结果

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 请参阅 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面为每种身份验证方法提供了示例，请使用满足你使用场景的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释以下行以设置 API 密钥前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_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

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供了每种身份验证方法的示例，请使用满足您用例的示例
# 满足您的身份验证用例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下方注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_result(tenant_id, id)
        print("The response of DefaultApi->get_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_result: %s\n" % e)

获取问题结果列表

参数

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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 以下为每种身份验证方法提供示例，请使用
# 适合您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str |  (可选)
    user_id = 'user_id_example' # str |  (可选)
    start_date = 'start_date_example' # str |  (可选)
    question_id = 'question_id_example' # str |  (可选)
    question_ids = 'question_ids_example' # str |  (可选)
    skip = 3.4 # float |  (可选)
    try:
        api_response = api_instance.get_question_results(tenant_id, 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)

更新问题结果

参数

名称	类型	位置	必填	描述
tenantId	string	query	是
id	string	path	是

响应

返回：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
# 定义主机是可选的，默认为 https://fastcomments.com
# 请参阅 configuration.py 以获取所有受支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供了每种身份验证方法的示例，
# 请使用满足您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释下面行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_result_body = client.UpdateQuestionResultBody() # UpdateQuestionResultBody | 
    try:
        api_response = api_instance.update_question_result(tenant_id, id, update_question_result_body)
        print("The response of DefaultApi->update_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_result: %s\n" % e)

聚合问题结果

参数

名称	类型	位置	必需
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
# 定义 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 | 
    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	是
forceRecalculate	boolean	query	否

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种认证方法的示例，请使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有必要，取消注释以下行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 在包含 API 客户端实例的上下文中运行
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_aggregate_question_results_request = client.BulkAggregateQuestionResultsRequest() # BulkAggregateQuestionResultsRequest | 
    force_recalculate = True # bool |  （可选）
    try:
        api_response = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, force_recalculate=force_recalculate)
        print("The response of DefaultApi->bulk_aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->bulk_aggregate_question_results: %s\n" % e)

将评论与问题结果合并

参数

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

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 每种认证方法的示例在下面提供，使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如果需要，取消注释下行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  (可选)
    question_ids = ['question_ids_example'] # List[str] |  (可选)
    url_id = 'url_id_example' # str |  (可选)
    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
# 定义主机是可选的，默认值为 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_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	query	Yes
id	string	path	Yes
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

响应

返回: 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
# 定义主机是可选的，默认为 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 | 
    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
# 定义主机是可选的，默认为 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 | 
    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
# 可选地定义主机，默认为 https://fastcomments.com
# 有关所有受支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置认证和授权参数。
# 每种认证方法的示例在下面提供，使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下面的注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_id(tenant_id, id)
        print("The response of DefaultApi->get_sso_user_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_id: %s\n" % e)

获取 SSO 用户

参数

名称	类型	位置	必需	描述
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供了每种认证方法的示例，请使用
# 满足您认证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 56 # int |  (可选)
    try:
        api_response = api_instance.get_sso_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_sso_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_users: %s\n" % e)

部分更新 SSO 用户

参数

名称	类型	位置	必填
tenantId	string	查询	是
id	string	路径	是
updateComments	boolean	查询	否

响应

返回: 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 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下面的注释以设置 API 密钥的前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  （可选）
    try:
        api_response = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->patch_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_sso_user: %s\n" % e)

替换 SSO 用户

参数

Name	Type	Location	Required
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 服务器的安全策略配置认证和授权参数。
# 下面为每种认证方法提供示例，请使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  (可选)
    try:
        api_response = api_instance.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)

创建订阅

参数

Name	Type	Location	Required	Description
tenantId	string	查询	是

响应

返回: CreateSubscriptionAPIResponse

示例

create_subscription 示例

Copy

import client
from client.models.create_api_user_subscription_data import CreateAPIUserSubscriptionData
from client.models.create_subscription_api_response import CreateSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有受支持配置参数的列表，请参阅 configuration.py。
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用满足您身份验证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如果需要，请取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 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)

删除订阅

参数

名称	类型	位置	必需
tenantId	string	查询	是
id	string	路径	是
userId	string	查询	否

响应

返回: DeleteSubscriptionAPIResponse

示例

delete_subscription 示例

Copy

import client
from client.models.delete_subscription_api_response import DeleteSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下面为每种身份验证方法提供了示例，请使用满足您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如果需要，请取消下面的注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (可选)
    try:
        api_response = api_instance.delete_subscription(tenant_id, id, user_id=user_id)
        print("The response of DefaultApi->delete_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_subscription: %s\n" % e)

获取订阅

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
userId	string	query	否

响应

返回: GetSubscriptionsAPIResponse

示例

get_subscriptions 示例

Copy

import client
from client.models.get_subscriptions_api_response import GetSubscriptionsAPIResponse
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方为每种身份验证方法提供了示例，请使用
# 满足您认证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消下面的注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 在上下文中使用 API 客户端实例
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (可选)
    try:
        api_response = api_instance.get_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)

获取租户日使用量

参数

Name	Type	Location	Required
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
# 定义主机是可选的，默认值为 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)

创建租户套餐

参数

Name	Type	Location	Required	Description
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
# 定义主机是可选的，默认为 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_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
# Defining the host is optional and defaults to 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.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)

获取租户套餐

参数

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

响应

返回: 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
# 定义主机是可选的，默认值为 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 | 
    skip = 3.4 # float |  (可选)
    try:
        api_response = api_instance.get_tenant_packages(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_packages: %s\n" % e)

替换租户套餐

参数

名称	类型	位置	必需	描述
tenantId	string	query	是
id	string	path	是

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持配置参数的列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置认证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供了每种认证方法的示例，请使用适合您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，可取消注释下面的行以设置前缀（例如 Bearer）用于 API 密钥
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    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	查询	是
id	string	路径	是

响应

返回: 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
# 定义主机是可选的，缺省为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 每种认证方法的示例在下方提供，使用满足您认证场景的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_package_body = client.UpdateTenantPackageBody() # UpdateTenantPackageBody | 
    try:
        api_response = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
        print("The response of DefaultApi->update_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_package: %s\n" % e)

创建租户用户

参数

名称	类型	位置	必需	描述
tenantId	string	query	是

响应

返回：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
# 定义主机是可选的，默认值为 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_tenant_user_body = client.CreateTenantUserBody() # CreateTenantUserBody | 
    try:
        api_response = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
        print("The response of DefaultApi->create_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_user: %s\n" % e)

删除租户用户

参数

名称	类型	位置	必需
tenantId	string	query	是
id	string	path	是
deleteComments	string	query	否
commentDeleteMode	string	query	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 查看 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种认证方法的示例，请使用符合您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如需，取消注释下方以为 API 密钥设置前缀（例如：Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = 'delete_comments_example' # str |  (可选)
    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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 以下为每种身份验证方法提供示例，
# 请使用满足您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_user(tenant_id, id)
        print("The response of DefaultApi->get_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_user: %s\n" % e)

获取租户用户列表

参数

名称	类型	位置	必填	描述
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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供了每种认证方法的示例，
# 请使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (可选)
    try:
        api_response = api_instance.get_tenant_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 服务器的安全策略配置认证和授权参数。
# 下方提供了每种认证方法的示例，请使用适合您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 进入包含 API 客户端实例的上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_user_body = client.ReplaceTenantUserBody() # ReplaceTenantUserBody | 
    update_comments = 'update_comments_example' # str |  （可选）
    try:
        api_response = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->replace_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_user: %s\n" % e)

参数

名称	类型	位置	必填
tenantId	string	query	是
id	string	path	是
redirectURL	string	query	否

响应

返回: 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
# 定义 host 是可选的，默认值为 https://fastcomments.com
# 请参阅 configuration.py 以查看所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置认证和授权参数。
# 下方提供了每种认证方法的示例，请使用适合您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    redirect_url = 'redirect_url_example' # str |  (可选)
    try:
        api_response = api_instance.send_login_link(tenant_id, id, redirect_url=redirect_url)
        print("The response of DefaultApi->send_login_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_login_link: %s\n" % e)

更新租户用户

参数

名称	类型	位置	必需
tenantId	string	查询	是
id	string	路径	是
updateComments	string	查询	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种身份验证方法的示例，请使用符合您身份验证用例的示例。
# 配置 API 密钥授权: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_user_body = client.UpdateTenantUserBody() # UpdateTenantUserBody | 
    update_comments = 'update_comments_example' # str |  （可选）
    try:
        api_response = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->update_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_user: %s\n" % e)

创建租户

参数

名称	类型	位置	必需	描述
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
# 定义主机是可选的，默认为 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_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	查询	是
id	string	路径	是
sure	string	查询	否

响应

返回：FlagCommentPublic200Response

示例

delete_tenant 示例

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 服务器的安全策略。
# 下方为每种认证方法提供示例，
# 使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    sure = 'sure_example' # str |  （可选）
    try:
        api_response = api_instance.delete_tenant(tenant_id, id, sure=sure)
        print("The response of DefaultApi->delete_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant: %s\n" % e)

获取租户

参数

Name	Type	Location	Required	Description
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
# 定义主机是可选的，默认为 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(tenant_id, id)
        print("The response of DefaultApi->get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant: %s\n" % e)

获取租户列表

参数

名称	类型	位置	必需
tenantId	string	query	是
meta	string	query	否
skip	number	query	否

响应

返回：GetTenants200Response

示例

get_tenants 示例

Copy

import client
from client.models.get_tenants200_response import GetTenants200Response
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 | 
    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	是
id	string	path	是

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方提供了每种认证方法的示例，
# 请使用满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释下面以设置 API 密钥的前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_body = client.UpdateTenantBody() # UpdateTenantBody | 
    try:
        api_response = api_instance.update_tenant(tenant_id, id, update_tenant_body)
        print("The response of DefaultApi->update_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant: %s\n" % e)

上传图片

Upload and resize an image

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
sizePreset	string	query	No	尺寸预设: "Default" (1000x1000px) 或 "CrossPlatform" (为常用设备创建尺寸)
urlId	string	query	No	上传发生的页面 id，用于配置

Response

返回: UploadImageResponse

Example

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
# 定义主机是可选的，默认为 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 | 尺寸预设: \"Default\" (1000x1000px) 或 \"CrossPlatform\" (为常用设备创建尺寸) (可选)
    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	是
id	string	path	是

响应

返回：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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下面提供了每种身份验证方法的示例，请使用适合您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_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 获取用户徽章进度

参数

名称	类型	位置	必需	描述
tenantId	string	查询	是
userId	string	路径	是

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 以下为每种身份验证方法提供示例，请使用
# 满足您身份验证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
        print("The response of DefaultApi->get_user_badge_progress_by_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_user_id: %s\n" % e)

获取用户徽章进度列表

参数

名称	类型	位置	必需
tenantId	string	query	是
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 服务器的安全策略配置身份验证和授权参数。
# 下面提供了每种身份验证方法的示例，请使用适合您用例的示例。
#
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有必要，取消注释下面行以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  （可选）
    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
# 定义主机是可选的，默认值为 https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
# 查看 configuration.py 以获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 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"]
# 如有需要，取消注释下面以为 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_user_badge_params = client.CreateUserBadgeParams() # CreateUserBadgeParams | 
    try:
        api_response = api_instance.create_user_badge(tenant_id, create_user_badge_params)
        print("The response of DefaultApi->create_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_user_badge: %s\n" % e)

删除用户徽章

参数

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

响应

返回: 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
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# 下方为每种认证方法提供示例，
# 请使用满足您认证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有受支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方为每种认证方法提供了示例，请使用
# 满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端的实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge(tenant_id, id)
        print("The response of DefaultApi->get_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge: %s\n" % e)

获取用户徽章列表

参数

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
badgeId	string	query	No
type	number	query	No
displayedOnComments	boolean	query	No
limit	number	query	No
skip	number	query	No

响应

返回: 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 请参阅 configuration.py 获取所有支持的配置参数列表。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数
# 下方提供每种认证方法的示例，
# 请使用满足您认证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，可取消注释下面内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (可选)
    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
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.get_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->get_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notification_count: %s\n" % e)

获取用户通知

参数

名称	类型	位置	必需
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 示例

Copy

import client
from client.models.get_user_notifications200_response import GetUserNotifications200Response
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 | 
    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
# 定义 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 | 
    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)

重置用户通知

参数

Name	Type	Location	Required
tenantId	string	查询	是
afterId	string	查询	否
afterCreatedAt	integer	查询	否
unreadOnly	boolean	查询	否
dmOnly	boolean	查询	否
noDm	boolean	查询	否
sso	string	查询	否

响应

返回: 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (可选)
    after_created_at = 56 # int |  (可选)
    unread_only = True # bool |  (可选)
    dm_only = True # bool |  (可选)
    no_dm = True # bool |  (可选)
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.reset_user_notifications(tenant_id, 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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    opted_in_or_out = 'opted_in_or_out_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (可选)
    try:
        api_response = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, sso=sso)
        print("The response of PublicApi->update_user_notification_comment_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_comment_subscription_status: %s\n" % e)

更新用户页面订阅状态

启用或禁用页面的通知。当用户订阅页面时，会创建通知用于新的根评论，并且还会

参数

名称	类型	位置	必需
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
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有支持的配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    url = 'url_example' # str | 
    page_title = 'page_title_example' # str | 
    subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example' # str | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, sso=sso)
        print("The response of PublicApi->update_user_notification_page_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_page_subscription_status: %s\n" % e)

更新用户通知状态

参数

名称	类型	位置	必需
tenantId	string	查询	是
notificationId	string	路径	是
newStatus	string	路径	是
sso	string	查询	否

响应

返回：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
# 定义主机是可选的，默认为 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)

获取用户在线状态

参数

Name	Type	Location	Required
tenantId	string	query	Yes
urlIdWS	string	query	Yes
userIds	string	query	Yes

响应

返回: 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
# 定义主机是可选的，默认为 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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参见 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须配置身份验证和授权参数
# 以符合 API 服务器的安全策略。
# 下方为每种认证方法提供了示例，请使用
# 能满足您认证用例的示例。
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，请取消注释以下内容以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user(tenant_id, id)
        print("The response of DefaultApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user: %s\n" % e)

创建投票

参数

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
# 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 | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.create_vote(tenant_id, comment_id, direction, 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)

删除投票

参数

名称	类型	位置	必需
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
# 定义 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 | 
    edit_key = 'edit_key_example' # str |  （可选）
    try:
        api_response = api_instance.delete_vote(tenant_id, id, edit_key=edit_key)
        print("The response of DefaultApi->delete_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_vote: %s\n" % e)

获取投票

参数

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

返回: GetVotes200Response

示例

get_votes 示例

Copy

import client
from client.models.get_votes200_response import GetVotes200Response
from client.rest import ApiException
from pprint import pprint
# 定义主机是可选的，默认值为 https://fastcomments.com
# 有关所有受支持配置参数的列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 每种身份验证方法的示例在下面提供，使用满足您身份验证用例的示例。
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释下面以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的一个实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_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
# 定义主机是可选的，默认为 https://fastcomments.com
# 有关所有支持的配置参数列表，请参阅 configuration.py。
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# 客户端必须根据 API 服务器的安全策略配置身份验证和授权参数。
# 下方提供了每种认证方法的示例，请使用适合您认证用例的示例。
 
# 配置 API 密钥授权：api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# 如有需要，取消注释以为 API 密钥设置前缀（例如 Bearer）
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 使用 API 客户端实例进入上下文
with client.ApiClient(configuration) as api_client:
    # 创建 API 类的实例
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id = 'user_id_example' # str |  (可选)
    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 和 PublicApi。DefaultApi 包含需要您的 API 密钥的方法，PublicApi 包含可以直接从浏览器/移动设备等在无身份验证情况下调用的 API。

快速开始

使用已认证的 API (DefaultApi)

使用公共 API (PublicApi)

使用 SSO（单点登录）

常见问题

注意事项

广播 ID

要求

聚合

参数

响应

示例

获取审计日志

参数

响应

示例

在公开评论中屏蔽

参数

响应

示例

在公开评论中取消屏蔽

参数

响应

示例

检查被屏蔽的评论

参数

响应

示例

从评论中屏蔽用户

参数

响应

示例

创建公开评论

参数

响应

示例

删除评论

对于 API 客户端，有两个类，`DefaultApi` 和 `PublicApi`。`DefaultApi` 包含需要您的 API 密钥的方法，`PublicApi` 包含可以直接从浏览器/移动设备等在无身份验证情况下调用的 API。