FastComments Nim 開發套件

• 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"

常見問題

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

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

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

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

參數

回應

回傳: Option[AggregateResponse]

範例

彙總範例

Copy

1

2let (aggResp, httpResp) = client.aggregate(tenantId = "my-tenant-123", aggregationRequest = AggregationRequest(), options = AggregateOptions())

3if aggResp.isSome:

4 let response = aggResp.get()

5 echo response

6echo httpResp

7

參數

回應

返回：Option[GetAuditLogsResponse]

範例

getAuditLogs 範例

Copy

1

2let (auditOpt, httpResp) = client.getAuditLogs(tenantId = "my-tenant-123", options = GetAuditLogsOptions())

3if auditOpt.isSome:

4 let audit = auditOpt.get()

5 echo audit

6

回應

返回：Option[APIEmptyResponse]

範例

logoutPublic 範例

Copy

1

2let (responseOpt, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", userId = "user-456")

3if responseOpt.isSome:

4 let emptyResponse = responseOpt.get()

5

參數

回應

Returns: Option[BlockSuccess]

範例

blockFromCommentPublic 範例

Copy

1

2let (blockOpt, httpResp) = client.blockFromCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(),

6 sso = ""

7)

8

9if blockOpt.isSome:

10 let block = blockOpt.get()

11

參數

回應

返回：Option[UnblockSuccess]

範例

unBlockCommentPublic 範例

Copy

1

2let (unblockResult, httpResp) = client.unBlockCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "comment-7890",

5 publicBlockFromCommentParams = PublicBlockFromCommentParams(),

6 sso = ""

7)

8

9if unblockResult.isSome:

10 let result = unblockResult.get()

11

參數

回應

返回: Option[CheckBlockedCommentsResponse]

範例

checkedCommentsForBlocked 範例

Copy

1

2let (maybeResponse, httpResponse) = client.checkedCommentsForBlocked(

3 tenantId = "my-tenant-123",

4 commentIds = "cmt-1,cmt-2",

5 sso = ""

6)

7

8if maybeResponse.isSome:

9 let response = maybeResponse.get()

10 discard response

11

參數

回應

返回：Option[BlockSuccess]

範例

blockUserFromComment 範例

Copy

1

2let params = BlockFromCommentParams()

3let opts = BlockUserFromCommentOptions()

4let (blockResult, httpResp) = client.blockUserFromComment(

5 tenantId = "my-tenant-123",

6 id = "comment-456",

7 blockFromCommentParams = params,

8 options = opts

9)

10if blockResult.isSome:

11 let success = blockResult.get()

12 discard success

13

參數

回應

回傳：Option[SaveCommentsResponseWithPresence]

範例

createCommentPublic 範例

Copy

1

2let

3 tenantId = "my-tenant-123"

4 urlId = "news/article-title"

5 broadcastId = "broadcast-456"

6 commentData = CommentData()

7 options = CreateCommentPublicOptions()

8let (maybeResp, httpResp) = client.createCommentPublic(

9 tenantId = tenantId,

10 urlId = urlId,

11 broadcastId = broadcastId,

12 commentData = commentData,

13 options = options)

14

15if maybeResp.isSome:

16 let resp = maybeResp.get()

17 echo resp

18

參數

回應

返回：Option[DeleteCommentResult]

範例

deleteComment 範例

Copy

1

2let (delResult, httpResponse) = client.deleteComment(

3 tenantId = "my-tenant-123",

4 id = "comment-456",

5 options = DeleteCommentOptions()

6)

7

8if delResult.isSome:

9 let result = delResult.get()

10 echo result

11

參數

回應

回傳：Option[PublicAPIDeleteCommentResponse]

範例

deleteCommentPublic 範例

Copy

1

2let (responseOpt, httpResp) = client.deleteCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "",

6 options = DeleteCommentPublicOptions())

7if responseOpt.isSome:

8 let resp = responseOpt.get()

9 echo resp

10

參數

回應

返回：Option[VoteDeleteResponse]

範例

deleteCommentVote 範例

Copy

1

2let (response, httpResponse) = client.deleteCommentVote(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456",

5 voteId = "vote-789",

6 urlId = "news/article-title",

7 broadcastId = "broadcast-001",

8 options = DeleteCommentVoteOptions()

9)

10

11if response.isSome:

12 let voteDelete = response.get()

13

參數

回應

回傳：Option[FlagCommentResponse]

範例

flagComment 範例

Copy

1

2let options = FlagCommentOptions(reason: "spam content", note: "Automated posting detected", isSpam: true, categories: @["spam"])

3let (flagRes, httpRes) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-789", options = options)

4if flagRes.isSome:

5 let res = flagRes.get()

6 discard res

7

參數

回應

返回：Option[APIGetCommentResponse]

範例

getComment 範例

Copy

1

2let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-789")

3if response.isSome:

4 let comment = response.get()

5 discard comment

6

參數

回應

返回：Option[APIGetCommentsResponse]

範例

getComments 範例

Copy

1

2let options = GetCommentsOptions(

3 urlId = "news/article-title",

4 page = 0,

5 pageSize = 20,

6 sort = "newest",

7 includeDeleted = false,

8 includeReplies = true,

9 userIds = @[],

10 tags = @[]

11)

12

13let (response, httpResponse) = client.getComments(tenantId = "my-tenant-123", options = options)

14

15if response.isSome:

16 let comments = response.get()

17 discard comments

18

req tenantId urlId

參數

回應

返回：Option[GetCommentsResponseWithPresencePublicComment]

範例

getCommentsPublic 範例

Copy

1

2let (optResp, httpResp) = client.getCommentsPublic(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 options = GetCommentsPublicOptions(

6 page = 0,

7 pageSize = 10,

8 includeDeleted = false,

9 tags = @[]

10 )

11)

12

13if optResp.isSome:

14 let resp = optResp.get()

15 echo resp

16

參數

回應

返回：Option[PublicAPIGetCommentTextResponse]

範例

getCommentText 範例

Copy

1

2let (maybeResponse, httpResponse) = client.getCommentText(

3 tenantId = "my-tenant-123",

4 commentId = "comment-456",

5 options = GetCommentTextOptions()

6)

7

8if maybeResponse.isSome:

9 let response = maybeResponse.get()

10

參數

回應

返回：Option[GetCommentVoteUserNamesSuccessResponse]

範例

getCommentVoteUserNames 範例

Copy

1

2let (voteNamesOpt, httpRes) = client.getCommentVoteUserNames(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-987654321",

5 dir = 0,

6 sso = ""

7)

8

9if voteNamesOpt.isSome:

10 let voteNames = voteNamesOpt.get()

11 echo voteNames

12

參數

回應

返回：Option[APIEmptyResponse]

範例

lockComment 範例

Copy

1

2let (lockResult, httpRes) = client.lockComment(

3 tenantId = "my-tenant-123",

4 commentId = "comment-456",

5 broadcastId = "",

6 sso = "")

7

8if lockResult.isSome:

9 let resp = lockResult.get()

10 discard resp

11

參數

回應

返回：Option[ChangeCommentPinStatusResponse]

範例

pinComment 範例

Copy

1

2let (pinResult, httpResp) = client.pinComment(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "broadcast-001",

6 sso = "",

7)

8

9if pinResult.isSome:

10 let response = pinResult.get()

11 echo response

12

參數

回應

Returns: Option[APISaveCommentResponse]

範例

saveComment 範例

Copy

1

2let commentParams = CreateCommentParams(

3 body: "Great read, thanks!",

4 name: "Alice Smith",

5 email: "alice@example.com",

6 parentId: ""

7)

8

9let saveOpts = SaveCommentOptions(

10 isPreview: false,

11 isApproved: true,

12 skipSpamCheck: false

13)

14

15let (apiResponse, httpResponse) = client.saveComment(

16 tenantId = "my-tenant-123",

17 createCommentParams = commentParams,

18 options = saveOpts

19)

20

21if apiResponse.isSome:

22 let saved = apiResponse.get()

23 echo saved

24

參數

回應

返回：Option[APIEmptyResponse]

範例

saveCommentsBulk 範例

Copy

1

2let (response, httpResponse) = client.saveCommentsBulk(

3 tenantId = "my-tenant-123",

4 createCommentParams = @[],

5 options = SaveCommentsBulkOptions(),

6 id = "",

7 fromName = ""

8)

9

10if response.isSome:

11 let result = response.get()

12

參數

回應

Returns: Option[PublicAPISetCommentTextResponse]

範例

setCommentText 範例

Copy

1

2let commentUpdate = CommentTextUpdateRequest(text: "Updated comment text")

3let opts = SetCommentTextOptions()

4let (response, httpResponse) = client.setCommentText(

5 tenantId = "my-tenant-123",

6 commentId = "cmt-456",

7 broadcastId = "broadcast-789",

8 commentTextUpdateRequest = commentUpdate,

9 options = opts)

10if response.isSome:

11 let result = response.get()

12

參數

回應

回傳: Option[UnblockSuccess]

範例

unBlockUserFromComment 範例

Copy

1

2let (response, httpResponse) = client.unBlockUserFromComment(

3 tenantId = "my-tenant-123",

4 id = "comment-456",

5 unBlockFromCommentParams = UnBlockFromCommentParams(userId = "user-789", commentId = "cmt-321"),

6 options = UnBlockUserFromCommentOptions(),

7)

8

9if response.isSome:

10 let unblockSuccess = response.get()

11

參數

回應

返回：Option[FlagCommentResponse]

範例

unFlagComment 範例

Copy

1

2let (flagRespOpt, httpResp) = client.unFlagComment(tenantId = "my-tenant-123", id = "comment-456", options = UnFlagCommentOptions())

3if flagRespOpt.isSome:

4 let flagResp = flagRespOpt.get()

5

參數

回應

返回：Option[APIEmptyResponse]

範例

unLockComment 範例

Copy

1

2let (maybeEmpty, httpResp) = client.unLockComment(tenantId = "my-tenant-123", commentId = "comment-456", broadcastId = "", sso = "")

3if maybeEmpty.isSome:

4 let emptyResp = maybeEmpty.get()

5 echo "Comment unlocked"

6else:

7 echo "Failed to unlock comment"

8

參數

回應

Returns: Option[ChangeCommentPinStatusResponse]

範例

unPinComment 範例

Copy

1

2let (responseOpt, httpResponse) = client.unPinComment(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 broadcastId = "broadcast-001",

6 sso = ""

7)

8

9if responseOpt.isSome:

10 let resp = responseOpt.get()

11 echo resp

12

參數

回應

返回: Option[APIEmptyResponse]

範例

updateComment 範例

Copy

1

2let commentParams = UpdatableCommentParams(content: "Updated comment content")

3let updateOpts = UpdateCommentOptions(force: false)

4

5let (respOpt, httpResp) = client.updateComment(

6 tenantId = "my-tenant-123",

7 id = "comment-456",

8 updatableCommentParams = commentParams,

9 options = updateOpts

10)

11

12if respOpt.isSome:

13 let resp = respOpt.get()

14

參數

回應

返回: Option[VoteResponse]

範例

voteComment 範例

Copy

1

2let (voteRespOpt, httpResp) = client.voteComment(

3 tenantId = "my-tenant-123",

4 commentId = "comment-98765",

5 urlId = "blog/how-to-code",

6 broadcastId = "",

7 voteBodyParams = VoteBodyParams(),

8 options = VoteCommentOptions()

9)

10

11if voteRespOpt.isSome:

12 let voteResp = voteRespOpt.get()

13

參數

回應

回傳: Option[GetCommentsForUserResponse]

範例

getCommentsForUser 範例

Copy

1

2let (maybeResp, httpResp) = client.getCommentsForUser(options = GetCommentsForUserOptions(

3 tenantId = "my-tenant-123",

4 userId = "user-456",

5 page = 0,

6 pageSize = 20,

7 includeDeleted = false,

8 commentIds = @[]

9))

10

11if maybeResp.isSome:

12 let resp = maybeResp.get()

13 discard resp

14

參數

回應

返回: Option[AddDomainConfigResponse]

範例

addDomainConfig 範例

Copy

1

2let (respOpt, httpResp) = client.addDomainConfig(

3 tenantId = "my-tenant-123",

4 addDomainConfigParams = default(AddDomainConfigParams)

5)

6

7if respOpt.isSome:

8 let cfg = respOpt.get()

9

參數

回應

返回: Option[DeleteDomainConfigResponse]

範例

deleteDomainConfig 範例

Copy

1

2let (optResp, httpResp) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")

3if optResp.isSome:

4 let resp = optResp.get()

5 echo resp

6

參數

回應

返回: Option[GetDomainConfigResponse]

範例

getDomainConfig 範例

Copy

1

2let (configOpt, httpResp) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")

3if configOpt.isSome:

4 let cfg = configOpt.get()

5 discard cfg

6

參數

回應

返回：Option[GetDomainConfigsResponse]

範例

getDomainConfigs 範例

Copy

1

2let (domainConfigsOpt, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")

3if domainConfigsOpt.isSome:

4 let domainConfigs = domainConfigsOpt.get()

5 echo domainConfigs

6

參數

回應

返回：Option[PatchDomainConfigResponse]

範例

patchDomainConfig 範例

Copy

1

2let (optResp, httpResp) = client.patchDomainConfig(

3 tenantId = "my-tenant-123",

4 domainToUpdate = "news.mywebsite.com",

5 patchDomainConfigParams = PatchDomainConfigParams()

6)

7

8if optResp.isSome:

9 let resp = optResp.get()

10 echo resp

11

參數

回應

Returns: Option[PutDomainConfigResponse]

範例

putDomainConfig 範例

Copy

1

2let (optResp, httpResp) = client.putDomainConfig(

3 tenantId = "my-tenant-123",

4 domainToUpdate = "example.com",

5 updateDomainConfigParams = UpdateDomainConfigParams()

6)

7

8if optResp.isSome:

9 let resp = optResp.get()

10 echo resp

11

參數

回應

回傳: Option[CreateEmailTemplateResponse]

範例

createEmailTemplate 範例

Copy

1

2let createBody = CreateEmailTemplateBody(

3 name: "Welcome Email",

4 subject: "Welcome to FastComments",

5 htmlBody: "<p>Hello, thank you for joining us!</p>",

6 isActive: true,

7 tags: @[]

8)

9

10let (optResp, httpResp) = client.createEmailTemplate(

11 tenantId = "my-tenant-123",

12 createEmailTemplateBody = createBody

13)

14

15if optResp.isSome:

16 let emailTemplate = optResp.get()

17

參數

回應

返回：Option[APIEmptyResponse]

示例

deleteEmailTemplate 示例

Copy

1

2let (respOpt, httpResp) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")

3if respOpt.isSome:

4 let emptyResp = respOpt.get()

5 echo "Email template deleted"

6else:

7 echo "Failed to delete email template"

8

參數

回應

返回: Option[APIEmptyResponse]

範例

deleteEmailTemplateRenderError 範例

Copy

1

2let (apiRes, httpRes) = client.deleteEmailTemplateRenderError(

3 tenantId = "my-tenant-123",

4 id = "welcome-email",

5 errorId = "render-err-456"

6)

7

8if apiRes.isSome:

9 let empty = apiRes.get()

10

參數

回應

Returns: Option[GetEmailTemplateResponse]

範例

getEmailTemplate 範例

Copy

1

2let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")

3if response.isSome:

4 let tmpl = response.get()

5

參數

回應

返回: Option[GetEmailTemplateDefinitionsResponse]

範例

getEmailTemplateDefinitions 範例

Copy

1

2let (responseOpt, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")

3if responseOpt.isSome:

4 let definitions = responseOpt.get()

5 echo definitions

6

參數

回應

回傳: Option[GetEmailTemplateRenderErrorsResponse]

範例

getEmailTemplateRenderErrors 範例

Copy

1

2let (optResp, httpResp) = client.getEmailTemplateRenderErrors(

3 tenantId = "my-tenant-123",

4 id = "welcome-template",

5 skip = 0.0

6)

7

8if optResp.isSome:

9 let resp = optResp.get()

10 # 依需求使用回應

11else:

12 # 處理缺少的回應

13 discard

14

參數

回應

返回: Option[GetEmailTemplatesResponse]

範例

getEmailTemplates 範例

Copy

1

2let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)

3if emailTemplatesOpt.isSome:

4 let templates = emailTemplatesOpt.get()

5 echo templates

6

參數

回應

返回：Option[RenderEmailTemplateResponse]

範例

renderEmailTemplate 範例

Copy

1

2let body = RenderEmailTemplateBody()

3let (responseOpt, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = body, locale = "en-US")

4if responseOpt.isSome:

5 let response = responseOpt.get()

6 discard response

7discard httpResponse

8

參數

回應

返回: Option[APIEmptyResponse]

範例

updateEmailTemplate 範例

Copy

1

2let updateBody = UpdateEmailTemplateBody(

3 subject: "Welcome to FastComments",

4 body: "Hello \{{user_name}}, thanks for joining!",

5 enabled: true,

6)

7

8let (maybeResp, httpResp) = client.updateEmailTemplate(

9 tenantId = "my-tenant-123",

10 id = "welcome-email",

11 updateEmailTemplateBody = updateBody,

12)

13

14if maybeResp.isSome:

15 let resp = maybeResp.get()

16

req tenantId urlId userIdWS

參數

回應

回傳: Option[GetEventLogResponse]

範例

getEventLog 範例

Copy

1

2let (eventLogOpt, httpResp) = client.getEventLog(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 userIdWS = "",

6 startTime = 0'i64,

7 endTime = 0'i64,

8)

9

10if eventLogOpt.isSome:

11 let eventLog = eventLogOpt.get()

12 echo eventLog

13

req tenantId urlId userIdWS

參數

回應

返回：Option[GetEventLogResponse]

範例

getGlobalEventLog 範例

Copy

1

2let (eventLogOpt, httpResp) = client.getGlobalEventLog(

3 tenantId = "my-tenant-123",

4 urlId = "news/article-title",

5 userIdWS = "user-456",

6 startTime = 1700000000'i64,

7 endTime = 1700003600'i64,

8)

9

10if eventLogOpt.isSome:

11 let eventLog = eventLogOpt.get()

12 echo eventLog

13

參數

回應

返回：Option[CreateFeedPostsResponse]

範例

createFeedPost 範例

Copy

1

2let (respOpt, httpResp) = client.createFeedPost(

3 tenantId = "my-tenant-123",

4 createFeedPostParams = CreateFeedPostParams(),

5 options = CreateFeedPostOptions()

6)

7

8if respOpt.isSome:

9 let feedPost = respOpt.get()

10

參數

回應

返回：Option[CreateFeedPostResponse]

範例

createFeedPostPublic 範例

Copy

1

2let params = CreateFeedPostParams(

3 urlId: "news/big-event",

4 title: "Big Event Happened",

5 content: "Full article content goes here.",

6 tags: @["news", "event"]

7)

8

9let opts = CreateFeedPostPublicOptions(

10 sendNotifications: false,

11 allowComments: true

12)

13

14let (response, httpResponse) = client.createFeedPostPublic(

15 tenantId = "my-tenant-123",

16 createFeedPostParams = params,

17 options = opts

18)

19

20if response.isSome:

21 let post = response.get()

22 echo post

23

參數

回應

返回: Option[DeleteFeedPostPublicResponse]

範例

deleteFeedPostPublic 範例

Copy

1

2let (response, httpResponse) = client.deleteFeedPostPublic(

3 tenantId = "my-tenant-123",

4 postId = "news/article-42",

5 options = DeleteFeedPostPublicOptions()

6)

7

8if response.isSome:

9 let deleteResp = response.get()

10

req tenantId afterId

參數

回應

返回：Option[GetFeedPostsResponse]

範例

getFeedPosts 範例

Copy

1

2let (feedResponseOpt, httpResp) = client.getFeedPosts(tenantId = "my-tenant-123", options = GetFeedPostsOptions())

3if feedResponseOpt.isSome:

4 let feedResponse = feedResponseOpt.get()

5 echo feedResponse

6

請求 tenantId afterId

參數

回應

Returns: Option[PublicFeedPostsResponse]

範例

getFeedPostsPublic 示例

Copy

1

2let (feedResponseOpt, httpResponse) = client.getFeedPostsPublic(tenantId = "my-tenant-123", options = GetFeedPostsPublicOptions())

3if feedResponseOpt.isSome:

4 let feedResponse = feedResponseOpt.get()

5

參數

回應

Returns: Option[FeedPostsStatsResponse]

範例

getFeedPostsStats 範例

Copy

1

2let (statsOpt, httpResponse) = client.getFeedPostsStats(

3 tenantId = "my-tenant-123",

4 postIds = @["post-abc", "post-def"],

5 sso = "sso-token",

6)

7

8if statsOpt.isSome:

9 let stats = statsOpt.get()

10 # 根據需要使用 stats

11

12

13

參數

回應

返回: Option[UserReactsResponse]

範例

getUserReactsPublic 範例

Copy

1

2let opts = GetUserReactsPublicOptions(

3 limit = 20,

4 offset = 0,

5 includeDeleted = false

6)

7

8let (response, httpResponse) = client.getUserReactsPublic(

9 tenantId = "my-tenant-123",

10 options = opts

11)

12

13if response.isSome:

14 let userReacts = response.get()

15

參數

回應

回傳：Option[ReactFeedPostResponse]

範例

reactFeedPostPublic 範例

Copy

1

2let reactParams = ReactBodyParams()

3let (optResp, httpResp) = client.reactFeedPostPublic(

4 tenantId = "my-tenant-123",

5 postId = "post-456",

6 reactBodyParams = reactParams,

7 options = ReactFeedPostPublicOptions()

8)

9if optResp.isSome:

10 let resp = optResp.get()

11 echo resp

12

參數

回應

返回: Option[APIEmptyResponse]

範例

updateFeedPost 範例

Copy

1

2let feedPost = FeedPost(

3 title: "Breaking News",

4 content: "Updated story content",

5 tags: @["news", "update"]

6)

7

8let (apiRes, httpRes) = client.updateFeedPost(

9 tenantId = "my-tenant-123",

10 id = "post-456",

11 feedPost = feedPost

12)

13

14if apiRes.isSome:

15 let res = apiRes.get()

16

參數

回應

返回: Option[CreateFeedPostResponse]

範例

updateFeedPostPublic 範例

Copy

1

2let (response, httpResponse) = client.updateFeedPostPublic(

3 tenantId = "my-tenant-123",

4 postId = "post-789",

5 updateFeedPostParams = UpdateFeedPostParams(),

6 options = UpdateFeedPostPublicOptions()

7)

8

9if response.isSome:

10 let post = response.get()

11

參數

回應

返回: Option[APIEmptyResponse]

示例

flagCommentPublic 示例

Copy

1

2let (optResp, httpResp) = client.flagCommentPublic(

3 tenantId = "my-tenant-123",

4 commentId = "cmt-456789",

5 isFlagged = true,

6 sso = ""

7)

8

9if optResp.isSome:

10 let empty = optResp.get()

11 discard empty

12

參數

回應

返回: Option[GifGetLargeResponse]

範例

getGifLarge 範例

Copy

1

2let (gifOpt, httpResp) = client.getGifLarge(

3 tenantId = "my-tenant-123",

4 largeInternalURLSanitized = "https://cdn.example.com/gifs/large123.gif")

5if gifOpt.isSome:

6 let gif = gifOpt.get()

7 echo gif

8

參數

回應

返回：Option[GetGifsSearchResponse]

範例

getGifsSearch 範例

Copy

1

2let opts = GetGifsSearchOptions(limit = 10, rating = "g")

3let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)

4if responseOpt.isSome:

5 let resp = responseOpt.get()

6 # 使用 resp 如需

7

參數

回應

返回：Option[GetGifsTrendingResponse]

範例

getGifsTrending 範例

Copy

1

2let (maybeResponse, httpResponse) = client.getGifsTrending(

3 tenantId = "my-tenant-123",

4 options = GetGifsTrendingOptions()

5)

6

7if maybeResponse.isSome:

8 let gifs = maybeResponse.get()

9 echo gifs

10

參數

回應

Returns: Option[CreateHashTagResponse]

範例

addHashTag 範例

Copy

1

2let (hashTagOpt, httpResp) = client.addHashTag(

3 tenantId = "my-tenant-123",

4 createHashTagBody = CreateHashTagBody(),

5)

6

7if hashTagOpt.isSome:

8 let tag = hashTagOpt.get()

9

參數

回應

返回: Option[BulkCreateHashTagsResponse]

範例

addHashTagsBulk 範例

Copy

1

2let (optResp, httpResp) = client.addHashTagsBulk(

3 tenantId = "my-tenant-123",

4 bulkCreateHashTagsBody = BulkCreateHashTagsBody(

5 hashTags = @["news", "technology"]

6 )

7)

8

9if optResp.isSome:

10 let resp = optResp.get()

11

參數

回應

Returns: Option[APIEmptyResponse]

範例

deleteHashTag 範例

Copy

1

2let (apiResp, httpResp) = client.deleteHashTag(tenantId = "my-tenant-123", tag = "sports", deleteHashTagRequestBody = DeleteHashTagRequestBody())

3if apiResp.isSome:

4 let emptyResp = apiResp.get()

5