FastComments Nim SDK

• Nim >= 1.6.0
• nimcrypto >= 0.5.4

Nimble の使用

nimble install fastcomments

ソースからビルド

nimble build

ライブラリの内容

このライブラリには、生成された API クライアントと、API の使用を容易にする SSO ユーティリティが含まれています。

• API Client Library Docs

パブリック API とセキュア API

API クライアントには、api_default、api_public、api_moderation の 3 つの API モジュールがあります。api_default には API キーが必要なメソッドが含まれ、api_public には認証なしでブラウザやモバイルデバイス等から直接実行できる API 呼び出し
が含まれます。api_moderation モジュールにはモデレーターダッシュボード用のメソッドが含まれています。

api_moderation モジュールは、ライブおよび高速モデレーション API の幅広いスイートを提供します。すべての api_moderation メソッドは sso パラメータを受け取り、SSO または FastComments.com のセッションクッキーで認証できます。

認証済み 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"

# 認証済み API 呼び出しを行います。
# 必須パラメータ（およびリクエストボディ）は位置指定です；オプション
# パラメータは操作のオプションオブジェクトを介して渡されます。
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()

# パブリック API 呼び出しを行います。
# tenantId と urlId は必須（位置指定）です；それ以外はすべてオプションです。
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()

# モデレーション ダッシュボードのコメントを一覧表示します。
# この操作には必須パラメータがないため、すべてオプションです。
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 を使用してください。

このSDKのすべてのAPIメソッドは (Option[ResponseType], Response) のタプルを返します。最初の要素には成功した場合に解析されたレスポンスが含まれ、二番目の要素は生のHTTPレスポンスです。

必須パラメータとリクエストボディは位置引数として渡されます。残りのオプションパラメータは単一の Api<Operation>Options オブジェクトにまとめられ、これが最後の引数となります。オプションパラメータがない操作はオプションオブジェクトを取らないことになります。

Example: Fetching Comments

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.

Parameters

Response

Returns: Option[AggregateResponse]

Example

集計例

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

パラメータ

レスポンス

返り値: 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

Parameters

Response

返却: Option[PublicAPIDeleteCommentResponse]

Example

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

パラメータ

応答

戻り値: 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

パラメータ

レスポンス

返却: 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

パラメータ

レスポンス

返却: 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

パラメータ

レスポンス

戻り値: 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

パラメータ

レスポンス

戻り値: 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 # 必要に応じて resp を使用

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

Parameters

レスポンス

戻り値: 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

Parameters

Response

Returns: Option[GetEventLogResponse]

Example

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

req tenantId afterId

パラメータ

応答

戻り値: 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

パラメータ

レスポンス

戻り値: 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

パラメータ

応答

戻り値: 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

パラメータ

レスポンス

戻り値: 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

パラメータ