FastComments Nim 開發套件

這是 FastComments 的官方 Nim SDK。

FastComments API 的官方 Nim SDK

儲存庫

需求

Nim >= 1.6.0
nimcrypto >= 0.5.4

安裝

使用 Nimble

nimble install fastcomments

從原始碼建構

nimble build

程式庫內容

此程式庫包含生成的 API 客戶端及 SSO 工具，可讓使用 API 更加便利。

API 客戶端函式庫文件

公開與受保護的 API

對於 API 客戶端，有三個 API 模組，api_default、api_public 與 api_moderation。api_default 包含需要您的 API 金鑰的方法，api_public 包含可直接從瀏覽器/行動裝置等無需驗證即可呼叫的 API。api_moderation 模組則提供給管理員儀表板使用的方法。

api_moderation 模組提供廣泛的即時與快速審核 API。每個 api_moderation 方法都接受 sso 參數，並可透過 SSO 或 FastComments.com 的會話 Cookie 進行驗證。

快速開始

使用已驗證的 API（DefaultAPI）

重要：已驗證的端點需要將您的 API 金鑰設定為 x-api-key 標頭。

import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

# Make authenticated API calls.
# Required parameters (and the request body) are positional; optional
# parameters are passed via the operation's options object.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

使用公共 API（PublicAPI）

公共端點不需要驗證：

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Make public API calls.
# tenantId and urlId are required (positional); everything else is optional.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

使用審核 API（ModerationAPI）

審核端點為審核者儀表板提供功能，並以執行中的審核者的 SSO 令牌進行驗證：

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# List comments in the moderation dashboard.
# This operation has no required parameters, so everything is optional.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

if response.isSome:
  let resp = response.get()
  echo "Found ", resp.comments.len, " comments"

常見問題

401 認證錯誤：確保在發送 DefaultAPI 請求之前，在 HttpClient 上設置 x-api-key 標頭：client.headers["x-api-key"] = "your-api-key"
錯誤的 API 類別：對於伺服器端已驗證的請求使用 api_default，對於客戶端/公共請求使用 api_public，以及對於審核者儀表板請求使用 api_moderation。

發出 API 呼叫

All API methods in this SDK return tuples of (Option[ResponseType], Response). The first element contains the parsed response if successful, and the second element is the raw HTTP response.

Required parameters and the request body are passed positionally. The remaining optional parameters are collected into a single Api<Operation>Options object, which is the last argument. Operations with no optional parameters take no options object.

範例：取得評論

import httpclient
import options
import fastcomments
import fastcomments/apis/api_default

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

if httpResponse.code == Http200:
  if response.isSome:
    let resp = response.get()
    if resp.comments.isSome:
      echo "Found ", resp.comments.get().len, " comments"

備註

廣播 ID

你會看到在某些 API 呼叫中需要傳入一個 broadcastId。當你接收到事件時，你會拿回這個 ID，因此如果你打算在用戶端採用樂觀更新（在用戶端樂觀地套用變更），你就可以據此忽略該事件（你可能會想這樣做，因為它提供了最佳的使用體驗）。在這裡傳入一個 UUID。這個 ID 應該夠獨特，以免在同一個瀏覽器會話中出現兩次。

SSO (單一登入)

關於 SSO 的範例，請見下方。

SSO 使用方式

簡易 SSO

import fastcomments/sso

let user = newSimpleSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()

echo "SSO Token: ", token

安全 SSO

import fastcomments/sso

let user = newSecureSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  username = "johndoe",
  avatar = "https://example.com/avatar.jpg"
)

let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()

echo "Secure SSO Token: ", token

fastcomments 文件

Documentation for API Endpoints

All URIs are relative to https://fastcomments.com

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

彙總

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

參數

名稱	類型	必填
tenantId	string	是
aggregationRequest	AggregationRequest	否
options	AggregateOptions	否

回應

回傳: Option[AggregateResponse]

範例

彙總範例

Copy

let (aggResp, httpResp) = client.aggregate(tenantId = "my-tenant-123", aggregationRequest = AggregationRequest(), options = AggregateOptions())
if aggResp.isSome:
  let response = aggResp.get()
  echo response
echo httpResp

取得稽核日誌

參數

名稱	類型	必填	說明
tenantId	string	Yes
options	GetAuditLogsOptions	No

回應

返回：Option[GetAuditLogsResponse]

範例

getAuditLogs 範例

Copy

let (auditOpt, httpResp) = client.getAuditLogs(tenantId = "my-tenant-123", options = GetAuditLogsOptions())
if auditOpt.isSome:
  let audit = auditOpt.get()
  echo audit

公開登出

回應

返回：Option[APIEmptyResponse]

範例

logoutPublic 範例

Copy

let (responseOpt, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", userId = "user-456")
if responseOpt.isSome:
  let emptyResponse = responseOpt.get()

從評論封鎖

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

回應

Returns: Option[BlockSuccess]

範例

blockFromCommentPublic 範例

Copy

let (blockOpt, httpResp) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if blockOpt.isSome:
  let block = blockOpt.get()

取消封鎖評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
publicBlockFromCommentParams	PublicBlockFromCommentParams	否
sso	string = ""	否

回應

返回：Option[UnblockSuccess]

範例

unBlockCommentPublic 範例

Copy

let (unblockResult, httpResp) = client.unBlockCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if unblockResult.isSome:
  let result = unblockResult.get()

檢查被封鎖的評論

參數

名稱	類型	必填
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

回應

返回: Option[CheckBlockedCommentsResponse]

範例

checkedCommentsForBlocked 範例

Copy

let (maybeResponse, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "cmt-1,cmt-2",
  sso = ""
)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  discard response

從評論封鎖使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

回應

返回：Option[BlockSuccess]

範例

blockUserFromComment 範例

Copy

let params = BlockFromCommentParams()
let opts = BlockUserFromCommentOptions()
let (blockResult, httpResp) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  blockFromCommentParams = params,
  options = opts
)
if blockResult.isSome:
  let success = blockResult.get()
  discard success

建立公開評論

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

回應

回傳：Option[SaveCommentsResponseWithPresence]

範例

createCommentPublic 範例

Copy

let
  tenantId = "my-tenant-123"
  urlId = "news/article-title"
  broadcastId = "broadcast-456"
  commentData = CommentData()
  options = CreateCommentPublicOptions()
let (maybeResp, httpResp) = client.createCommentPublic(
  tenantId = tenantId,
  urlId = urlId,
  broadcastId = broadcastId,
  commentData = commentData,
  options = options)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

刪除評論

參數

名稱	類型	必填
tenantId	string	是
id	string	否
options	DeleteCommentOptions	否

回應

返回：Option[DeleteCommentResult]

範例

deleteComment 範例

Copy

let (delResult, httpResponse) = client.deleteComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  options = DeleteCommentOptions()
)
if delResult.isSome:
  let result = delResult.get()
  echo result

刪除公開評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	否
options	DeleteCommentPublicOptions	否

回應

回傳：Option[PublicAPIDeleteCommentResponse]

範例

deleteCommentPublic 範例

Copy

let (responseOpt, httpResp) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  options = DeleteCommentPublicOptions())
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

刪除評論投票

參數

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
options	DeleteCommentVoteOptions	No

回應

返回：Option[VoteDeleteResponse]

範例

deleteCommentVote 範例

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  voteId = "vote-789",
  urlId = "news/article-title",
  broadcastId = "broadcast-001",
  options = DeleteCommentVoteOptions()
)
if response.isSome:
  let voteDelete = response.get()

檢舉評論

參數

名稱	類型	必填
tenantId	string	是
id	string	否
options	FlagCommentOptions	否

回應

回傳：Option[FlagCommentResponse]

範例

flagComment 範例

Copy

let options = FlagCommentOptions(reason: "spam content", note: "Automated posting detected", isSpam: true, categories: @["spam"])
let (flagRes, httpRes) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-789", options = options)
if flagRes.isSome:
  let res = flagRes.get()
  discard res

取得評論

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回：Option[APIGetCommentResponse]

範例

getComment 範例

Copy

let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-789")
if response.isSome:
  let comment = response.get()
  discard comment

取得評論列表

參數

名稱	類型	必需	說明
tenantId	string	是
options	GetCommentsOptions	否

回應

返回：Option[APIGetCommentsResponse]

範例

getComments 範例

Copy

let options = GetCommentsOptions(
  urlId = "news/article-title",
  page = 0,
  pageSize = 20,
  sort = "newest",
  includeDeleted = false,
  includeReplies = true,
  userIds = @[],
  tags = @[]
)
let (response, httpResponse) = client.getComments(tenantId = "my-tenant-123", options = options)
if response.isSome:
  let comments = response.get()
  discard comments

取得公開評論列表

req tenantId urlId

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
options	GetCommentsPublicOptions	否

回應

返回：Option[GetCommentsResponseWithPresencePublicComment]

範例

getCommentsPublic 範例

Copy

let (optResp, httpResp) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetCommentsPublicOptions(
    page = 0,
    pageSize = 10,
    includeDeleted = false,
    tags = @[]
  )
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

取得評論文字

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
options	GetCommentTextOptions	否

回應

返回：Option[PublicAPIGetCommentTextResponse]

範例

getCommentText 範例

Copy

let (maybeResponse, httpResponse) = client.getCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = GetCommentTextOptions()
)
if maybeResponse.isSome:
  let response = maybeResponse.get()

取得評論投票者名稱

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

回應

返回：Option[GetCommentVoteUserNamesSuccessResponse]

範例

getCommentVoteUserNames 範例

Copy

let (voteNamesOpt, httpRes) = client.getCommentVoteUserNames(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  dir = 0,
  sso = ""
)
if voteNamesOpt.isSome:
  let voteNames = voteNamesOpt.get()
  echo voteNames

鎖定評論

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

回應

返回：Option[APIEmptyResponse]

範例

lockComment 範例

Copy

let (lockResult, httpRes) = client.lockComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  broadcastId = "",
  sso = "")
if lockResult.isSome:
  let resp = lockResult.get()
  discard resp

置頂評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	否
sso	string = ""	否

回應

返回：Option[ChangeCommentPinStatusResponse]

範例

pinComment 範例

Copy

let (pinResult, httpResp) = client.pinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = "",
)
if pinResult.isSome:
  let response = pinResult.get()
  echo response

儲存評論

參數

名稱	類型	必填
tenantId	string	是
createCommentParams	CreateCommentParams	否
options	SaveCommentOptions	否

回應

Returns: Option[APISaveCommentResponse]

範例

saveComment 範例

Copy

let commentParams = CreateCommentParams(
  body: "Great read, thanks!",
  name: "Alice Smith",
  email: "alice@example.com",
  parentId: ""
)
let saveOpts = SaveCommentOptions(
  isPreview: false,
  isApproved: true,
  skipSpamCheck: false
)
let (apiResponse, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = commentParams,
  options = saveOpts
)
if apiResponse.isSome:
  let saved = apiResponse.get()
  echo saved

批次儲存評論

參數

名稱	類型	必填
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

回應

返回：Option[APIEmptyResponse]

範例

saveCommentsBulk 範例

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  options = SaveCommentsBulkOptions(),
  id = "",
  fromName = ""
)
if response.isSome:
  let result = response.get()

設定評論文字

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	否
commentTextUpdateRequest	CommentTextUpdateRequest	否
options	SetCommentTextOptions	否

回應

Returns: Option[PublicAPISetCommentTextResponse]

範例

setCommentText 範例

Copy

let commentUpdate = CommentTextUpdateRequest(text: "Updated comment text")
let opts = SetCommentTextOptions()
let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  broadcastId = "broadcast-789",
  commentTextUpdateRequest = commentUpdate,
  options = opts)
if response.isSome:
  let result = response.get()

取消從評論封鎖使用者

參數

名稱	型別	必填
tenantId	string	是
id	string	否
unBlockFromCommentParams	UnBlockFromCommentParams	否
options	UnBlockUserFromCommentOptions	否

回應

回傳: Option[UnblockSuccess]

範例

unBlockUserFromComment 範例

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  unBlockFromCommentParams = UnBlockFromCommentParams(userId = "user-789", commentId = "cmt-321"),
  options = UnBlockUserFromCommentOptions(),
)
if response.isSome:
  let unblockSuccess = response.get()

取消檢舉評論

參數

名稱	類型	必要
tenantId	string	Yes
id	string	No
options	UnFlagCommentOptions	No

回應

返回：Option[FlagCommentResponse]

範例

unFlagComment 範例

Copy

let (flagRespOpt, httpResp) = client.unFlagComment(tenantId = "my-tenant-123", id = "comment-456", options = UnFlagCommentOptions())
if flagRespOpt.isSome:
  let flagResp = flagRespOpt.get()

解除鎖定評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	否
sso	string = ""	否

回應

返回：Option[APIEmptyResponse]

範例

unLockComment 範例

Copy

let (maybeEmpty, httpResp) = client.unLockComment(tenantId = "my-tenant-123", commentId = "comment-456", broadcastId = "", sso = "")
if maybeEmpty.isSome:
  let emptyResp = maybeEmpty.get()
  echo "Comment unlocked"
else:
  echo "Failed to unlock comment"

取消置頂評論

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

回應

Returns: Option[ChangeCommentPinStatusResponse]

範例

unPinComment 範例

Copy

let (responseOpt, httpResponse) = client.unPinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = ""
)
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

更新評論

參數

名稱	類型	必填
tenantId	string	是
id	string	否
updatableCommentParams	UpdatableCommentParams	否
options	UpdateCommentOptions	否

回應

返回: Option[APIEmptyResponse]

範例

updateComment 範例

Copy

let commentParams = UpdatableCommentParams(content: "Updated comment content")
let updateOpts = UpdateCommentOptions(force: false)
let (respOpt, httpResp) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = commentParams,
  options = updateOpts
)
if respOpt.isSome:
  let resp = respOpt.get()

對評論投票

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
urlId	string	是
broadcastId	string	否
voteBodyParams	VoteBodyParams	否
options	VoteCommentOptions	否

回應

返回: Option[VoteResponse]

範例

voteComment 範例

Copy

let (voteRespOpt, httpResp) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  urlId = "blog/how-to-code",
  broadcastId = "",
  voteBodyParams = VoteBodyParams(),
  options = VoteCommentOptions()
)
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()

取得使用者的評論

參數

名稱	類型	必填	說明
options	GetCommentsForUserOptions	No

回應

回傳: Option[GetCommentsForUserResponse]

範例

getCommentsForUser 範例

Copy

let (maybeResp, httpResp) = client.getCommentsForUser(options = GetCommentsForUserOptions(
  tenantId = "my-tenant-123",
  userId = "user-456",
  page = 0,
  pageSize = 20,
  includeDeleted = false,
  commentIds = @[]
))
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp

新增網域設定

參數

名稱	類型	必填	描述
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

回應

返回: Option[AddDomainConfigResponse]

範例

addDomainConfig 範例

Copy

let (respOpt, httpResp) = client.addDomainConfig(
  tenantId = "my-tenant-123",
  addDomainConfigParams = default(AddDomainConfigParams)
)
if respOpt.isSome:
  let cfg = respOpt.get()

刪除網域設定

參數

名稱	類型	必填	描述
tenantId	string	是
domain	string	否

回應

返回: Option[DeleteDomainConfigResponse]

範例

deleteDomainConfig 範例

Copy

let (optResp, httpResp) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

取得網域設定

參數

名稱	類型	必填	描述
tenantId	string	是
domain	string	否

回應

返回: Option[GetDomainConfigResponse]

範例

getDomainConfig 範例

Copy

let (configOpt, httpResp) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if configOpt.isSome:
  let cfg = configOpt.get()
  discard cfg

取得所有網域設定

參數

名稱	類型	必填	說明
tenantId	string	Yes

回應

返回：Option[GetDomainConfigsResponse]

範例

getDomainConfigs 範例

Copy

let (domainConfigsOpt, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if domainConfigsOpt.isSome:
  let domainConfigs = domainConfigsOpt.get()
  echo domainConfigs

部分更新網域設定

參數

名稱	類型	必填
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

回應

返回：Option[PatchDomainConfigResponse]

範例

patchDomainConfig 範例

Copy

let (optResp, httpResp) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news.mywebsite.com",
  patchDomainConfigParams = PatchDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

取代網域設定

參數

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

回應

Returns: Option[PutDomainConfigResponse]

範例

putDomainConfig 範例

Copy

let (optResp, httpResp) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "example.com",
  updateDomainConfigParams = UpdateDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

建立電子郵件範本

參數

Name	Type	Required	Description
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

回應

回傳: Option[CreateEmailTemplateResponse]

範例

createEmailTemplate 範例

Copy

let createBody = CreateEmailTemplateBody(
  name: "Welcome Email",
  subject: "Welcome to FastComments",
  htmlBody: "<p>Hello, thank you for joining us!</p>",
  isActive: true,
  tags: @[]
)
let (optResp, httpResp) = client.createEmailTemplate(
  tenantId = "my-tenant-123",
  createEmailTemplateBody = createBody
)
if optResp.isSome:
  let emailTemplate = optResp.get()

刪除電子郵件範本

參數

名稱	類型	必填	說明
tenantId	string	Yes
id	string	No

回應

返回：Option[APIEmptyResponse]

示例

deleteEmailTemplate 示例

Copy

let (respOpt, httpResp) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if respOpt.isSome:
  let emptyResp = respOpt.get()
  echo "Email template deleted"
else:
  echo "Failed to delete email template"

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

參數

Name	Type	Required
tenantId	string	Yes
id	string	No
errorId	string	No

回應

返回: Option[APIEmptyResponse]

範例

deleteEmailTemplateRenderError 範例

Copy

let (apiRes, httpRes) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  errorId = "render-err-456"
)
if apiRes.isSome:
  let empty = apiRes.get()

取得電子郵件範本

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

回應

Returns: Option[GetEmailTemplateResponse]

範例

getEmailTemplate 範例

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if response.isSome:
  let tmpl = response.get()

取得電子郵件範本定義

參數

名稱	類型	必填	說明
tenantId	string	是

回應

返回: Option[GetEmailTemplateDefinitionsResponse]

範例

getEmailTemplateDefinitions 範例

Copy

let (responseOpt, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if responseOpt.isSome:
  let definitions = responseOpt.get()
  echo definitions

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

參數

名稱	類型	必填
tenantId	string	是
id	string	否
skip	float64	否

回應

回傳: Option[GetEmailTemplateRenderErrorsResponse]

範例

getEmailTemplateRenderErrors 範例

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # 依需求使用回應
else:
  # 處理缺少的回應
  discard

取得電子郵件範本列表

參數

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

回應

返回: Option[GetEmailTemplatesResponse]

範例

getEmailTemplates 範例

Copy

let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if emailTemplatesOpt.isSome:
  let templates = emailTemplatesOpt.get()
  echo templates

渲染電子郵件範本

參數

名稱	類型	必填
tenantId	string	是
renderEmailTemplateBody	RenderEmailTemplateBody	否
locale	string = ""	否

回應

返回：Option[RenderEmailTemplateResponse]

範例

renderEmailTemplate 範例

Copy

let body = RenderEmailTemplateBody()
let (responseOpt, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = body, locale = "en-US")
if responseOpt.isSome:
  let response = responseOpt.get()
  discard response
discard httpResponse

更新電子郵件範本

參數

名稱	類型	必填
tenantId	string	是
id	string	否
updateEmailTemplateBody	UpdateEmailTemplateBody	否

回應

返回: Option[APIEmptyResponse]

範例

updateEmailTemplate 範例

Copy

let updateBody = UpdateEmailTemplateBody(
  subject: "Welcome to FastComments",
  body: "Hello \{{user_name}}, thanks for joining!",
  enabled: true,
)
let (maybeResp, httpResp) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  updateEmailTemplateBody = updateBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()

取得事件日誌

req tenantId urlId userIdWS

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

回應

回傳: Option[GetEventLogResponse]

範例

getEventLog 範例

Copy

let (eventLogOpt, httpResp) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

取得全域事件日誌

req tenantId urlId userIdWS

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
userIdWS	string	否
startTime	int64	否
endTime	int64	否

回應

返回：Option[GetEventLogResponse]

範例

getGlobalEventLog 範例

Copy

let (eventLogOpt, httpResp) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "user-456",
  startTime = 1700000000'i64,
  endTime = 1700003600'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

建立動態貼文

參數

名稱	類型	必填
tenantId	string	是
createFeedPostParams	CreateFeedPostParams	否
options	CreateFeedPostOptions	否

回應

返回：Option[CreateFeedPostsResponse]

範例

createFeedPost 範例

Copy

let (respOpt, httpResp) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(),
  options = CreateFeedPostOptions()
)
if respOpt.isSome:
  let feedPost = respOpt.get()

建立公開動態貼文

參數

名稱	類型	必填
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

回應

返回：Option[CreateFeedPostResponse]

範例

createFeedPostPublic 範例

Copy

let params = CreateFeedPostParams(
  urlId: "news/big-event",
  title: "Big Event Happened",
  content: "Full article content goes here.",
  tags: @["news", "event"]
)
let opts = CreateFeedPostPublicOptions(
  sendNotifications: false,
  allowComments: true
)
let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = params,
  options = opts
)
if response.isSome:
  let post = response.get()
  echo post

刪除公開動態貼文

參數

名稱	類型	必填
tenantId	string	是
postId	string	否
options	DeleteFeedPostPublicOptions	否

回應

返回: Option[DeleteFeedPostPublicResponse]

範例

deleteFeedPostPublic 範例

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-42",
  options = DeleteFeedPostPublicOptions()
)
if response.isSome:
  let deleteResp = response.get()

取得動態貼文

req tenantId afterId

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetFeedPostsOptions	否

回應

返回：Option[GetFeedPostsResponse]

範例

getFeedPosts 範例

Copy

let (feedResponseOpt, httpResp) = client.getFeedPosts(tenantId = "my-tenant-123", options = GetFeedPostsOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()
  echo feedResponse

取得公開動態貼文

請求 tenantId afterId

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetFeedPostsPublicOptions	否

回應

Returns: Option[PublicFeedPostsResponse]

範例

getFeedPostsPublic 示例

Copy

let (feedResponseOpt, httpResponse) = client.getFeedPostsPublic(tenantId = "my-tenant-123", options = GetFeedPostsPublicOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()

取得動態貼文統計

參數

名稱	類型	必填
tenantId	string	是
postIds	seq[string]	否
sso	string = ""	否

回應

Returns: Option[FeedPostsStatsResponse]

範例

getFeedPostsStats 範例

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # 根據需要使用 stats

取得使用者公開反應

參數

名稱	類型	必填	描述
tenantId	string	是
options	GetUserReactsPublicOptions	否

回應

返回: Option[UserReactsResponse]

範例

getUserReactsPublic 範例

Copy

let opts = GetUserReactsPublicOptions(
  limit = 20,
  offset = 0,
  includeDeleted = false
)
let (response, httpResponse) = client.getUserReactsPublic(
  tenantId = "my-tenant-123",
  options = opts
)
if response.isSome:
  let userReacts = response.get()

對公開動態貼文做反應

參數

名稱	類型	必填
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

回應

回傳：Option[ReactFeedPostResponse]

範例

reactFeedPostPublic 範例

Copy

let reactParams = ReactBodyParams()
let (optResp, httpResp) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  reactBodyParams = reactParams,
  options = ReactFeedPostPublicOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

更新動態貼文

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

回應

返回: Option[APIEmptyResponse]

範例

updateFeedPost 範例

Copy

let feedPost = FeedPost(
  title: "Breaking News",
  content: "Updated story content",
  tags: @["news", "update"]
)
let (apiRes, httpRes) = client.updateFeedPost(
  tenantId = "my-tenant-123",
  id = "post-456",
  feedPost = feedPost
)
if apiRes.isSome:
  let res = apiRes.get()

更新公開動態貼文

參數

名稱	類型	必填
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

回應

返回: Option[CreateFeedPostResponse]

範例

updateFeedPostPublic 範例

Copy

let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-789",
  updateFeedPostParams = UpdateFeedPostParams(),
  options = UpdateFeedPostPublicOptions()
)
if response.isSome:
  let post = response.get()

公開檢舉評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
isFlagged	bool	否
sso	string = ""	否

回應

返回: Option[APIEmptyResponse]

示例

flagCommentPublic 示例

Copy

let (optResp, httpResp) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  isFlagged = true,
  sso = ""
)
if optResp.isSome:
  let empty = optResp.get()
  discard empty

取得大型動圖

參數

Name	Type	Required	Description
tenantId	string	是
largeInternalURLSanitized	string	否

回應

返回: Option[GifGetLargeResponse]

範例

getGifLarge 範例

Copy

let (gifOpt, httpResp) = client.getGifLarge(
  tenantId = "my-tenant-123",
  largeInternalURLSanitized = "https://cdn.example.com/gifs/large123.gif")
if gifOpt.isSome:
  let gif = gifOpt.get()
  echo gif

搜尋動圖

參數

名稱	類型	必填
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

回應

返回：Option[GetGifsSearchResponse]

範例

getGifsSearch 範例

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # 使用 resp 如需

取得熱門動圖

參數

名稱	類型	必需	說明
tenantId	string	Yes
options	GetGifsTrendingOptions	No

回應

返回：Option[GetGifsTrendingResponse]

範例

getGifsTrending 範例

Copy

let (maybeResponse, httpResponse) = client.getGifsTrending(
  tenantId = "my-tenant-123",
  options = GetGifsTrendingOptions()
)
if maybeResponse.isSome:
  let gifs = maybeResponse.get()
  echo gifs

新增標籤

參數

名稱	類型	必填	說明
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

回應

Returns: Option[CreateHashTagResponse]

範例

addHashTag 範例

Copy

let (hashTagOpt, httpResp) = client.addHashTag(
  tenantId = "my-tenant-123",
  createHashTagBody = CreateHashTagBody(),
)
if hashTagOpt.isSome:
  let tag = hashTagOpt.get()

批次新增標籤

參數

名稱	類型	必要	描述
tenantId	string	是
bulkCreateHashTagsBody	BulkCreateHashTagsBody	否

回應

返回: Option[BulkCreateHashTagsResponse]

範例

addHashTagsBulk 範例

Copy

let (optResp, httpResp) = client.addHashTagsBulk(
  tenantId = "my-tenant-123",
  bulkCreateHashTagsBody = BulkCreateHashTagsBody(
    hashTags = @["news", "technology"]
  )
)
if optResp.isSome:
  let resp = optResp.get()

刪除標籤

參數

名稱	類型	必填
tenantId	string	Yes
tag	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

回應

Returns: Option[APIEmptyResponse]

範例

deleteHashTag 範例

Copy

let (apiResp, httpResp) = client.deleteHashTag(tenantId = "my-tenant-123", tag = "sports", deleteHashTagRequestBody = DeleteHashTagRequestBody())
if apiResp.isSome:
  let emptyResp = apiResp.get()

取得標籤列表

參數

名稱	類型	必填	說明
tenantId	string	Yes
page	float64	No

回應

返回: Option[GetHashTagsResponse]

範例

getHashTags 範例

Copy

let (hashTagsOpt, httpResp) = client.getHashTags(tenantId = "my-tenant-123", page = 0.0)
if hashTagsOpt.isSome:
  let hashTags = hashTagsOpt.get()
  echo hashTags
else:
  echo "No hashtags found"

部分更新標籤

參數

名稱	類型	必填
tenantId	string	是
tag	string	否
updateHashTagBody	UpdateHashTagBody	否

回應

Returns: Option[UpdateHashTagResponse]

示例

patchHashTag 示例

Copy

let updateBody = UpdateHashTagBody()
let (optResp, httpResp) = client.patchHashTag(
  tenantId = "my-tenant-123",
  tag = "news",
  updateHashTagBody = updateBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp
else:
  echo "No response"

刪除審核投票

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
options	DeleteModerationVoteOptions	No

回應

返回：Option[VoteDeleteResponse]

範例

deleteModerationVote 範例

Copy

let (respOpt, httpResp) = client.deleteModerationVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  voteId = "vote-abc123",
  options = DeleteModerationVoteOptions()
)
if respOpt.isSome:
  let resp = respOpt.get()

取得 API 評論

參數

名稱	類型	必填	描述
tenantId	string	是
options	GetApiCommentsOptions	否

回應

返回：Option[ModerationAPIGetCommentsResponse]

範例

getApiComments 範例

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # 進一步的處理可以使用 `resp`

取得 API 匯出狀態

參數

名稱	類型	必填	描述
tenantId	string	是
options	GetApiExportStatusOptions	否

回應

返回: Option[ModerationExportStatusResponse]

範例

getApiExportStatus 範例

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # 根據需要使用 exportStatus

取得 API IDs

參數

名稱	類型	必需	說明
tenantId	string	是
options	GetApiIdsOptions	否

回應

返回: Option[ModerationAPIGetCommentIdsResponse]

範例

getApiIds 範例

Copy

let opts = GetApiIdsOptions()
let (maybeResponse, httpResponse) = client.getApiIds(tenantId = "my-tenant-123", options = opts)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  echo response

取得從評論封禁的使用者

參數

名稱	類型	必須
tenantId	string	是
commentId	string	是
sso	string = ""	否

回應

返回: Option[GetBannedUsersFromCommentResponse]

範例

getBanUsersFromComment 範例

Copy

let (response, httpResponse) = client.getBanUsersFromComment(tenantId = "my-tenant-001", commentId = "cmt-123456", sso = "")
if response.isSome:
  let banInfo = response.get()
  echo banInfo

取得評論封禁狀態

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

回應

回傳：Option[GetCommentBanStatusResponse]

範例

getCommentBanStatus 範例

Copy

let (banStatusOpt, httpResp) = client.getCommentBanStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  sso = "")
if banStatusOpt.isSome:
  let banStatus = banStatusOpt.get()
  echo banStatus

取得評論子項

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
sso	string = ""	否

回應

返回: Option[ModerationAPIChildCommentsResponse]

範例

getCommentChildren 範例

Copy

let (childRespOpt, httpResp) = client.getCommentChildren(tenantId = "my-tenant-123", commentId = "cmt-456789", sso = "")
if childRespOpt.isSome:
  let childResp = childRespOpt.get()
  echo childResp

取得計數

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetCountOptions	否

回應

回傳：Option[ModerationAPICountCommentsResponse]

範例

getCount 範例

Copy

let (countOpt, httpResponse) = client.getCount(tenantId = "my-tenant-123", options = GetCountOptions())
if countOpt.isSome:
  let count = countOpt.get()

取得多項計數

參數

名稱	類型	必填	說明
tenantId	string	是
sso	string = ""	否

回應

返回：Option[GetBannedUsersCountResponse]

範例

getCounts 範例

Copy

let (maybeCounts, httpRes) = client.getCounts(tenantId = "my-tenant-123", sso = "")
if maybeCounts.isSome:
  let counts = maybeCounts.get()
  echo counts
else:
  echo "No counts returned"

取得日誌

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

回應

返回：Option[ModerationAPIGetLogsResponse]

範例

getLogs 範例

Copy

let (logsOpt, httpRes) = client.getLogs(tenantId = "my-tenant-123", commentId = "cmt-789", sso = "")
if logsOpt.isSome:
  let logs = logsOpt.get()
  echo logs

取得手動徽章

參數

Name	Type	Required	Description
tenantId	string	Yes
sso	string = ""	No

回應

返回: Option[GetTenantManualBadgesResponse]

範例

getManualBadges 範例

Copy

let (manualBadgesOpt, httpResponse) = client.getManualBadges(tenantId = "my-tenant-123", sso = "")
if manualBadgesOpt.isSome:
  let manualBadges = manualBadgesOpt.get()
  echo manualBadges

取得使用者的手動徽章

參數

名稱	類型	必要	說明
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

回應

回傳: Option[GetUserManualBadgesResponse]

範例

getManualBadgesForUser 範例

Copy

let (userBadgesOpt, httpResp) = client.getManualBadgesForUser(
  tenantId = "my-tenant-123",
  options = GetManualBadgesForUserOptions()
)
if userBadgesOpt.isSome:
  let badges = userBadgesOpt.get()
  echo badges

取得審核用評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
options	GetModerationCommentOptions	否

回應

返回：Option[ModerationAPICommentResponse]

範例

getModerationComment 範例

Copy

let (maybeComment, httpResponse) = client.getModerationComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(GetModerationCommentOptions)
)
if maybeComment.isSome:
  let comment = maybeComment.get()
  echo comment

取得審核用評論文字

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

回應

返回：Option[GetCommentTextResponse]

範例

getModerationCommentText 範例

Copy

let (optResp, httpResp) = client.getModerationCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456abc",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

取得預封鎖摘要

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
options	GetPreBanSummaryOptions	否

回應

返回：Option[PreBanSummary]

範例

getPreBanSummary 範例

Copy

let (preBanSummaryOpt, httpResponse) = client.getPreBanSummary(tenantId = "my-tenant-123", commentId = "cmt-456", options = GetPreBanSummaryOptions())
if preBanSummaryOpt.isSome:
  let summary = preBanSummaryOpt.get()

取得搜尋評論摘要

參數

名稱	類型	必填	描述
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

回應

返回：Option[ModerationCommentSearchResponse]

範例

getSearchCommentsSummary 範例

Copy

let (summaryOpt, httpResp) = client.getSearchCommentsSummary(
  tenantId = "my-tenant-123",
  options = GetSearchCommentsSummaryOptions()
)
if summaryOpt.isSome:
  let summary = summaryOpt.get()
  echo summary

取得搜尋頁面結果

參數

名稱	類型	必填	描述
tenantId	string	Yes
options	GetSearchPagesOptions	No

回應

返回：Option[ModerationPageSearchResponse]

範例

getSearchPages 範例

Copy

let (searchResp, httpResp) = client.getSearchPages(
  tenantId = "my-tenant-123",
  options = GetSearchPagesOptions(
    page: 1,
    pageSize: 20,
    query: "spam"
  )
)
if searchResp.isSome:
  let resp = searchResp.get()

取得搜尋網站結果

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetSearchSitesOptions	否

回應

返回：Option[ModerationSiteSearchResponse]

範例

getSearchSites 範例

Copy

let (searchResult, httpResp) = client.getSearchSites(tenantId = "my-tenant-123", options = GetSearchSitesOptions())
if searchResult.isSome:
  let siteResp = searchResult.get()

取得搜尋建議

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetSearchSuggestOptions	否

回應

返回：Option[ModerationSuggestResponse]

範例

getSearchSuggest 範例

Copy

let (suggestOpt, httpResp) = client.getSearchSuggest(
  tenantId = "my-tenant-123",
  options = GetSearchSuggestOptions(),
)
if suggestOpt.isSome:
  let suggest = suggestOpt.get()
  echo suggest

取得搜尋使用者

參數

名稱	型別	必填	說明
tenantId	string	是
options	GetSearchUsersOptions	否

回應

返回：Option[ModerationUserSearchResponse]

範例

getSearchUsers 範例

Copy

let (searchRes, httpRes) = client.getSearchUsers(tenantId = "my-tenant-123", options = default(GetSearchUsersOptions))
if searchRes.isSome:
  let data = searchRes.get()
  echo data

取得信任度指標

參數

名稱	類型	必填	描述
tenantId	string	是
options	GetTrustFactorOptions	否

回應

返回：Option[GetUserTrustFactorResponse]

範例

getTrustFactor 範例

Copy

let (trustOpt, httpResp) = client.getTrustFactor(tenantId = "my-tenant-123", options = GetTrustFactorOptions())
if trustOpt.isSome:
  let trust = trustOpt.get()
  discard trust

取得使用者封禁偏好

參數

名稱	類型	必填	說明
tenantId	string	是
sso	string = ""	否

回應

返回: Option[APIModerateGetUserBanPreferencesResponse]

範例

getUserBanPreference 範例

Copy

let (maybePref, httpResp) = client.getUserBanPreference(tenantId = "my-tenant-123", sso = "")
if maybePref.isSome:
  let pref = maybePref.get()
  echo pref

取得使用者內部資料

參數

名稱	類型	必填	描述
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

回應

返回：Option[GetUserInternalProfileResponse]

範例

getUserInternalProfile 範例

Copy

let (profileOpt, httpResp) = client.getUserInternalProfile(
  tenantId = "my-tenant-123",
  options = GetUserInternalProfileOptions()
)
if profileOpt.isSome:
  let profile = profileOpt.get()

調整評論投票

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
adjustCommentVotesParams	AdjustCommentVotesParams	否
options	PostAdjustCommentVotesOptions	否

回應

返回：Option[AdjustVotesResponse]

範例

postAdjustCommentVotes 範例

Copy

let (adjustRespOpt, httpResp) = client.postAdjustCommentVotes(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  adjustCommentVotesParams = AdjustCommentVotesParams(),
  options = PostAdjustCommentVotesOptions()
)
if adjustRespOpt.isSome:
  let adjustResp = adjustRespOpt.get()

提交 API 匯出

參數

名稱	類型	必填	描述
tenantId	string	Yes
options	PostApiExportOptions	No

回應

返回: Option[ModerationExportResponse]

範例

postApiExport 範例

Copy

let (optExport, httpResp) = client.postApiExport(tenantId = "my-tenant-123", options = PostApiExportOptions())
if optExport.isSome:
  let export = optExport.get()
  echo export

從評論封禁使用者

參數

名稱	類型	必要
tenantId	string	Yes
commentId	string	Yes
options	PostBanUserFromCommentOptions	No

回應

回傳：Option[BanUserFromCommentResult]

範例

postBanUserFromComment 範例

Copy

let (banResult, httpResp) = client.postBanUserFromComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  options = PostBanUserFromCommentOptions()
)
if banResult.isSome:
  let result = banResult.get()
  echo result

解除使用者封禁

參數

名稱	類型	必填
tenantId	string	是
banUserUndoParams	BanUserUndoParams	否
sso	string = ""	否

回應

返回: Option[APIEmptyResponse]

範例

postBanUserUndo 範例

Copy

let (apiResp, httpResp) = client.postBanUserUndo(
  tenantId = "my-tenant-123",
  banUserUndoParams = BanUserUndoParams(userId = "user-456"),
  sso = ""
)
if apiResp.isSome:
  let _ = apiResp.get()

批次預封鎖摘要

參數

名稱	類型	必填
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

回應

返回: Option[BulkPreBanSummary]

範例

postBulkPreBanSummary 範例

Copy

let bulkParams = BulkPreBanParams(emailAddresses: @["spam@example.com"], ipAddresses: @["203.0.113.5"])
let opt = PostBulkPreBanSummaryOptions(dryRun: false, maxResults: 0)
let (summaryOpt, httpResp) = client.postBulkPreBanSummary(tenantId = "my-tenant-123", bulkPreBanParams = bulkParams, options = opt)
if summaryOpt.isSome:
  let _ = summaryOpt.get()

依 ID 取得評論

參數

Name	Type	Required
tenantId	string	Yes
commentsByIdsParams	CommentsByIdsParams	No
sso	string = ""	No

回應

返回：Option[ModerationAPIChildCommentsResponse]

範例

postCommentsByIds 範例

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # use resp as needed

送出檢舉評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
options	PostFlagCommentOptions	否

回應

返回：Option[APIEmptyResponse]

範例

postFlagComment 範例

Copy

let opts = PostFlagCommentOptions()
let (response, httpResponse) = client.postFlagComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = opts,
)
if response.isSome:
  let result = response.get()

移除評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
options	PostRemoveCommentOptions	否

回應

返回：Option[PostRemoveCommentApiResponse]

範例

postRemoveComment 範例

Copy

let (apiResponseOpt, httpResp) = client.postRemoveComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = PostRemoveCommentOptions()
)
if apiResponseOpt.isSome:
  let apiResponse = apiResponseOpt.get()

還原已刪除的評論

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
options	PostRestoreDeletedCommentOptions	否

回應

返回: Option[APIEmptyResponse]

範例

postRestoreDeletedComment 範例

Copy

let (respOpt, httpResp) = client.postRestoreDeletedComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = default(PostRestoreDeletedCommentOptions)
)
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Comment restored"

設定評論核准狀態

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentApprovalStatusOptions	No

回應

回傳：Option[SetCommentApprovedResponse]

範例

postSetCommentApprovalStatus 範例

Copy

let (approvedOpt, httpResp) = client.postSetCommentApprovalStatus(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  options = PostSetCommentApprovalStatusOptions()
)
if approvedOpt.isSome:
  let approved = approvedOpt.get()
  echo approved

設定評論審查狀態

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentReviewStatusOptions	No

回應

返回: Option[APIEmptyResponse]

範例

postSetCommentReviewStatus 範例

Copy

let (apiResp, httpResp) = client.postSetCommentReviewStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  options = PostSetCommentReviewStatusOptions()
)
if apiResp.isSome:
  let _ = apiResp.get()
  discard
else:
  discard

設定評論為垃圾狀態

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

回應

返回：Option[APIEmptyResponse]

範例

postSetCommentSpamStatus 範例

Copy

let defaultOpts = PostSetCommentSpamStatusOptions()
let (maybeResp, httpResp) = client.postSetCommentSpamStatus(tenantId = "my-tenant-123", commentId = "cmt-456789", options = defaultOpts)
if maybeResp.isSome:
  let resp = maybeResp.get()

設定評論文字 (審核)

參數

名稱	類型	必要
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

回應

返回：Option[SetCommentTextResponse]

範例

postSetCommentText 範例

Copy

let (responseOpt, httpResponse) = client.postSetCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  setCommentTextParams = SetCommentTextParams(),
  options = PostSetCommentTextOptions()
)
if responseOpt.isSome:
  let updatedComment = responseOpt.get()

取消檢舉評論 (審核)

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
options	PostUnFlagCommentOptions	No

回應

返回：Option[APIEmptyResponse]

範例

postUnFlagComment 示例

Copy

let (maybeResp, httpResp) = client.postUnFlagComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(PostUnFlagCommentOptions)
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

送出投票

參數

名稱	類型	必須
tenantId	string	是
commentId	string	是
options	PostVoteOptions	否

回應

返回：Option[VoteResponse]

範例

postVote 範例

Copy

let (voteOpt, httpResp) = client.postVote(
  tenantId = "my-tenant-123",
  commentId = "comment-789",
  options = default(PostVoteOptions)
)
if voteOpt.isSome:
  let vote = voteOpt.get()

授予徽章

參數

名稱	類型	必填
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

回應

返回: Option[AwardUserBadgeResponse]

範例

putAwardBadge 範例

Copy

let (response, httpResponse) = client.putAwardBadge(
  tenantId = "my-tenant-123",
  badgeId = "gold-badge",
  options = PutAwardBadgeOptions()
)
if response.isSome:
  let award = response.get()

關閉討論串

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
sso	string = ""	否

回應

返回：Option[APIEmptyResponse]

範例

putCloseThread 範例

Copy

let (respOpt, httpResp) = client.putCloseThread(tenantId = "my-tenant-123", urlId = "news/fastcomments-integration", sso = "")
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Thread successfully closed"

移除徽章

參數

名稱	類型	必填
tenantId	string	是
badgeId	string	否
options	PutRemoveBadgeOptions	否

回應

返回: Option[RemoveUserBadgeResponse]

範例

putRemoveBadge 範例

Copy

let (maybeResp, httpResp) = client.putRemoveBadge(
  tenantId = "my-tenant-123",
  badgeId = "badge-456",
  options = PutRemoveBadgeOptions()
)
if maybeResp.isSome:
  let badgeResp = maybeResp.get()

重新開啟討論串

參數

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

回應

返回: Option[APIEmptyResponse]

範例

putReopenThread 範例

Copy

let (apiRespOpt, httpResp) = client.putReopenThread(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  sso = ""
)
if apiRespOpt.isSome:
  let emptyResp = apiRespOpt.get()
  discard

設定信任度指標

參數

名稱	類型	必填	說明
tenantId	string	是
options	SetTrustFactorOptions	否

回應

回傳: Option[SetUserTrustFactorResponse]

範例

setTrustFactor 範例

Copy

let opts = SetTrustFactorOptions(userId = "user-456", trustFactor = 5, reason = "spam detection")
let (trustResponse, httpResponse) = client.setTrustFactor(tenantId = "my-tenant-123", options = opts)
if trustResponse.isSome:
  let result = trustResponse.get()

建立管理員

參數

名稱	型別	必填	說明
tenantId	string	是
createModeratorBody	CreateModeratorBody	否

回應

返回: Option[CreateModeratorResponse]

範例

createModerator 範例

Copy

let (moderatorRes, httpResp) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = CreateModeratorBody())
if moderatorRes.isSome:
  let moderator = moderatorRes.get()

刪除管理員

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

回應

返回: Option[APIEmptyResponse]

範例

deleteModerator 範例

Copy

let (apiResp, httpResp) = client.deleteModerator(
  tenantId = "my-tenant-123",
  id = "mod-789",
  sendEmail = "admin@mydomain.com",
)
if apiResp.isSome:
  let empty = apiResp.get()
  echo "Moderator removed"

取得管理員

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回: Option[GetModeratorResponse]

範例

getModerator 範例

Copy

let (moderatorOpt, httpResponse) = client.getModerator(tenantId = "my-tenant-123", id = "moderator-456")
if moderatorOpt.isSome:
  let moderator = moderatorOpt.get()
  discard moderator

取得管理員列表

參數

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

回應

返回：Option[GetModeratorsResponse]

範例

getModerators 範例

Copy

let (moderatorsOpt, httpResp) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if moderatorsOpt.isSome:
  let moderators = moderatorsOpt.get()
  echo moderators

更新管理員

參數

Name	Type	Required
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

回應

返回: Option[APIEmptyResponse]

範例

updateModerator 範例

Copy

let body = UpdateModeratorBody(name = "John Doe", email = "john@example.com", isActive = true)
let (apiResult, httpResp) = client.updateModerator(tenantId = "my-tenant-123", id = "mod-456", updateModeratorBody = body)
if apiResult.isSome:
  let result = apiResult.get()

刪除通知計數

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回：Option[APIEmptyResponse]

範例

deleteNotificationCount 範例

Copy

let (apiRespOpt, httpResp) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if apiRespOpt.isSome:
  let _ = apiRespOpt.get()

取得快取的通知計數

參數

名稱	類型	必填	描述
tenantId	string	Yes
id	string	No

回應

返回：Option[GetCachedNotificationCountResponse]

範例

getCachedNotificationCount 範例

Copy

let (cachedCountOpt, httpResp) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "article-456")
if cachedCountOpt.isSome:
  let cachedCount = cachedCountOpt.get()
  echo cachedCount

取得通知計數

參數

名稱	類型	必需	描述
tenantId	string	是
options	GetNotificationCountOptions	否

回應

返回：Option[GetNotificationCountResponse]

範例

getNotificationCount 範例

Copy

let (notifOpt, httpResp) = client.getNotificationCount(tenantId = "my-tenant-123", options = GetNotificationCountOptions())
if notifOpt.isSome:
  let notif = notifOpt.get()
  echo notif

取得通知列表

參數

名稱	類型	必填	描述
tenantId	string	是
options	GetNotificationsOptions	否

回應

返回: Option[GetNotificationsResponse]

範例

取得通知範例

Copy

let (notifOpt, httpResp) = client.getNotifications(tenantId = "my-tenant-123", options = GetNotificationsOptions())
if notifOpt.isSome:
  let notifications = notifOpt.get()

更新通知

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

回應

回傳: Option[APIEmptyResponse]

範例

updateNotification 範例

Copy

let body = UpdateNotificationBody(message: "Your comment was approved", isRead: false)
let (optResp, httpResp) = client.updateNotification(
  tenantId = "my-tenant-123",
  id = "notif-789",
  updateNotificationBody = body,
  userId = "user-42"
)
if optResp.isSome:
  let _ = optResp.get()

建立 V1 頁面反應

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
title	string = ""	否

回應

返回：Option[CreateV1PageReact]

範例

createV1PageReact 範例

Copy

let (pageOpt, httpResp) = client.createV1PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  title = "Breaking News: Nim Takes Over"
)
if pageOpt.isSome:
  let page = pageOpt.get()
  discard page
  discard httpResp

建立 V2 頁面反應

參數

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
id	string	No
title	string = ""	No

回應

回傳：Option[CreateV1PageReact]

範例

createV2PageReact 範例

Copy

let (pageResult, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "page-456",
  title = "Breaking News",
)
if pageResult.isSome:
  let page = pageResult.get()
  # 根據需要使用 `page`

刪除 V1 頁面反應

參數

名稱	類型	必填	描述
tenantId	string	是
urlId	string	是

回應

返回: Option[CreateV1PageReact]

範例

deleteV1PageReact 範例

Copy

let (reactOpt, httpResp) = client.deleteV1PageReact(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactOpt.isSome:
  let react = reactOpt.get()

刪除 V2 頁面反應

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
id	string	否

回應

返回: Option[CreateV1PageReact]

範例

deleteV2PageReact 範例

Copy

let (maybeReact, httpResp) = client.deleteV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "react-456",
)
if maybeReact.isSome:
  let react = maybeReact.get()
  echo react

取得 V1 頁面按讚數

參數

名稱	類型	必填	描述
tenantId	string	是
urlId	string	是

回應

回傳: Option[GetV1PageLikes]

範例

getV1PageLikes 範例

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # 根據需要使用 pageLikes

取得 V2 頁面反應

參數

名稱	類型	必填	說明
tenantId	string	是
urlId	string	是

回應

返回：Option[GetV2PageReacts]

示例

getV2PageReacts 示例

Copy

let (reactsOpt, httpResp) = client.getV2PageReacts(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactsOpt.isSome:
  let reacts = reactsOpt.get()
  echo reacts

取得 V2 頁面反應使用者

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
id	string	No

回應

返回: Option[GetV2PageReactUsersResponse]

範例

getV2PageReactUsers 範例

Copy

let (maybeResponse, httpResponse) = client.getV2PageReactUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "user-456"
)
if maybeResponse.isSome:
  let resp = maybeResponse.get()
  echo resp

新增頁面

參數

名稱	類型	必填	描述
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

回應

返回: Option[AddPageAPIResponse]

範例

addPage 範例

Copy

let pageData = CreateAPIPageData(
  urlId = "news/article-2024",
  title = "Breaking News: Nim Takes Over",
  description = "An in-depth article about Nim's rise.",
  tags = @["nim", "programming", "news"]
)
let (addPageResp, httpResp) = client.addPage(
  tenantId = "my-tenant-123",
  createAPIPageData = pageData
)
if addPageResp.isSome:
  let resp = addPageResp.get()
  echo resp

刪除頁面

參數

名稱	類型	必填	說明
tenantId	string	Yes
id	string	No

回應

回傳: Option[DeletePageAPIResponse]

範例

deletePage 範例

Copy

let (deleteRespOpt, httpResp) = client.deletePage(tenantId = "my-tenant-123", id = "news/article-title")
if deleteRespOpt.isSome:
  let deleteResp = deleteRespOpt.get()
  discard deleteResp
discard httpResp

取得離線使用者

過去在此頁面留言的使用者，且目前未在線上。依 displayName 排序。
在耗盡 /users/online 後使用，以呈現「Members」區段。
在 commenterName 上的游標分頁：伺服器從 afterName 向前遍歷部分 {tenantId, urlId, commenterName} 索引，使用 $gt 前進，無 $skip 成本。

Parameters

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Response

Returns: Option[PageUsersOfflineResponse]

Example

getOfflineUsers 範例

Copy

let (offlineResp, httpResponse) = client.getOfflineUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetOfflineUsersOptions()
)
if offlineResp.isSome:
  let offline = offlineResp.get()
  echo offline)

取得線上使用者

目前在線的頁面觀眾：指其 WebSocket 會話目前已訂閱該頁面的使用者。
返回 anonCount + totalCount（全站訂閱者數，包括我們未列舉的匿名觀眾）。

參數

Name	Type	Required
tenantId	string	是
urlId	string	是
options	GetOnlineUsersOptions	否

回應

返回：Option[PageUsersOnlineResponse]

範例

getOnlineUsers 範例

Copy

let opts = GetOnlineUsersOptions()
let (onlineUsersOpt, httpResp) = client.getOnlineUsers(tenantId = "my-tenant-123", urlId = "news/article-title", options = opts)
if onlineUsersOpt.isSome:
  let onlineUsers = onlineUsersOpt.get()
  echo onlineUsers

依 URL ID 取得頁面

參數

名稱	類型	必填	說明
tenantId	string	是
urlId	string	是

回應

返回: Option[GetPageByURLIdAPIResponse]

範例

getPageByURLId 範例

Copy

let (pageOpt, httpRes) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if pageOpt.isSome:
  let page = pageOpt.get()
  echo page

取得頁面列表

參數

名稱	類型	必填	說明
tenantId	string	Yes

回應

Returns: Option[GetPagesAPIResponse]

範例

getPages 範例

Copy

let (pagesOpt, httpResp) = client.getPages(tenantId = "my-tenant-123")
if pagesOpt.isSome:
  let pages = pagesOpt.get()
  echo pages
else:
  echo "No pages returned"
echo httpResp

取得公開頁面列表

列出租戶的頁面。由 FChat 桌面客戶端使用，以填充其房間列表。
需要在每個頁面的已解析自訂設定中將 enableFChat 設為 true。
需要 SSO 的頁面會根據請求使用者的群組存取權限進行篩選。

Parameters

名稱	類型	必填	描述
tenantId	string	是
options	GetPagesPublicOptions	否

Response

Returns: Option[GetPublicPagesResponse]

Example

getPagesPublic 範例

Copy

let (response, httpResponse) = client.getPagesPublic(tenantId = "my-tenant-123", options = GetPagesPublicOptions())
if response.isSome:
  let pages = response.get()
  echo pages

取得使用者資訊

批次取得租戶的使用者資訊。根據 userIds，回傳來自 User / SSOUser 的顯示資訊。
此功能被評論小工具使用，以在使用者透過在場事件剛出現時豐富其資訊。
無頁面上下文：隱私權會一致性地被強制執行（私人檔案會被遮蔽）。

Parameters

名稱	類型	必填	說明
tenantId	string	是
ids	string	否

回應

返回：Option[PageUsersInfoResponse]

範例

getUsersInfo 範例

Copy

let (usersInfoOpt, httpResp) = client.getUsersInfo(tenantId = "my-tenant-123", ids = "user42")
if usersInfoOpt.isSome:
  let usersInfo = usersInfoOpt.get()

部分更新頁面

參數

名稱	類型	必填
tenantId	string	是
id	string	否
updateAPIPageData	UpdateAPIPageData	否

回應

返回：Option[PatchPageAPIResponse]

範例

patchPage 範例

Copy

let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/article-456",
  updateAPIPageData = UpdateAPIPageData(title = "Updated article title", description = "Revised description")
)
if response.isSome:
  let resp = response.get()

刪除待處理的 webhook 事件

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回：Option[APIEmptyResponse]

範例

deletePendingWebhookEvent 範例

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "event-456")
if response.isSome:
  let empty = response.get()

取得待處理 webhook 事件計數

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetPendingWebhookEventCountOptions	否

回應

回傳：Option[GetPendingWebhookEventCountResponse]

範例

getPendingWebhookEventCount 範例

Copy

let (pendingCountOpt, httpResponse) = client.getPendingWebhookEventCount(tenantId = "my-tenant-123", options = GetPendingWebhookEventCountOptions())
if pendingCountOpt.isSome:
  let pendingCount = pendingCountOpt.get()
  echo pendingCount

取得待處理 webhook 事件列表

參數

名稱	類型	必填	說明
tenantId	string	Yes
options	GetPendingWebhookEventsOptions	No

回應

返回：Option[GetPendingWebhookEventsResponse]

範例

getPendingWebhookEvents 範例

Copy

let (maybeResp, httpResp) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  options = GetPendingWebhookEventsOptions()
)
if maybeResp.isSome:
  let resp = maybeResp.get()

建立問卷設定

參數

Name	Type	Required	Description
tenantId	string	是
createQuestionConfigBody	CreateQuestionConfigBody	否

回應

回傳：Option[CreateQuestionConfigResponse]

範例

createQuestionConfig 範例

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # 使用回應如需要

刪除問卷設定

參數

名稱	類型	必填	說明
tenantId	string	Yes
id	string	No

回應

返回：Option[APIEmptyResponse]

範例

deleteQuestionConfig 範例

Copy

let (apiResult, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "question-config-456")
if apiResult.isSome:
  let empty = apiResult.get()

取得問卷設定

參數

名稱	類型	必填	描述
tenantId	string	Yes
id	string	No

回應

回傳: Option[GetQuestionConfigResponse]

範例

getQuestionConfig 範例

Copy

let (questionConfigOpt, httpResp) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "question-987")
if questionConfigOpt.isSome:
  let config = questionConfigOpt.get()
  echo config

取得問卷設定列表

參數

名稱	類型	必要	說明
tenantId	string	是
skip	float64	否

回應

回傳：Option[GetQuestionConfigsResponse]

範例

getQuestionConfigs 範例

Copy

let (response, httpResponse) = client.getQuestionConfigs(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let configs = response.get()
  echo configs

更新問卷設定

參數

名稱	類型	必填
tenantId	string	是
id	string	否
updateQuestionConfigBody	UpdateQuestionConfigBody	否

回應

回傳: Option[APIEmptyResponse]

範例

updateQuestionConfig 範例

Copy

let (apiResp, httpResp) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if apiResp.isSome:
  let resp = apiResp.get()

建立問卷結果

參數

名稱	類型	必要	描述
tenantId	string	是
createQuestionResultBody	CreateQuestionResultBody	否

回應

回傳：Option[CreateQuestionResultResponse]

範例

createQuestionResult 範例

Copy

let tenantId = "my-tenant-123"
let body = CreateQuestionResultBody()
let (optResult, httpResp) = client.createQuestionResult(tenantId = tenantId, createQuestionResultBody = body)
if optResult.isSome:
  let result = optResult.get()
  echo result

刪除問卷結果

參數

名稱	類型	必填	描述
tenantId	string	是
id	string	否

回應

返回：Option[APIEmptyResponse]

範例

deleteQuestionResult 範例

Copy

let (maybeResult, httpResp) = client.deleteQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if maybeResult.isSome:
  let result = maybeResult.get()

取得問卷結果

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回: Option[GetQuestionResultResponse]

範例

getQuestionResult 示例

Copy

let (optResult, httpResp) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if optResult.isSome:
  let result = optResult.get()
  discard result

取得問卷結果列表

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetQuestionResultsOptions	否

回應

回傳：Option[GetQuestionResultsResponse]

範例

getQuestionResults 範例

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  options = GetQuestionResultsOptions()
)
if response.isSome:
  let results = response.get()
  echo results

更新問卷結果

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

回應

返回: Option[APIEmptyResponse]

範例

updateQuestionResult 範例

Copy

let (optResp, httpResp) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody()
)
if optResp.isSome:
  let resp = optResp.get()

彙總問卷結果

參數

名稱	類型	必填	描述
tenantId	string	是
options	AggregateQuestionResultsOptions	否

回應

返回: Option[AggregateQuestionResultsResponse]

範例

aggregateQuestionResults 範例

Copy

let opts = AggregateQuestionResultsOptions()
let (aggResultOpt, httpResp) = client.aggregateQuestionResults(tenantId = "my-tenant-123", options = opts)
if aggResultOpt.isSome:
  let aggResult = aggResultOpt.get()

批次彙總問卷結果

參數

名稱	型別	必填
tenantId	string	是
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	否
forceRecalculate	bool	否

回應

回傳: Option[BulkAggregateQuestionResultsResponse]

範例

bulkAggregateQuestionResults 範例

Copy

let request = BulkAggregateQuestionResultsRequest()
let (maybeResult, httpResp) = client.bulkAggregateQuestionResults(
  tenantId = "my-tenant-123",
  bulkAggregateQuestionResultsRequest = request,
  forceRecalculate = false)
if maybeResult.isSome:
  let result = maybeResult.get()

將評論與問卷結果合併

參數

名稱	類型	必填	描述
tenantId	string	是
options	CombineCommentsWithQuestionResultsOptions	否

回應

返回：Option[CombineQuestionResultsWithCommentsResponse]

範例

combineCommentsWithQuestionResults 範例

Copy

let (combineOpt, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  options = default(CombineCommentsWithQuestionResultsOptions)
)
if combineOpt.isSome:
  let combineResult = combineOpt.get()

新增 SSO 使用者

參數

名稱	類型	必填	說明
tenantId	string	是
createAPISSOUserData	CreateAPISSOUserData	否

回應

返回：Option[AddSSOUserAPIResponse]

範例

addSSOUser 範例

Copy

let (optResp, httpResp) = client.addSSOUser(tenantId = "my-tenant-123", createAPISSOUserData = CreateAPISSOUserData())
if optResp.isSome:
  let userResp = optResp.get()

刪除 SSO 使用者

參數

名稱	型別	必填
tenantId	string	是
id	string	否
options	DeleteSSOUserOptions	否

回應

返回: Option[DeleteSSOUserAPIResponse]

範例

deleteSSOUser 範例

Copy

let (apiRespOpt, httpResp) = client.deleteSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteSSOUserOptions()
)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()

依電子郵件取得 SSO 使用者

參數

名稱	類型	必填	說明
tenantId	string	是
email	string	否

回應

返回：Option[GetSSOUserByEmailAPIResponse]

範例

getSSOUserByEmail 範例

Copy

let (optResp, httpResp) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "john.doe@example.com")
if optResp.isSome:
  let user = optResp.get()
  discard user

依 ID 取得 SSO 使用者

參數

名稱	類型	必填	描述
tenantId	string	是
id	string	否

回應

回傳：Option[GetSSOUserByIdAPIResponse]

範例

getSSOUserById 範例

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "user-456")
if response.isSome:
  let userInfo = response.get()
  discard userInfo

取得 SSO 使用者列表

參數

名稱	類型	必填	說明
tenantId	string	Yes
skip	int	No

回應

回傳: Option[GetSSOUsersResponse]

範例

getSSOUsers 範例

Copy

let (maybeResponse, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if maybeResponse.isSome:
  let users = maybeResponse.get()
  echo users
else:
  echo "No SSO users found"
echo httpResponse.statusCode

部分更新 SSO 使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

回應

返回: Option[PatchSSOUserAPIResponse]

範例

patchSSOUser 範例

Copy

let updateData = UpdateAPISSOUserData()
let (responseOpt, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = updateData,
  updateComments = true)
if responseOpt.isSome:
  let response = responseOpt.get()
  echo response
echo httpResponse.statusCode

建立或取代 SSO 使用者

參數

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

回應

Returns: Option[PutSSOUserAPIResponse]

範例

putSSOUser 範例

Copy

let (apiRespOpt, httpResp) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = default(UpdateAPISSOUserData),
  updateComments = false)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()
  echo apiResp

建立訂閱

參數

名稱	類型	必填	描述
tenantId	string	是
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	否

回應

回傳：Option[CreateSubscriptionAPIResponse]

範例

createSubscription 範例

Copy

let (respOpt, httpResp) = client.createSubscription(
  tenantId = "my-tenant-123",
  createAPIUserSubscriptionData = default(CreateAPIUserSubscriptionData),
)
if respOpt.isSome:
  let resp = respOpt.get()

刪除訂閱

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
userId	string = ""	No

回應

返回：Option[DeleteSubscriptionAPIResponse]

範例

deleteSubscription 範例

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # 根據需要使用 apiResult

取得訂閱列表

參數

名稱	類型	必填	描述
tenantId	string	是
userId	string = ""	否

回應

Returns: Option[GetSubscriptionsAPIResponse]

範例

getSubscriptions 範例

Copy

let (subscriptionsOpt, httpResp) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "user-456")
if subscriptionsOpt.isSome:
  let subscriptions = subscriptionsOpt.get()
  echo subscriptions

更新訂閱

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

回應

返回: Option[UpdateSubscriptionAPIResponse]

範例

updateSubscription 範例

Copy

let subscriptionData = UpdateAPIUserSubscriptionData(
  planId = "premium-plan",
  isActive = true,
  expiresAt = "2025-01-01",
)
let (responseOpt, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = subscriptionData,
  userId = "user-789",
)
if responseOpt.isSome:
  let subscriptionResult = responseOpt.get()

取得租戶每日使用量

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetTenantDailyUsagesOptions	否

回應

回傳：Option[GetTenantDailyUsagesResponse]

範例

getTenantDailyUsages 範例

Copy

let (respOpt, httpResp) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  options = default(GetTenantDailyUsagesOptions),
)
if respOpt.isSome:
  let usage = respOpt.get()
  echo usage
  echo httpResp.statusCode

建立租戶方案

參數

名稱	類型	必須	描述
tenantId	string	是
createTenantPackageBody	CreateTenantPackageBody	否

回應

返回：Option[CreateTenantPackageResponse]

範例

createTenantPackage 範例

Copy

let (responseOpt, httpResponse) = client.createTenantPackage(
  tenantId = "my-tenant-123",
  createTenantPackageBody = CreateTenantPackageBody()
)
if responseOpt.isSome:
  let response = responseOpt.get()

刪除租戶方案

參數

名稱	類型	必填	說明
tenantId	string	Yes
id	string	No

回應

返回：Option[APIEmptyResponse]

範例

deleteTenantPackage 範例

Copy

let (apiResponse, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-456def")
if apiResponse.isSome:
  let emptyResponse = apiResponse.get()

取得租戶方案

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

回應

返回: Option[GetTenantPackageResponse]

範例

getTenantPackage 範例

Copy

let (pkgOpt, httpResp) = client.getTenantPackage(tenantId = "my-tenant-123", id = "premium-plan")
if pkgOpt.isSome:
  let pkg = pkgOpt.get()
  echo pkg

取得租戶方案列表

參數

名稱	類型	必填	說明
tenantId	string	Yes
skip	float64	No

回應

返回：Option[GetTenantPackagesResponse]

範例

getTenantPackages 範例

Copy

let (maybeResp, httpResp) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if maybeResp.isSome:
  let packages = maybeResp.get()
  echo packages
  echo httpResp.statusCode

取代租戶方案

參數

名稱	型別	必填
tenantId	string	是
id	string	否
replaceTenantPackageBody	ReplaceTenantPackageBody	否

回應

返回: Option[APIEmptyResponse]

範例

replaceTenantPackage 範例

Copy

let (optResp, httpResp) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-456",
  replaceTenantPackageBody = ReplaceTenantPackageBody()
)
if optResp.isSome:
  let resp = optResp.get()
  discard resp

更新租戶方案

參數

名稱	類型	必要
tenantId	string	是
id	string	否
updateTenantPackageBody	UpdateTenantPackageBody	否

回應

返回：Option[APIEmptyResponse]

範例

updateTenantPackage 範例

Copy

let body = UpdateTenantPackageBody()
let (optResp, httpResp) = client.updateTenantPackage(
  tenantId = "my-tenant-123",
  id = "premium-plan",
  updateTenantPackageBody = body
)
if optResp.isSome:
  let empty = optResp.get()

建立租戶使用者

參數

名稱	類型	必填	說明
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

回傳

Returns: Option[CreateTenantUserResponse]

範例

createTenantUser 範例

Copy

let tenantId = "my-tenant-123"
let userBody = CreateTenantUserBody(
  email: "john.doe@example.com",
  name: "John Doe",
  password: "s3cr3tP@ss",
  role: "admin"
)
let (optResp, httpResp) = client.createTenantUser(
  tenantId = tenantId,
  createTenantUserBody = userBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp.userId

刪除租戶使用者

參數

名稱	類型	必填
tenantId	string	是
id	string	否
options	DeleteTenantUserOptions	否

回應

返回：Option[APIEmptyResponse]

範例

deleteTenantUser 範例

Copy

let (response, httpResponse) = client.deleteTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteTenantUserOptions(),
)
if response.isSome:
  let empty = response.get()
  echo "User successfully deleted"

取得租戶使用者

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回：Option[GetTenantUserResponse]

範例

getTenantUser 範例

Copy

let (maybeUser, httpResp) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-456")
if maybeUser.isSome:
  let user = maybeUser.get()
  echo user

取得租戶使用者列表

參數

名稱	類型	必填	描述
tenantId	string	Yes
skip	float64	No

回應

返回：Option[GetTenantUsersResponse]

範例

getTenantUsers 範例

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let data = response.get()
  echo data

取代租戶使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

回應

回傳: Option[APIEmptyResponse]

範例

replaceTenantUser 範例

Copy

let replaceBody = ReplaceTenantUserBody()
let (response, httpResponse) = client.replaceTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  replaceTenantUserBody = replaceBody,
  updateComments = "")
if response.isSome:
  let empty = response.get()

發送登入連結

參數

Name	Type	Required
tenantId	string	Yes
id	string	No
redirectURL	string = ""	No

回應

Returns: Option[APIEmptyResponse]

範例

sendLoginLink 範例

Copy

let (maybeResp, httpResp) = client.sendLoginLink(
  tenantId = "my-tenant-123",
  id = "user-456",
  redirectURL = "https://myapp.example.com/login-success"
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

更新租戶使用者

參數

Name	Type	Required
tenantId	string	是
id	string	否
updateTenantUserBody	UpdateTenantUserBody	否
updateComments	string = ""	否

回應

返回：Option[APIEmptyResponse]

範例

updateTenantUser 範例

Copy

let updateBody = UpdateTenantUserBody()
let (optResp, httpResp) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateTenantUserBody = updateBody,
  updateComments = "Changed role to moderator",
)
if optResp.isSome:
  let _ = optResp.get()

建立租戶

參數

Name	Type	Required	Description
tenantId	string	是
createTenantBody	CreateTenantBody	否

回應

返回: Option[CreateTenantResponse]

範例

createTenant 範例

Copy

let (maybeResp, httpResp) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody())
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp
discard httpResp

刪除租戶

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
sure	string = ""	No

回應

回傳：Option[APIEmptyResponse]

範例

deleteTenant 範例

Copy

let (respOpt, httpResp) = client.deleteTenant(tenantId = "my-tenant-123", id = "tenant-to-delete", sure = "yes")
if respOpt.isSome:
  let emptyResp = respOpt.get()

取得租戶

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

回應

回傳: Option[GetTenantResponse]

範例

getTenant 範例

Copy

let (tenantResponse, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "config-001")
if tenantResponse.isSome:
  let tenant = tenantResponse.get()
  echo tenant

取得租戶列表

參數

名稱	類型	必填	說明
tenantId	string	Yes
options	GetTenantsOptions	No

回應

Returns: Option[GetTenantsResponse]

範例

getTenants 範例

Copy

let (maybeResp, httpResp) = client.getTenants(tenantId = "my-tenant-123", options = GetTenantsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

更新租戶

參數

名稱	類型	必填
tenantId	string	是
id	string	否
updateTenantBody	UpdateTenantBody	否

回應

返回：Option[APIEmptyResponse]

範例

updateTenant 範例

Copy

let updateBody = UpdateTenantBody(
  name: "My Tenant",
  description: "Tenant for news site",
  isActive: true,
  allowedDomains: @["example.com", "news.com"]
)
let (apiResp, httpResp) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = updateBody
)
if apiResp.isSome:
  let emptyResp = apiResp.get()

變更工單狀態

參數

名稱	類型	必填
tenantId	string	Yes
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

回應

回傳：Option[ChangeTicketStateResponse]

範例

changeTicketState 範例

Copy

let (optResp, httpResp) = client.changeTicketState(
  tenantId = "my-tenant-001",
  userId = "user-42",
  id = "ticket-12345",
  changeTicketStateBody = ChangeTicketStateBody(state = "closed")
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

建立工單

參數

Name	Type	Required
tenantId	string	是
userId	string	否
createTicketBody	CreateTicketBody	否

回應

返回: Option[CreateTicketResponse]

範例

createTicket 範例

Copy

let tenantId = "my-tenant-123"
let userId = "user-456"
let ticketBody = CreateTicketBody()
let (responseOpt, httpResponse) = client.createTicket(tenantId = tenantId, userId = userId, createTicketBody = ticketBody)
if responseOpt.isSome:
  let ticketResponse = responseOpt.get()

取得工單

參數

名稱	類型	必填
tenantId	string	是
id	string	否
userId	string = ""	否

回應

回傳：Option[GetTicketResponse]

範例

getTicket 範例

Copy

let (ticketOpt, httpResp) = client.getTicket(tenantId = "my-tenant-123", id = "ticket-456", userId = "")
if ticketOpt.isSome:
  let ticket = ticketOpt.get()
  discard ticket

取得工單列表

參數

名稱	類型	必填	說明
tenantId	string	Yes
options	GetTicketsOptions	No

回應

回傳: Option[GetTicketsResponse]

範例

getTickets 範例

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # 根據需要使用 tickets

取得翻譯

參數

Name	Type	Required
namespace	string	否
component	string	否
options	GetTranslationsOptions	否

回傳

Returns: Option[GetTranslationsResponse]

範例

getTranslations 範例

Copy

let opts = GetTranslationsOptions()
let (maybeResp, httpResp) = client.getTranslations(namespace = "my-tenant-123", component = "news/article-title", options = opts)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

上傳圖片

Upload and resize an image

參數

名稱	類型	必填
tenantId	string	是
file	string	否
options	UploadImageOptions	否

回應

Returns: Option[UploadImageResponse]

範例

uploadImage 範例

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # 根據需要使用結果

依 ID 取得使用者徽章進度

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

回應

Returns: Option[APIGetUserBadgeProgressResponse]

範例

getUserBadgeProgressById 範例

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "badge-456")
if badgeProgressOpt.isSome:
  let badgeProgress = badgeProgressOpt.get()
  echo badgeProgress

依使用者 ID 取得徽章進度

參數

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

回應

返回: Option[APIGetUserBadgeProgressResponse]

範例

getUserBadgeProgressByUserId 範例

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if badgeProgressOpt.isSome:
  let progress = badgeProgressOpt.get()
  echo progress

取得使用者徽章進度列表

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetUserBadgeProgressListOptions	否

回應

回傳：Option[APIGetUserBadgeProgressListResponse]

範例

getUserBadgeProgressList 範例

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", options = GetUserBadgeProgressListOptions())
if response.isSome:
  let badgeProgress = response.get()

建立使用者徽章

參數

名稱	類型	必填	說明
tenantId	string	是
createUserBadgeParams	CreateUserBadgeParams	否

回應

返回：Option[APICreateUserBadgeResponse]

示例

createUserBadge 範例

Copy

let (badgeRespOpt, httpResp) = client.createUserBadge(tenantId = "my-tenant-123", createUserBadgeParams = default(CreateUserBadgeParams))
if badgeRespOpt.isSome:
  let badgeResp = badgeRespOpt.get()

刪除使用者徽章

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

回應

返回：Option[APIEmptySuccessResponse]

範例

deleteUserBadge 範例

Copy

let (apiResponse, httpResponse) = client.deleteUserBadge(tenantId = "my-tenant-123", id = "badge-456")
if apiResponse.isSome:
  let success = apiResponse.get()

取得使用者徽章

參數

Name	Type	Required	Description
tenantId	string	是
id	string	否

回應

返回: Option[APIGetUserBadgeResponse]

範例

getUserBadge 範例

Copy

let (badgeOpt, httpResp) = client.getUserBadge(tenantId = "my-tenant-123", id = "user-789")
if badgeOpt.isSome:
  let badge = badgeOpt.get()
  echo badge
else:
  echo "No badge found"
echo httpResp.statusCode

取得使用者徽章列表

參數

名稱	類型	必填	說明
tenantId	string	是
options	GetUserBadgesOptions	否

回應

返回: Option[APIGetUserBadgesResponse]

範例

getUserBadges 範例

Copy

let opts = GetUserBadgesOptions()
let (badgesOpt, httpResp) = client.getUserBadges(tenantId = "my-tenant-123", options = opts)
if badgesOpt.isSome:
  let badges = badgesOpt.get()

更新使用者徽章

參數

名稱	類型	必填
tenantId	string	Yes
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

回應

返回：Option[APIEmptySuccessResponse]

範例

updateUserBadge 範例

Copy

let params = UpdateUserBadgeParams()
let (maybeResp, httpResp) = client.updateUserBadge(tenantId = "my-tenant-123", id = "user-456", updateUserBadgeParams = params)
if maybeResp.isSome:
  let success = maybeResp.get()

取得使用者通知計數

參數

名稱	型別	必填	描述
tenantId	string	是
sso	string = ""	否

回應

回傳: Option[GetUserNotificationCountResponse]

範例

getUserNotificationCount 範例

Copy

let (optResp, httpResp) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

取得使用者通知

參數

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserNotificationsOptions	No

回應

Returns: Option[GetMyNotificationsResponse]

範例

getUserNotifications 範例

Copy

let (maybeResponse, httpResponse) = client.getUserNotifications(tenantId = "my-tenant-123", options = GetUserNotificationsOptions())
if maybeResponse.isSome:
  let notifications = maybeResponse.get()

重設使用者通知計數

參數

名稱	類型	必填	說明
tenantId	string	是
sso	string = ""	否

回應

返回: Option[ResetUserNotificationsResponse]

範例

resetUserNotificationCount 範例

Copy

let (resetRespOpt, httpResp) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "user-456")
if resetRespOpt.isSome:
  let resetResp = resetRespOpt.get()
  echo resetResp
else:
  echo "Reset notification count response not available"

重設使用者通知

參數

Name	Type	Required	Description
tenantId	string	是
options	ResetUserNotificationsOptions	否

回應

返回：Option[ResetUserNotificationsResponse]

範例

resetUserNotifications 範例

Copy

let (maybeResp, httpResp) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  options = ResetUserNotificationsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()

更新使用者對評論訂閱的通知狀態

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

Parameters

名稱	類型	必填
tenantId	string	是
notificationId	string	否
optedInOrOut	string	否
commentId	string	是
sso	string = ""	否

Response

返回：Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Example

updateUserNotificationCommentSubscriptionStatus 範例

Copy

let (optResp, httpResp) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted-in",
  commentId = "comment-789",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()

更新使用者對頁面訂閱的通知狀態

啟用或停用頁面的通知。當使用者訂閱頁面時，會為新的根評論建立通知，且還會

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

回應

返回：Option[UpdateUserNotificationPageSubscriptionStatusResponse]

範例

updateUserNotificationPageSubscriptionStatus 示例

Copy

let (optResp, httpResp) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  url = "https://example.com/news/article-456",
  pageTitle = "Breaking News: Something Happened",
  subscribedOrUnsubscribed = "subscribed",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  # 進一步處理 resp

更新使用者通知狀態

參數

名稱	類型	必填
tenantId	string	是
notificationId	string	否
newStatus	string	否
sso	string = ""	否

回應

返回：Option[UpdateUserNotificationStatusResponse]

範例

updateUserNotificationStatus 範例

Copy

let (respOpt, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = ""
)
if respOpt.isSome:
  let status = respOpt.get()

取得使用者在線狀態

參數

名稱	類型	必填
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

回應

返回: Option[GetUserPresenceStatusesResponse]

範例

getUserPresenceStatuses 範例

Copy

let (presenceOpt, httpResp) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user42")
if presenceOpt.isSome:
  let presence = presenceOpt.get()

搜尋使用者

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

回應

回傳: Option[SearchUsersResult]

範例

searchUsers 範例

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = SearchUsersOptions()
)
if response.isSome:
  let result = response.get()

取得使用者

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	否

回應

返回：Option[GetUserResponse]

範例

getUser 範例

Copy

let (userOpt, httpResp) = client.getUser(tenantId = "my-tenant-123", id = "user-456")
if userOpt.isSome:
  let user = userOpt.get()
  echo user
else:
  echo "User not found"

建立投票

參數

名稱	型別	必須
tenantId	string	是
commentId	string	是
direction	string	否
options	CreateVoteOptions	否

回應

回傳: Option[VoteResponse]

範例

createVote 範例

Copy

let (voteOpt, httpResp) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  direction = "up",
  options = CreateVoteOptions()
)
if voteOpt.isSome:
  let vote = voteOpt.get()
  echo vote

刪除投票

參數

名稱	類型	必填
tenantId	string	是
id	string	否
editKey	string = ""	否

回應

回傳: Option[VoteDeleteResponse]

範例

deleteVote 範例

Copy

let (voteRespOpt, httpResp) = client.deleteVote(tenantId = "my-tenant-123", id = "comment-456", editKey = "")
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()
  discard voteResp
  discard httpResp

取得投票列表

參數

名稱	類型	必填	說明
tenantId	string	是
urlId	string	是

回應

Returns: Option[GetVotesResponse]

範例

getVotes 範例

Copy

let (optVotes, httpResp) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/article-42")
if optVotes.isSome:
  let votes = optVotes.get()
  discard votes

取得使用者的投票

參數

名稱	類型	必要
tenantId	string	是
urlId	string	是
options	GetVotesForUserOptions	否

回應

返回：Option[GetVotesForUserResponse]

範例

getVotesForUser 範例

Copy

let (optResp, httpResp) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetVotesForUserOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

需要協助？

如果您在使用 Nim SDK 時遇到任何問題或有任何疑問，請：

貢獻

歡迎任何貢獻！請造訪 GitHub 儲存庫以取得貢獻指南。

語言 🇹🇼 繁體中文

文件

快速上手

API 參考

使用方式

彙總

稽核日誌

驗證

封鎖評論

檢查封鎖評論

評論

使用者的評論

網域設定

電子郵件範本

事件日誌

動態貼文

檢舉評論

動圖

標籤

審核

管理員

通知計數

通知

頁面反應

頁面

待處理的 Webhook 事件

問卷設定

問卷結果

問卷結果彙總

SSO 使用者

訂閱

租戶每日使用量

租戶方案

租戶使用者

租戶

工單

翻譯

上傳圖片

使用者徽章進度

使用者徽章

使用者通知

使用者在線狀態

使用者搜尋

使用者

投票

FastComments Nim 開發套件

儲存庫

需求

安裝

使用 Nimble

從原始碼建構

程式庫內容

公開與受保護的 API

快速開始

使用已驗證的 API（DefaultAPI）

使用公共 API（PublicAPI）

使用審核 API（ModerationAPI）

常見問題

發出 API 呼叫

範例：取得評論

備註

廣播 ID

SSO (單一登入)

SSO 使用方式

簡易 SSO

安全 SSO

fastcomments 文件

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

彙總

參數

回應

範例

取得稽核日誌

參數

回應

範例

公開登出