FastComments Nim SDK

例

logoutPublic の例

Copy

let (response, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", sessionId = "sess-9a8b7c6d", userId = "editor-87", revokeAll = false, ipAddress = "")
if response.isSome:
  let emptyResp = response.get()
  echo "Logout successful for user: ", "editor-87"
else:
  echo "Logout failed"

コメントからブロック（公開）

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
publicBlockFromCommentParams	PublicBlockFromCommentParams	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[BlockSuccess]

例

blockFromCommentPublic の例

Copy

let publicParams = PublicBlockFromCommentParams(
  reason = "Repeated spam links",
  durationMinutes = 1440,
  blockAll = true,
  notifyUser = false,
  tags = @["spam", "auto-block"]
)
let (response, httpResponse) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  publicBlockFromCommentParams = publicParams,
  sso = ""
)
if response.isSome:
  let blockResult = response.get()
  echo "Block succeeded: ", $blockResult
else:
  echo "Block failed, HTTP status: ", $httpResponse.status

コメントブロック解除（公開）

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
publicBlockFromCommentParams	PublicBlockFromCommentParams	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[UnblockSuccess]

例

unBlockCommentPublic の例

Copy

let (response, httpResponse) = client.unBlockCommentPublic(tenantId = "my-tenant-123", commentId = "cmt-987654321", publicBlockFromCommentParams = PublicBlockFromCommentParams(), sso = "")
if response.isSome:
  let unblockResult = response.get()
  discard unblockResult
else:
  discard httpResponse

ブロック済みコメントの確認

パラメータ

名前	型	必須
tenantId	string	はい
commentIds	string	いいえ
sso	string	いいえ

レスポンス

返却: Option[CheckBlockedCommentsResponse]

例

checkedCommentsForBlocked の例

Copy

let (response, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "",
  sso = ""
)
if response.isSome:
  let blockedResp = response.get()
  echo "Received blocked comments response: ", blockedResp
else:
  echo "No response body; HTTP status: ", $httpResponse.status

コメントからユーザーをブロック

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
blockFromCommentParams	BlockFromCommentParams	いいえ
userId	string	いいえ
anonUserId	string	いいえ

レスポンス

返り値: Option[BlockSuccess]

例

blockUserFromComment の例

Copy

let (response, httpResponse) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "cmt-7890",
  blockFromCommentParams = BlockFromCommentParams(
    reason = "Repeated abusive language",
    durationMinutes = 1440,
    notifyUser = true,
    tags = @["abuse", "automated"]
  ),
  userId = "user-456",
  anonUserId = ""
)
if response.isSome:
  let result = response.get()
  discard result
else:
  discard httpResponse

コメントを作成（公開）

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
broadcastId	string	いいえ
commentData	CommentData	いいえ
sessionId	string	いいえ
sso	string	いいえ

レスポンス

返却値: Option[SaveCommentsResponseWithPresence]

例

createCommentPublic の例

Copy

let commentPayload = CommentData(
  text = "Great write-up on serverless architectures.",
  authorName = "Jane Doe",
  authorEmail = "jane.doe@example.com",
  isPublic = true,
  tags = @["tech", "serverless"]
)
let (response, httpResponse) = client.createCommentPublic(
  tenantId = "my-tenant-123",
  urlId = "news/2026/06/fastcomments-sdk-update",
  broadcastId = "broadcast-2026-06-19",
  commentData = commentPayload,
  sessionId = "sess-8a7b6c",
  sso = "sso-jwt-abc123"
)
if response.isSome:
  let saved = response.get()
  discard saved

コメントを削除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
contextUserId	string	いいえ
isLive	bool	いいえ

レスポンス

戻り値: Option[DeleteCommentResult]

例

deleteComment の例

Copy

let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "cmt-98765", contextUserId = "user-456", isLive = true)
if response.isSome:
  let result = response.get()
  echo "DeleteCommentResult received"
else:
  echo "No result, HTTP status: ", httpResponse.status

コメントを削除（公開）

パラメータ

名前	型	必須
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
editKey	string	No
sso	string	No

レスポンス

戻り値: Option[PublicAPIDeleteCommentResponse]

例

deleteCommentPublic の例

Copy

let (response, httpResponse) = client.deleteCommentPublic(tenantId = "my-tenant-123", commentId = "cmt-987654321", broadcastId = "", editKey = "", sso = "")
if response.isSome:
  let deleted = response.get()
  echo "Delete acknowledged, HTTP status: ", httpResponse.status

コメント投票を削除

パラメータ

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
editKey	string	No
sso	string	No

レスポンス

返却: Option[VoteDeleteResponse]

例

deleteCommentVote の例

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  voteId = "vote-789",
  urlId = "news/article-title",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  echo "Vote delete response:", voteResp
else:
  echo "No response body, HTTP response:", httpResponse

コメントを通報

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
userId	string	いいえ
anonUserId	string	いいえ

レスポンス

戻り値: Option[FlagCommentResponse]

例

flagComment の例

Copy

let (response, httpResponse) = client.flagComment(
  tenantId = "my-tenant-123",
  id = "cmt-98765",
  userId = "user-12345",
  anonUserId = ""
)
if response.isSome:
  let flagResp = response.get()
  echo "Flag response received"
else:
  echo "No flag response returned"

コメントを取得

Parameters

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[APIGetCommentResponse]

例

getComment の例

Copy

let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-7890")
if response.isSome:
  let comment = response.get()
  discard comment
else:
  echo "Comment not found"

コメント一覧を取得

パラメータ

Name	Type	Required
tenantId	string	はい
page	int	いいえ
limit	int	いいえ
skip	int	いいえ
asTree	bool	いいえ
skipChildren	int	いいえ
limitChildren	int	いいえ
maxTreeDepth	int	いいえ
urlId	string	はい
userId	string	いいえ
anonUserId	string	いいえ
contextUserId	string	いいえ
hashTag	string	いいえ
parentId	string	いいえ
direction	SortDirections	いいえ
fromDate	int64	いいえ
toDate	int64	いいえ

レスポンス

戻り値: Option[APIGetCommentsResponse]

例

getComments の例

Copy

let (response, httpResponse) = client.getComments(
  tenantId = "my-tenant-123",
  page = 1,
  limit = 25,
  skip = 0,
  asTree = true,
  skipChildren = 0,
  limitChildren = 5,
  maxTreeDepth = 3,
  urlId = "news/2026-global-economy",
  userId = "user-789",
  anonUserId = "",
  contextUserId = "",
  hashTag = "economy",
  parentId = "",
  direction = SortDirections.Desc,
  fromDate = 1710000000000'i64,
  toDate = 1710100000000'i64
)
if response.isSome:
  let commentsResp = response.get()
  discard commentsResp

コメント一覧を取得（公開）

req tenantId urlId

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
page	int	いいえ
direction	SortDirections	いいえ
sso	string	いいえ
skip	int	いいえ
skipChildren	int	いいえ
limit	int	いいえ
limitChildren	int	いいえ
countChildren	bool	いいえ
fetchPageForCommentId	string	いいえ
includeConfig	bool	いいえ
countAll	bool	いいえ
includei10n	bool	いいえ
locale	string	いいえ
modules	string	いいえ
isCrawler	bool	いいえ
includeNotificationCount	bool	いいえ
asTree	bool	いいえ
maxTreeDepth	int	いいえ
useFullTranslationIds	bool	いいえ
parentId	string	いいえ
searchText	string	いいえ
hashTags	seq[string]	いいえ
userId	string	いいえ
customConfigStr	string	いいえ
afterCommentId	string	いいえ
beforeCommentId	string	いいえ

レスポンス

戻り値: Option[GetCommentsResponseWithPresencePublicComment]

例

getCommentsPublic の例

Copy

let (response, httpResponse) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  page = 2,
  direction = SortDirections.Descending,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 25,
  limitChildren = 5,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = true,
  countAll = false,
  includei10n = true,
  locale = "en-US",
  modules = "reactions,moderation",
  isCrawler = false,
  includeNotificationCount = true,
  asTree = true,
  maxTreeDepth = 3,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "climate change",
  hashTags = @["climate", "research"],
  userId = "user-789",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)
if response.isSome:
  let commentsResp = response.get()
  echo "Received comments response:"
  echo commentsResp
else:
  echo "No comments returned. HTTP status:", httpResponse.status

コメント本文を取得

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
editKey	string	いいえ
sso	string	いいえ

レスポンス

返却: Option[PublicAPIGetCommentTextResponse]

例

getCommentText の例

Copy

let (response, httpResponse) = client.getCommentText(tenantId = "my-tenant-123", commentId = "cmt-987654321", editKey = "", sso = "")
if response.isSome:
  let commentTextResp = response.get()
  echo commentTextResp
else:
  echo "No comment text returned"

コメント投票ユーザー名を取得

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
dir	int	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[GetCommentVoteUserNamesSuccessResponse]

例

getCommentVoteUserNames の例

Copy

let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "cmt-987654", dir = 0, sso = "")
if response.isSome:
  let success: GetCommentVoteUserNamesSuccessResponse = response.get()
  discard success

コメントをロック

Parameters

Name	Type	Required
tenantId	string	はい
commentId	string	はい
broadcastId	string	いいえ
sso	string	いいえ

Response

例

lockComment の例

Copy

let (response, httpResponse) = client.lockComment(tenantId = "news-tenant-42", commentId = "cmt-8f3a2b9d", broadcastId = "", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Locked comment successfully for tenant news-tenant-42"
else:
  echo "Failed to lock comment, HTTP status: ", $httpResponse.status

コメントをピン留め

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[ChangeCommentPinStatusResponse]

例

pinComment の例

Copy

let (response, httpResponse) = client.pinComment(tenantId = "my-tenant-123", commentId = "cmt-98765", broadcastId = "", sso = "")
if response.isSome:
  let pinnedResp = response.get()
  echo "Pin status updated for comment cmt-98765"
else:
  echo "No response received"

コメントを保存

パラメータ

名前	型	必須
tenantId	string	はい
createCommentParams	CreateCommentParams	いいえ
isLive	bool	いいえ
doSpamCheck	bool	いいえ
sendEmails	bool	いいえ
populateNotifications	bool	いいえ

レスポンス

返却値: Option[APISaveCommentResponse]

例

saveComment の例

Copy

let createCommentParams = CreateCommentParams(
  urlId = "news/2026/major-policy-change",
  content = "This is a thoughtful comment on the policy change and its potential impacts.",
  authorName = "Morgan Lee",
  authorEmail = "morgan.lee@example.org",
  tags = @["policy","analysis"],
  extraData = @[])
let (response, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = createCommentParams,
  isLive = true,
  doSpamCheck = true,
  sendEmails = false,
  populateNotifications = true)
if response.isSome:
  let saved = response.get()
  discard saved

コメントを一括保存

パラメータ

名前	型	必須
tenantId	string	はい
createCommentParams	seq[CreateCommentParams]	いいえ
isLive	bool	いいえ
doSpamCheck	bool	いいえ
sendEmails	bool	いいえ
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	いいえ
id	string	いいえ
fromName	string	いいえ

レスポンス

例

saveCommentsBulk の例

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  isLive = false,
  doSpamCheck = false,
  sendEmails = false,
  populateNotifications = false,
  id = "",
  fromName = ""
)
if response.isSome:
  let apiResp = response.get()
  echo "Bulk save succeeded, tenant:", " my-tenant-123"
else:
  echo "Bulk save returned no API response"

コメント本文を設定

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	いいえ
commentTextUpdateRequest	CommentTextUpdateRequest	いいえ
editKey	string	いいえ
sso	string	いいえ

レスポンス

返却: Option[PublicAPISetCommentTextResponse]

例

setCommentText の例

Copy

let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  commentTextUpdateRequest = CommentTextUpdateRequest(text: "Updated comment text to fix a typo and clarify meaning."),
  editKey = "",
  sso = ""
)
if response.isSome:
  let result = response.get()
  discard result

コメントからユーザーのブロックを解除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
unBlockFromCommentParams	UnBlockFromCommentParams	いいえ
userId	string	いいえ
anonUserId	string	いいえ

レスポンス

戻り値: Option[UnblockSuccess]

例

コメントからユーザーのブロックを解除する例

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-9f3b2a",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-1024",
  anonUserId = "anon-77b"
)
if response.isSome:
  let unblockResult = response.get()
  echo unblockResult
else:
  echo "Unblock failed"

コメントの通報を取り下げ

パラメーター

名前	型	必須
tenantId	string	はい
id	string	いいえ
userId	string	いいえ
anonUserId	string	いいえ

レスポンス

戻り値: Option[FlagCommentResponse]

例

unFlagComment の例

Copy

let (response, httpResponse) = client.unFlagComment(tenantId = "my-tenant-123",
  id = "comment-98765",
  userId = "user-12345",
  anonUserId = "")
if response.isSome:
  let flagResp = response.get()
  echo "Unflagged comment response:", flagResp
else:
  echo "Unflag failed, HTTP status:", httpResponse.status

コメントのロックを解除

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

例

unLockComment の例

Copy

let tenantId = "my-tenant-123"
let commentId = "cmt-987654321"
let (response, httpResponse) = client.unLockComment(
  tenantId = tenantId,
  commentId = commentId,
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let apiResp = response.get()
  echo "Unlocked comment ", commentId, " for tenant ", tenantId
else:
  echo "Unlock failed, HTTP status: ", $httpResponse.status

コメントのピン留めを解除

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

返却値: Option[ChangeCommentPinStatusResponse]

例

unPinComment の例

Copy

let (response, httpResponse) = client.unPinComment(tenantId = "my-tenant-123", commentId = "cmt-987654321", broadcastId = "", sso = "")
if response.isSome:
  let result = response.get()
  echo "Unpinned comment:", $result
else:
  echo "Unpin failed, HTTP status:", $httpResponse.status

コメントを更新

パラメータ

Name	Type	Required
tenantId	string	はい
id	string	いいえ
updatableCommentParams	UpdatableCommentParams	いいえ
contextUserId	string	いいえ
doSpamCheck	bool	いいえ
isLive	bool	いいえ

レスポンス

例

updateCommentの例

Copy

let (response, httpResponse) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "cmt-987654",
  updatableCommentParams = UpdatableCommentParams(
    text = "Updated comment: corrected facts and clarified wording.",
    isApproved = true,
    tags = @["news", "update"]
  ),
  contextUserId = "user-456",
  doSpamCheck = true,
  isLive = true
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp

コメントに投票

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
urlId	string	はい
broadcastId	string	いいえ
voteBodyParams	VoteBodyParams	いいえ
sessionId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[VoteResponse]

例

voteComment の例

Copy

let (response, httpResponse) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  urlId = "news/article-2026-inflation",
  broadcastId = "",
  voteBodyParams = VoteBodyParams(),
  sessionId = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  discard voteResp
else:
  discard httpResponse

ユーザーのコメントを取得

パラメータ

名前	型	必須
userId	string	任意
direction	SortDirections	任意
repliesToUserId	string	任意
page	float64	任意
includei10n	bool	任意
locale	string	任意
isCrawler	bool	任意

レスポンス

戻り値: Option[GetCommentsForUserResponse]

例

getCommentsForUser の例

Copy

let (response, httpResponse) = client.getCommentsForUser(
  userId = "user-8421",
  direction = SortDirections.Newest,
  repliesToUserId = "",
  page = 1.0,
  includei10n = true,
  locale = "en-US",
  isCrawler = false
)
if response.isSome:
  let comments = response.get()
  discard comments

ドメイン設定を追加

パラメータ

名前	型	必須	説明
tenantId	string	はい
addDomainConfigParams	AddDomainConfigParams	いいえ

レスポンス

返却値: Option[AddDomainConfigResponse]

例

addDomainConfig の例

Copy

let config = AddDomainConfigParams(
  domain: "comments.example-news.com",
  enabled: true,
  allowedOrigins: @["https://www.example-news.com", "https://m.example-news.com"],
  commentsPath: "/news/world/election-coverage",
  priority: 5
)
let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = config)
if response.isSome:
  let created = response.get()
  echo "Created domain config:", created
else:
  echo "Failed to create domain config, HTTP status:", httpResponse.status.code

ドメイン設定を削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
domain	string	いいえ

レスポンス

戻り値: Option[DeleteDomainConfigResponse]

例

deleteDomainConfig の例

Copy

let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let deleted = response.get()
  echo "DeleteDomainConfig succeeded for tenant ", "my-tenant-123"
else:
  echo "DeleteDomainConfig failed. HTTP status: ", $httpResponse.status

ドメイン設定を取得

パラメータ

Name	Type	Required	Description
tenantId	string	Yes
domain	string	No

レスポンス

戻り値: Option[GetDomainConfigResponse]

例

getDomainConfig の例

Copy

let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news/top-story-2026")
if response.isSome:
  let cfg = response.get()
  discard cfg
else:
  discard httpResponse

ドメイン設定一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい

レスポンス

戻り値: Option[GetDomainConfigsResponse]

例

getDomainConfigsの例

Copy

let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if response.isSome:
  let domainConfigs = response.get()
  echo "Received domain configs for tenant my-tenant-123"
  echo domainConfigs
else:
  echo "No domain configs returned"

ドメイン設定を部分更新

パラメータ

名前	型	必須
tenantId	string	はい
domainToUpdate	string	いいえ
patchDomainConfigParams	PatchDomainConfigParams	いいえ

レスポンス

戻り値: Option[PatchDomainConfigResponse]

例

patchDomainConfig の例

Copy

let patchParams: PatchDomainConfigParams = PatchDomainConfigParams(
  allowedOrigins = @["https://news.example.com", "https://cdn.news.com"],
  enableComments = true,
  moderationRequired = false,
  maxCommentLength = 2000,
  primaryDomain = "comments.news-site.com"
)
let (response, httpResponse) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "comments.news-site.com",
  patchDomainConfigParams = patchParams
)
if response.isSome:
  let cfg = response.get()
  echo "Patched domain config received:", cfg
else:
  echo "No response body, HTTP status:", httpResponse.statusCode

ドメイン設定を置換

パラメータ

名前	型	必須
tenantId	string	はい
domainToUpdate	string	いいえ
updateDomainConfigParams	UpdateDomainConfigParams	いいえ

レスポンス

戻り値: Option[PutDomainConfigResponse]

例

putDomainConfig の例

Copy

let (response, httpResponse) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "blog.example.com",
  updateDomainConfigParams = UpdateDomainConfigParams(
    allowAnonymous = false,
    moderationEnabled = true,
    maxCommentLength = 800,
    allowedOrigins = @["https://blog.example.com", "https://cdn.blog.example.com"],
    enableThreadedComments = true
  )
)
if response.isSome:
  let cfg = response.get()
  echo cfg
else:
  echo "Failed to update domain config, HTTP status: ", httpResponse.status

メールテンプレートを作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createEmailTemplateBody	CreateEmailTemplateBody	いいえ

レスポンス

戻り値: Option[CreateEmailTemplateResponse]

例

createEmailTemplateの例

Copy

let (response, httpResponse) = client.createEmailTemplate(tenantId = "my-tenant-123",
  createEmailTemplateBody = CreateEmailTemplateBody(
    name = "Weekly Newsletter",
    subject = "This Week on NewsSite",
    html = "<h1>Latest updates</h1><p>Read our latest article.</p>",
    fromAddress = "no-reply@newssite.com",
    isDefault = false,
    tags = @["news", "weekly"]
  )
)
if response.isSome:
  let template = response.get()
  echo "Created email template id: ", template.id

メールテンプレートを削除

パラメータ

Name	Type	Required	Description
tenantId	string	はい
id	string	いいえ

レスポンス

返り値: Option[APIEmptyResponse]

例

deleteEmailTemplate の例

Copy

let (response, httpResponse) = client.deleteEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-email-template-001"
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty
  echo "Email template deleted successfully"
else:
  echo "No response body"

メールテンプレートレンダリングエラーを削除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
errorId	string	いいえ

レスポンス

例

deleteEmailTemplateRenderError Example

Copy

let (response, httpResponse) = client.deleteEmailTemplateRenderError(tenantId = "my-tenant-123", id = "welcome-email-template", errorId = "err-20250615-01")
if response.isSome:
  let emptyResp = response.get()
  echo "Deleted render error, tenant:", "my-tenant-123"
  echo "HTTP status:", httpResponse.status
else:
  echo "No body returned, HTTP status:", httpResponse.status

メールテンプレートを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetEmailTemplateResponse]

例

getEmailTemplate 使用例

Copy

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

メールテンプレート定義を取得

パラメータ

Name	Type	Required	Description
tenantId	string	Yes

レスポンス

戻り値: Option[GetEmailTemplateDefinitionsResponse]

例

getEmailTemplateDefinitions の例

Copy

let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if response.isSome:
  let definitions = response.get()
  echo "Email template definitions for my-tenant-123: ", definitions
else:
  echo "Failed to retrieve templates, HTTP status: ", httpResponse.status

メールテンプレートのレンダリングエラーを取得

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
skip	float64	いいえ

レスポンス

返却値: Option[GetEmailTemplateRenderErrorsResponse]

例

getEmailTemplateRenderErrors の例

Copy

let (response, httpResponse) = client.getEmailTemplateRenderErrors(tenantId = "my-tenant-123", id = "", skip = 0.0)
if response.isSome:
  let templateErrors = response.get()
  discard templateErrors
else:
  discard httpResponse

メールテンプレート一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
skip	float64	いいえ

レスポンス

戻り値: Option[GetEmailTemplatesResponse]

例

getEmailTemplates の例

Copy

let (response, httpResponse) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let templates = response.get()
  echo templates
else:
  echo "No email templates available"

メールテンプレートをレンダリング

パラメータ

名前	型	必須
tenantId	string	はい
renderEmailTemplateBody	RenderEmailTemplateBody	いいえ
locale	string	いいえ

レスポンス

戻り値: Option[RenderEmailTemplateResponse]

例

renderEmailTemplate の例

Copy

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

メールテンプレートを更新

パラメータ

Name	Type	Required
tenantId	string	はい
id	string	いいえ
updateEmailTemplateBody	UpdateEmailTemplateBody	いいえ

レスポンス

例

updateEmailTemplate の例

Copy

let updateBody = UpdateEmailTemplateBody(
  subject = "Welcome to Newsly",
  html = "<p>Thanks for joining Newsly! Visit https://newsly.example to get started.</p>",
  fromAddress = "no-reply@newsly.example",
  fromName = "Newsly Team",
  enabled = true
)
let (response, httpResponse) = client.updateEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email", updateEmailTemplateBody = updateBody)
if response.isSome:
  let result = response.get()
  discard result
else:
  discard httpResponse.statusCode

イベントログを取得

req tenantId urlId userIdWS

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
userIdWS	string	いいえ
startTime	int64	いいえ
endTime	int64	いいえ

レスポンス

返却値: Option[GetEventLogResponse]

例

getEventLog の例

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-2026-solar-panels",
  userIdWS = "user-456",
  startTime = 1688000000'i64,
  endTime = 1688086400'i64
)
if response.isSome:
  let eventLog = response.get()
  discard eventLog

グローバルイベントログを取得

req tenantId urlId userIdWS

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
userIdWS	string	いいえ
startTime	int64	いいえ
endTime	int64	いいえ

レスポンス

返却値: Option[GetEventLogResponse]

例

getGlobalEventLog の例

Copy

let (response, httpResponse) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-2026-06-19",
  userIdWS = "user-987",
  startTime = int64(1622505600),
  endTime = int64(1625097600)
)
if response.isSome:
  let eventLog = response.get()
  echo eventLog, httpResponse.statusCode

フィード投稿を作成

パラメータ

名前	型	必須
tenantId	string	はい
createFeedPostParams	CreateFeedPostParams	いいえ
broadcastId	string	いいえ
isLive	bool	いいえ
doSpamCheck	bool	いいえ
skipDupCheck	bool	いいえ

レスポンス

戻り値: Option[CreateFeedPostsResponse]

例

createFeedPost の例

Copy

let postParams = CreateFeedPostParams(
  title = "Major Acquisition by TechCorp",
  content = "TechCorp has acquired SoftWorks in a deal valued at $1.2B, creating a new market leader.",
  url = "news/tech/major-acquisition",
  tags = @["business", "technology"],
  authorId = "journalist-321"
)
let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = postParams,
  broadcastId = "",
  isLive = false,
  doSpamCheck = false,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  discard created

フィード投稿を作成（公開）

パラメータ

名前	型	必須
tenantId	string	はい
createFeedPostParams	CreateFeedPostParams	いいえ
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[CreateFeedPostResponse]

例

createFeedPostPublic の例

Copy

let params = CreateFeedPostParams(
  title = "Breaking: Major Update on Product X",
  content = "Today we released Product X v2.0 with performance improvements and bug fixes.",
  author = "jane.doe",
  tags = @["product", "release", "v2"],
  isPinned = false
)
let (response, httpResponse) = client.createFeedPostPublic(tenantId = "my-tenant-123", createFeedPostParams = params, broadcastId = "", sso = "")
if response.isSome:
  let created = response.get()
  echo "Created feed post:", created
else:
  echo "Failed to create feed post; HTTP status:", httpResponse.status

フィード投稿を削除（公開）

パラメータ

Name	Type	Required
tenantId	string	はい
postId	string	いいえ
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[DeleteFeedPostPublicResponse]

例

deleteFeedPostPublic の例

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(tenantId = "my-tenant-123", postId = "", broadcastId = "", sso = "")
if response.isSome:
  let deleted = response.get()
  echo "Delete successful"
else:
  echo "Delete failed"

フィード投稿を取得

req tenantId afterId

パラメータ

名前	型	必須
tenantId	string	はい
afterId	string	いいえ
limit	int	いいえ
tags	seq[string]	いいえ

レスポンス

戻り値: Option[GetFeedPostsResponse]

例

getFeedPosts の例

Copy

let (response, httpResponse) = client.getFeedPosts(
  tenantId = "my-tenant-123",
  afterId = "",
  limit = 0,
  tags = @[]
)
if response.isSome:
  let feed = response.get()
  echo "Feed retrieved for tenant my-tenant-123"

フィード投稿を取得（公開）

req tenantId afterId

パラメータ

名前	型	必須
tenantId	string	はい
afterId	string	いいえ
limit	int	いいえ
tags	seq[string]	いいえ
sso	string	いいえ
isCrawler	bool	いいえ
includeUserInfo	bool	いいえ

レスポンス

戻り値: Option[PublicFeedPostsResponse]

例

getFeedPostsPublic の例

Copy

let (response, httpResponse) = client.getFeedPostsPublic(
  tenantId = "my-tenant-123",
  afterId = "",
  limit = 0,
  tags = @[],
  sso = "",
  isCrawler = false,
  includeUserInfo = false
)
if response.isSome:
  let feed = response.get()
  discard feed

フィード投稿の統計を取得

パラメータ

名前	型	必須
tenantId	string	はい
postIds	seq[string]	いいえ
sso	string	いいえ

レスポンス

返却: Option[FeedPostsStatsResponse]

例

getFeedPostsStats の例

Copy

let (response, httpResponse) = client.getFeedPostsStats(tenantId = "my-tenant-123", postIds = @["news/article-2026", "opinion/market-trends"], sso = "")
if response.isSome:
  let stats = response.get()
  echo "Received feed posts stats for tenant:", " my-tenant-123"
  discard stats

公開ユーザーのリアクションを取得

パラメータ

名前	型	必須
tenantId	string	はい
postIds	seq[string]	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[UserReactsResponse]

例

getUserReactsPublic の例

Copy

let (response, httpResponse) = client.getUserReactsPublic(
  tenantId = "my-tenant-123",
  postIds = @["news/article-2026", "blog/opinion-987"],
  sso = ""
)
if response.isSome:
  let reacts = response.get()
  echo "Received user reacts for tenant: ", "my-tenant-123"

フィード投稿にリアクト（公開）

パラメータ

名前	型	必須
tenantId	string	はい
postId	string	いいえ
reactBodyParams	ReactBodyParams	いいえ
isUndo	bool	いいえ
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

返り値: Option[ReactFeedPostResponse]

例

reactFeedPostPublic の例

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-2026-06-19",
  reactBodyParams = ReactBodyParams(reactType = "heart", tags = @["breaking", "editorial"]),
  isUndo = false,
  broadcastId = "broadcast-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let react = response.get()
  echo react
else:
  echo "No response from reactFeedPostPublic, HTTP status:", httpResponse.statusCode

フィード投稿を更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
feedPost	FeedPost	いいえ

レスポンス

例

updateFeedPost の例

Copy

let feedPost: FeedPost = FeedPost(title: "City Council Approves New Waterfront Park",
  content: "The council voted 5-2 to approve funding and a timeline for construction.",
  tags: @["local", "parks", "city"],
  published: true)
let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)
if response.isSome:
  let apiResp = response.get()
  echo "Feed post updated successfully"
  echo apiResp
else:
  echo "Failed to update feed post"
  echo httpResponse

フィード投稿を更新（公開）

パラメータ

名前	型	必須
tenantId	string	はい
postId	string	いいえ
updateFeedPostParams	UpdateFeedPostParams	いいえ
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[CreateFeedPostResponse]

例

updateFeedPostPublic の例

Copy

let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  updateFeedPostParams = UpdateFeedPostParams(title = "Weekly Product Update", content = "Released bug fixes and performance improvements in v2.1.", tags = @["release", "product"], pinned = false),
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let created = response.get()
  echo "Updated feed post id: ", created.postId
else:
  echo "Update failed with HTTP status: ", httpResponse.status

コメントを通報（公開）

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
isFlagged	bool	いいえ
sso	string	いいえ

レスポンス

例

flagCommentPublicの例

Copy

let (response, httpResponse) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  isFlagged = true,
  sso = ""
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp
else:
  discard httpResponse

大きいGIFを取得

パラメータ

Name	Type	Required	Description
tenantId	string	はい
largeInternalURLSanitized	string	いいえ

レスポンス

戻り値: Option[GifGetLargeResponse]

例

getGifLarge の例

Copy

let (response, httpResponse) = client.getGifLarge(tenantId = "news-tenant-42", largeInternalURLSanitized = "")
if response.isSome:
  let gif = response.get()
  echo "Received GifGetLargeResponse"
  discard gif
else:
  echo "No gif returned, HTTP status: " & $httpResponse.status

GIF検索を取得

パラメータ

名前	型	必須
tenantId	string	はい
search	string	いいえ
locale	string	いいえ
rating	string	いいえ
page	float64	いいえ

レスポンス

戻り値: Option[GetGifsSearchResponse]

例

getGifsSearch の例

Copy

let (response, httpResponse) = client.getGifsSearch(
  tenantId = "my-tenant-123",
  search = "funny cat",
  locale = "en-US",
  rating = "PG",
  page = 1.0
)
if response.isSome:
  let gifs = response.get()
  echo "Fetched GIFs response:", gifs

トレンドGIFを取得

パラメータ

Name	Type	Required
tenantId	string	はい
locale	string	いいえ
rating	string	いいえ
page	float64	いいえ

レスポンス

戻り値: Option[GetGifsTrendingResponse]

例

getGifsTrending の例

Copy

let (response, httpResponse) = client.getGifsTrending(tenantId = "my-tenant-123",
  locale = "en-US",
  rating = "pg-13",
  page = 1.0)
if response.isSome:
  let trending = response.get()

ハッシュタグを追加

パラメータ

名前	型	必須	説明
tenantId	string	はい
createHashTagBody	CreateHashTagBody	いいえ

レスポンス

戻り値: Option[CreateHashTagResponse]

例

addHashTag の例

Copy

let (response, httpResponse) = client.addHashTag(tenantId = "my-tenant-123",
  createHashTagBody = CreateHashTagBody(name = "Breaking News",
    slug = "breaking-news",
    description = "Major breaking news items",
    color = "#ff0000",
    isTrending = true,
    aliases = @["breaking", "news"]))
if response.isSome:
  let created = response.get()
  echo created

ハッシュタグを一括追加

パラメータ

Name	Type	Required	Description
tenantId	string	はい
bulkCreateHashTagsBody	BulkCreateHashTagsBody	いいえ

レスポンス

戻り値: Option[BulkCreateHashTagsResponse]

例

addHashTagsBulk の例

Copy

let (response, httpResponse) = client.addHashTagsBulk(tenantId = "my-tenant-123", bulkCreateHashTagsBody = BulkCreateHashTagsBody(hashTags = @["news", "breaking", "politics"], replaceExisting = false))
if response.isSome:
  let result = response.get()
  echo "Bulk tags response:", result
else:
  echo "No response body, HTTP status:", httpResponse.statusCode

ハッシュタグを削除

パラメータ

名前	型	必須
tag	string	いいえ
tenantId	string	はい
deleteHashTagRequestBody	DeleteHashTagRequestBody	いいえ

レスポンス

例

deleteHashTag の例

Copy

let (response, httpResponse) = client.deleteHashTag(
  tag = "",
  tenantId = "my-tenant-123",
  deleteHashTagRequestBody = DeleteHashTagRequestBody()
)
if response.isSome:
  let emptyResp = response.get()
  echo "Deleted hashtag for tenant my-tenant-123; response:", $emptyResp, " status:", $httpResponse.status
else:
  echo "No response body; status:", $httpResponse.status

ハッシュタグ一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
page	float64	いいえ

レスポンス

戻り値: Option[GetHashTagsResponse]

例

getHashTags の例

Copy

let (response, httpResponse) = client.getHashTags(tenantId = "news-portal-987", page = 2.0)
if response.isSome:
  let tagsResp = response.get()
  echo "Received hashtags response"
else:
  echo "No hashtags returned"

ハッシュタグを部分更新

パラメータ

名前	型	必須
tag	string	いいえ
tenantId	string	はい
updateHashTagBody	UpdateHashTagBody	いいえ

レスポンス

戻り値: Option[UpdateHashTagResponse]

例

patchHashTag の例

Copy

let (response, httpResponse) = client.patchHashTag(tag = "breaking-news", tenantId = "my-tenant-123", updateHashTagBody = UpdateHashTagBody())
if response.isSome:
  let updatedHashTag = response.get()
  echo updatedHashTag

モデレーション投票を削除

パラメータ

名前	型	必須
commentId	string	はい
voteId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[VoteDeleteResponse]

例

deleteModerationVote の例

Copy

let (response, httpResponse) = client.deleteModerationVote(commentId = "my-tenant-123/news/article-title/comment-987", voteId = "vote-456", sso = "sso-token-abc")
if response.isSome:
  let voteResp = response.get()
  echo "Vote deleted:", voteResp
else:
  echo "Delete failed:", httpResponse

API経由のコメントを取得

パラメータ

名前	型	必須
page	float64	いいえ
count	float64	いいえ
textSearch	string	いいえ
byIPFromComment	string	いいえ
filters	string	いいえ
searchFilters	string	いいえ
sorts	string	いいえ
demo	bool	いいえ
sso	string	いいえ

レスポンス

返却値: Option[ModerationAPIGetCommentsResponse]

例

getApiComments の例

Copy

let (response, httpResponse) = client.getApiComments(
  page = 1.0,
  count = 25.0,
  textSearch = "opinion on climate summit",
  byIPFromComment = "198.51.100.23",
  filters = "status:approved",
  searchFilters = "section:world",
  sorts = "-createdAt",
  demo = false,
  sso = "sso-user-982bf"
)
if response.isSome:
  let commentsResp = response.get()
  echo "Retrieved comments response"
else:
  echo "No comments returned, HTTP status: ", httpResponse.status

APIエクスポートのステータスを取得

パラメータ

Name	Type	必須	説明
batchJobId	string	いいえ
sso	string	いいえ

レスポンス

返却値: Option[ModerationExportStatusResponse]

例

getApiExportStatus の例

Copy

let (response, httpResponse) = client.getApiExportStatus(batchJobId = "export-job-2026-06-01", sso = "sso-abc123token")
if response.isSome:
  let exportStatus = response.get()
  echo repr(exportStatus)
else:
  echo "No export status available, HTTP code: ", httpResponse.statusCode

API用IDを取得

パラメータ

名前	型	必須
textSearch	string	いいえ
byIPFromComment	string	いいえ
filters	string	いいえ
searchFilters	string	いいえ
afterId	string	いいえ
demo	bool	いいえ
sso	string	いいえ

レスポンス

返却値: Option[ModerationAPIGetCommentIdsResponse]

例

getApiIds の例

Copy

let (response, httpResponse) = client.getApiIds(
  textSearch = "urgent moderation review",
  byIPFromComment = "203.0.113.45",
  filters = "status:pending,flagged",
  searchFilters = "author:jane.doe@example.com",
  afterId = "cmt_9f8e7d6a",
  demo = false,
  sso = "sso-token-6b7f9a"
)
if response.isSome:
  let idsResp = response.get()
  echo idsResp

コメントからの禁止ユーザーを取得

パラメータ

名前	型	必須	説明
commentId	string	はい
sso	string	いいえ

レスポンス

戻り値: Option[GetBannedUsersFromCommentResponse]

例

getBanUsersFromComment の例

Copy

let (response, httpResponse) = client.getBanUsersFromComment(commentId = "comment-98765", sso = "")
if response.isSome:
  let bannedResp = response.get()
  discard bannedResp
else:
  echo "No banned users found or request failed"

コメントの禁止状態を取得

パラメータ

名前	型	必須	説明
commentId	string	はい
sso	string	いいえ

レスポンス

戻り値: Option[GetCommentBanStatusResponse]

例

getCommentBanStatus の例

Copy

let (response, httpResponse) = client.getCommentBanStatus(commentId = "cmt-987654321", sso = "")
if response.isSome:
  let banStatus = response.get()
  echo "Ban status for comment cmt-987654321: ", banStatus
else:
  echo "No ban status returned for comment cmt-987654321"

コメントの子コメントを取得

Parameters

名前	型	必須	説明
commentId	string	はい
sso	string	いいえ

Response

戻り値: Option[ModerationAPIChildCommentsResponse]

Example

getCommentChildren の例

Copy

let (response, httpResponse) = client.getCommentChildren(commentId = "comment-98765", sso = "")
if response.isSome:
  let childResp = response.get()
  discard childResp

カウントを取得

パラメータ

名前	型	必須
textSearch	string	いいえ
byIPFromComment	string	いいえ
filter	string	いいえ
searchFilters	string	いいえ
demo	bool	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[ModerationAPICountCommentsResponse]

例

getCount の例

Copy

let (response, httpResponse) = client.getCount(
  textSearch = "climate change",
  byIPFromComment = "203.0.113.5",
  filter = "status:approved",
  searchFilters = "author:john.doe@example.com;tag:opinion",
  demo = false,
  sso = "sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
)
if response.isSome:
  let countResp = response.get()
  discard countResp
  echo "Count response received"
else:
  echo "No count data returned"

複数カウントを取得

パラメータ

名前	型	必須	説明
sso	string	任意

レスポンス

戻り値: Option[GetBannedUsersCountResponse]

例

getCounts の例

Copy

let (response, httpResponse) = client.getCounts(sso = "sso_my-tenant-123_token_AbCdEf123456")
if response.isSome:
  let counts = response.get()
  echo counts
else:
  echo "Request failed with status:", httpResponse.status

ログを取得

パラメータ

名前	型	必須	説明
commentId	string	はい
sso	string	いいえ

レスポンス

戻り値: Option[ModerationAPIGetLogsResponse]

例

getLogs の例

Copy

let (response, httpResponse) = client.getLogs(commentId = "cmt-8471f2d3", sso = "")
if response.isSome:
  let logs = response.get()
  echo "Fetched logs:", logs

手動バッジを取得

パラメータ

名前	型	必須	説明
sso	string	いいえ

レスポンス

戻り値: Option[GetTenantManualBadgesResponse]

例

getManualBadges の例

Copy

let (response, httpResponse) = client.getManualBadges(sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9")
if response.isSome:
  let badges = response.get()
  echo "Manual badges received:"
  echo badges
else:
  echo "No manual badges returned."
  echo httpResponse

ユーザーの手動バッジを取得

パラメータ

Name	Type	Required
badgesUserId	string	任意
commentId	string	必須
sso	string	任意

レスポンス

戻り値: Option[GetUserManualBadgesResponse]

例

getManualBadgesForUser の例

Copy

let (response, httpResponse) = client.getManualBadgesForUser(
  badgesUserId = "user-98765",
  commentId = "comment-0a1b2c3d",
  sso = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
)
if response.isSome:
  let badges = response.get()
  echo "Received manual badges for user"
  echo "HTTP status: ", httpResponse.status

モデレーション対象コメントを取得

パラメータ

名前	型	必須
commentId	string	はい
includeEmail	bool	いいえ
includeIP	bool	いいえ
sso	string	いいえ

レスポンス

返却値: Option[ModerationAPICommentResponse]

例

getModerationComment の例

Copy

let (response, httpResponse) = client.getModerationComment(commentId = "cmt-8f3b2a9d", includeEmail = false, includeIP = false, sso = "")
if response.isSome:
  let comment = response.get()
  discard comment
else:
  echo "No moderation comment returned"

モデレーションコメント本文を取得

パラメータ

名前	型	必須	説明
commentId	string	必須
sso	string	任意

レスポンス

戻り値: Option[GetCommentTextResponse]

例

getModerationCommentText の例

Copy

let (response, httpResponse) = client.getModerationCommentText(commentId = "comment-9f8b7a6c", sso = "")
if response.isSome:
  let commentData = response.get()
  echo "Moderation comment text retrieved"
else:
  echo "No moderation comment text available"

事前禁止の概要を取得

パラメータ

名前	型	必須
commentId	string	はい
includeByUserIdAndEmail	bool	いいえ
includeByIP	bool	いいえ
includeByEmailDomain	bool	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[PreBanSummary]

例

getPreBanSummary の例

Copy

let commentId = "cmt-7423"
let (response, httpResponse) = client.getPreBanSummary(
  commentId = commentId,
  includeByUserIdAndEmail = false,
  includeByIP = false,
  includeByEmailDomain = false,
  sso = ""
)
if response.isSome:
  let preBanSummary = response.get()
  discard preBanSummary
else:
  discard httpResponse

検索コメントの概要を取得

パラメータ

名前	型	必須
value	string	いいえ
filters	string	いいえ
searchFilters	string	いいえ
sso	string	いいえ

レスポンス

返却値: Option[ModerationCommentSearchResponse]

例

getSearchCommentsSummary の例

Copy

let (response, httpResponse) = client.getSearchCommentsSummary(
  value = "news/climate-change-2026",
  filters = "{\"tenantId\":\"my-tenant-123\",\"siteId\":\"main-site\",\"status\":\"approved\"}",
  searchFilters = "author:journalist@news.com OR content:climate",
  sso = "sso-xyz-7890"
)
if response.isSome:
  let summary = response.get()
  echo "Received summary: ", $summary
else:
  echo "No summary returned, HTTP response: ", $httpResponse

検索ページを取得

パラメータ

名前	型	必須	説明
value	string	任意
sso	string	任意

レスポンス

戻り値: Option[ModerationPageSearchResponse]

例

getSearchPages の例

Copy

let (response, httpResponse) = client.getSearchPages(value = "news/politics/election-2024", sso = "sso-user-7f3b9c")
if response.isSome:
  let pageSearch = response.get()
  echo "Moderation page search returned"
else:
  echo "No moderation pages found"

検索サイトを取得

パラメータ

名前	型	必須	説明
value	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[ModerationSiteSearchResponse]

例

getSearchSites の例

Copy

let (response, httpResponse) = client.getSearchSites(value = "news/2026-olympics", sso = "sso-user-9876-token")
if response.isSome:
  let searchResponse: ModerationSiteSearchResponse = response.get()
  echo "Found sites for search:", searchResponse

検索候補を取得

パラメータ

名前	型	必須	説明
textSearch	string	いいえ
sso	string	いいえ

戻り値

戻り値: Option[ModerationSuggestResponse]

例

getSearchSuggest の例

Copy

let (response, httpResponse) = client.getSearchSuggest(textSearch = "suspicious comment with spammy links", sso = "sso-user-789")
if response.isSome:
  let suggest = response.get()
  echo "ModerationSuggestResponse:"
  echo suggest
else:
  echo "No moderation suggestions returned. HTTP status: ", httpResponse.status

検索ユーザーを取得

パラメータ

名前	型	必須	説明
value	string	いいえ
sso	string	いいえ

レスポンス

返り値: Option[ModerationUserSearchResponse]

例

getSearchUsers の例

Copy

let (response, httpResponse) = client.getSearchUsers(value = "john.doe@example.com", sso = "sso-acme-789")
if response.isSome:
  let searchRes = response.get()
  echo "Search result:", searchRes
else:
  echo "No users found"

信頼係数を取得

パラメータ

Name	Type	Required	Description
userId	string	任意
sso	string	任意

レスポンス

返却値: Option[GetUserTrustFactorResponse]

例

getTrustFactor の例

Copy

let (response, httpResponse) = client.getTrustFactor(userId = "user-1001", sso = "sso-token-6f7d9c")
if response.isSome:
  let trust = response.get()
  echo "Received trust factor for user-1001"
else:
  echo "No trust factor returned, HTTP status: ", $httpResponse.status

ユーザーの禁止設定を取得

パラメータ

名前	型	必須	説明
sso	string	いいえ

レスポンス

戻り値: Option[APIModerateGetUserBanPreferencesResponse]

例

getUserBanPreference の例

Copy

let (response, httpResponse) = client.getUserBanPreference(sso = "sso-jwt-7f3a9b")
if response.isSome:
  let prefs = response.get()
  echo "User ban preferences:", prefs
else:
  echo "No ban preference found"

ユーザー内部プロファイルを取得

パラメータ

Name	Type	Required	Description
commentId	string	はい
sso	string	いいえ

レスポンス

戻り値: Option[GetUserInternalProfileResponse]

例

getUserInternalProfile の例

Copy

let (response, httpResponse) = client.getUserInternalProfile(commentId = "cmt-2026-00042", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoibXl1c2VyIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
if response.isSome:
  let profile = response.get()
  discard profile

コメント投票を調整

パラメータ

名前	型	必須
commentId	string	はい
adjustCommentVotesParams	AdjustCommentVotesParams	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[AdjustVotesResponse]

例

postAdjustCommentVotes の例

Copy

let (response, httpResponse) = client.postAdjustCommentVotes(commentId = "cmt-987654", adjustCommentVotesParams = nil, sso = "sso-token-abc123")
if response.isSome:
  let adjusted = response.get()
  discard adjusted

APIエクスポートを開始

パラメータ

名前	型	必須
textSearch	string	任意
byIPFromComment	string	任意
filters	string	任意
searchFilters	string	任意
sorts	string	任意
sso	string	任意

レスポンス

戻り値: Option[ModerationExportResponse]

例

postApiExport の例

Copy

let (response, httpResponse) = client.postApiExport(
  textSearch = "offensive language and spam",
  byIPFromComment = "203.0.113.45",
  filters = "{\"status\":\"pending\",\"severity\":\"high\"}",
  searchFilters = "authorEmail:editor@news-site.com",
  sorts = "-createdAt",
  sso = "sso-session-token-9f8b7c"
)
if response.isSome:
  let exportResp = response.get()
  echo "Moderation export received:", exportResp
else:
  echo "No export returned, HTTP status:", httpResponse.status.code

コメントからユーザーを禁止

パラメータ

名前	型	必須
commentId	string	はい
banEmail	bool	いいえ
banEmailDomain	bool	いいえ
banIP	bool	いいえ
deleteAllUsersComments	bool	いいえ
bannedUntil	string	いいえ
isShadowBan	bool	いいえ
updateId	string	いいえ
banReason	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[BanUserFromCommentResult]

例

postBanUserFromComment の例

Copy

let (response, httpResponse) = client.postBanUserFromComment(
  commentId = "cmt-8f3a1b",
  banEmail = false,
  banEmailDomain = false,
  banIP = false,
  deleteAllUsersComments = false,
  bannedUntil = "",
  isShadowBan = false,
  updateId = "",
  banReason = "",
  sso = ""
)
if response.isSome:
  let banResult = response.get()
  discard banResult
else:
  echo "No ban result returned"

ユーザー禁止を取り消し

パラメータ

名前	型	必須	説明
banUserUndoParams	BanUserUndoParams	いいえ
sso	string	いいえ

レスポンス

例

postBanUserUndo の例

Copy

let banParams = BanUserUndoParams(
  tenantId = "my-tenant-123",
  userId = "user-987",
  undoneBy = "moderator-42",
  reason = "Reinstated after manual review"
)
let (response, httpResponse) = client.postBanUserUndo(banUserUndoParams = banParams, sso = "sso-jwt-abc123")
if response.isSome:
  let apiResp = response.get()
  echo "Ban undo succeeded, http status: " & $httpResponse.status
else:
  echo "Ban undo failed, http status: " & $httpResponse.status

一括事前禁止の概要を作成

パラメータ

名前	型	必須
bulkPreBanParams	BulkPreBanParams	任意
includeByUserIdAndEmail	bool	任意
includeByIP	bool	任意
includeByEmailDomain	bool	任意
sso	string	任意

レスポンス

戻り値: Option[BulkPreBanSummary]

例

postBulkPreBanSummary の例

Copy

let bulkParams = BulkPreBanParams(
  tenantId = "my-tenant-123",
  userIds = @["user-456", "user-789"],
  emails = @["spammer@example.com", "bot@malicious.org"],
  ipAddresses = @["203.0.113.5", "198.51.100.42"],
  emailDomains = @["malicious.org"]
)
let (response, httpResponse) = client.postBulkPreBanSummary(
  bulkPreBanParams = bulkParams,
  includeByUserIdAndEmail = true,
  includeByIP = true,
  includeByEmailDomain = false,
  sso = "sso-token-abc123"
)
if response.isSome:
  let summary = response.get()
  echo "Pre-ban summary:", summary

IDでコメントを取得（POST）

パラメータ

Name	Type	Required	Description
commentsByIdsParams	CommentsByIdsParams	いいえ
sso	string	いいえ

戻り値

Returns: Option[ModerationAPIChildCommentsResponse]

例

postCommentsByIds の例

Copy

let commentsParams = CommentsByIdsParams(ids = @["cmt-1001", "cmt-1002"], includeReplies = true, maxDepth = 2)
let (response, httpResponse) = client.postCommentsByIds(commentsByIdsParams = commentsParams, sso = "sso-user-7f3a9b")
if response.isSome:
  let result = response.get()
  echo "Received child comments response: ", result

コメントを通報（POST）

パラメータ

Name	Type	Required	Description
commentId	string	はい
sso	string	いいえ

レスポンス

例

postFlagComment の例

Copy

let (response, httpResponse) = client.postFlagComment(commentId = "comment-742", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Comment flagged successfully"
else:
  echo "Failed to flag comment"

コメントを削除（POST）

パラメータ

Name	Type	Required	Description
commentId	string	はい
sso	string	いいえ

レスポンス

戻り値: Option[PostRemoveCommentResponse]

例

postRemoveComment の例

Copy

let (response, httpResponse) = client.postRemoveComment(commentId = "cmt-987654321", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123.signature")
if response.isSome:
  let removed = response.get()
  echo "Comment removed:", removed
else:
  echo "Failed to remove comment, HTTP response:", httpResponse

削除済みコメントを復元

パラメータ

名前	型	必須	説明
commentId	string	はい
sso	string	いいえ

レスポンス

例

postRestoreDeletedComment の例

Copy

let (response, httpResponse) = client.postRestoreDeletedComment(commentId = "comment-8a7b6c5d", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.SAMPLE_SIGNATURE")
if response.isSome:
  let apiResp = response.get()
  echo "Comment restored:", apiResp
else:
  echo "Restore request failed"

コメント承認状態を設定

パラメータ

名前	型	必須
commentId	string	はい
approved	bool	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[SetCommentApprovedResponse]

例

postSetCommentApprovalStatus の例

Copy

let (response, httpResponse) = client.postSetCommentApprovalStatus(commentId = "cmt-7890", approved = false, sso = "")
if response.isSome:
  let setResp = response.get()
  discard setResp

コメントレビュー状態を設定

パラメータ

名前	型	必須
commentId	string	はい
reviewed	bool	いいえ
sso	string	いいえ

レスポンス

例

postSetCommentReviewStatus の例

Copy

let (response, httpResponse) = client.postSetCommentReviewStatus(
  commentId = "cmt-98765-news-article",
  reviewed = false,
  sso = ""
)
if response.isSome:
  let apiResp = response.get()
  echo "Review status updated"
else:
  echo "Failed to update review status: " & $httpResponse.status

コメントのスパム状態を設定

パラメータ

名前	型	必須
commentId	string	はい
spam	bool	いいえ
permNotSpam	bool	いいえ
sso	string	いいえ

レスポンス

例

postSetCommentSpamStatus の例

Copy

let (response, httpResponse) = client.postSetCommentSpamStatus(
  commentId = "cmt-20250619-842",
  spam = false,
  permNotSpam = false,
  sso = ""
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

コメント本文を設定（POST）

パラメータ

名前	型	必須
commentId	string	はい
setCommentTextParams	SetCommentTextParams	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[SetCommentTextResponse]

例

postSetCommentText の例

Copy

let (response, httpResponse) = client.postSetCommentText(commentId = "comment-4821",
  setCommentTextParams = SetCommentTextParams(text = "Updated comment to clarify the main point and fix a typo."),
  sso = "sso-user-8f3b9c")
if response.isSome:
  let setCommentResp = response.get()
  echo "Received SetCommentTextResponse"

通報を解除（POST）

パラメータ

名前	型	必須	説明
commentId	string	はい
sso	string	いいえ

レスポンス

例

postUnFlagComment の例

Copy

let (response, httpResponse) = client.postUnFlagComment(commentId = "comment-8f3a2b4e", sso = "")
if response.isSome:
  let apiEmpty = response.get()
  echo "Comment unflagged successfully, response: ", apiEmpty
else:
  echo "Failed to unflag comment. HTTP response: ", httpResponse

投票を投稿

パラメータ

名前	型	必須
commentId	string	はい
direction	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[VoteResponse]

例

postVote の例

Copy

let (response, httpResponse) = client.postVote(commentId = "comment-4f3a9e", direction = "up", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoidXNlci0xMjMifQ.signedPart")
if response.isSome:
  let vote = response.get()
  echo "Vote recorded:", vote
else:
  echo "No vote returned"

バッジを付与

パラメータ

Name	Type	Required
badgeId	string	No
userId	string	No
commentId	string	Yes
broadcastId	string	No
sso	string	No

レスポンス

返却: Option[AwardUserBadgeResponse]

例

putAwardBadge の例

Copy

let (response, httpResponse) = client.putAwardBadge(
  badgeId = "gold-contributor",
  userId = "user-8723",
  commentId = "cmt-54a3b2",
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let award = response.get()
  echo "Awarded badge received"
else:
  echo "No award response"

スレッドを閉鎖

パラメータ

Name	Type	Required	Description
urlId	string	はい
sso	string	いいえ

レスポンス

例

putCloseThread の例

Copy

let (response, httpResponse) = client.putCloseThread(urlId = "news/article-title", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Thread closed successfully:", $apiResp
else:
  echo "Failed to close thread, HTTP response:", $httpResponse

バッジを削除

パラメータ

名前	型	必須
badgeId	string	いいえ
userId	string	いいえ
commentId	string	はい
broadcastId	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[RemoveUserBadgeResponse]

例

putRemoveBadge の例

Copy

let (response, httpResponse) = client.putRemoveBadge(badgeId = "verified-journalist",
  userId = "user-7890",
  commentId = "comment-98765",
  broadcastId = "",
  sso = "")
if response.isSome:
  let removeResp = response.get()
  discard removeResp
else:
  discard httpResponse

スレッドを再開

パラメータ

名前	型	必須	説明
urlId	string	はい
sso	string	いいえ

レスポンス

返却: Option[APIEmptyResponse]

例

putReopenThread の例

Copy

let (response, httpResponse) = client.putReopenThread(urlId = "news/2026-election-analysis", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Reopen succeeded, response: ", apiResp
else:
  echo "Reopen failed, HTTP status: ", httpResponse.status

信頼係数を設定

パラメータ

名前	型	必須
userId	string	いいえ
trustFactor	string	いいえ
sso	string	いいえ

レスポンス

戻り値: Option[SetUserTrustFactorResponse]

例

setTrustFactor の例

Copy

let (response, httpResponse) = client.setTrustFactor(userId = "user-9876", trustFactor = "high", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLTk4NzYiLCJpYXQiOjE2MjQwMDAwMDB9.signature")
if response.isSome:
  let resultObj = response.get()
  echo resultObj
else:
  echo "No response received"

モデレーターを作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createModeratorBody	CreateModeratorBody	いいえ

レスポンス

戻り値: Option[CreateModeratorResponse]

例

createModerator の例

Copy

var body: CreateModeratorBody
body.username = "alice.moderator"
body.displayName = "Alice Moderator"
body.email = "alice@news-site.com"
body.enabled = true
body.roles = @["moderator"]
body.notes = ""
let (response, httpResponse) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = body)
if response.isSome:
  let created = response.get()
  echo "Created moderator ID: ", created.id

モデレーターを削除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
sendEmail	string	いいえ

レスポンス

例

deleteModerator の例

Copy

let (response, httpResponse) = client.deleteModerator(tenantId = "my-tenant-123", id = "", sendEmail = "")
if response.isSome:
  let apiEmpty = response.get()
  echo "Moderator deleted successfully for tenant my-tenant-123"
else:
  echo "No response returned; inspect httpResponse"

モデレーターを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetModeratorResponse]

例

getModerator の例

Copy

let (response, httpResponse) = client.getModerator(tenantId = "my-tenant-123", id = "mod-456")
if response.isSome:
  let moderator = response.get()
  echo moderator
else:
  echo "Moderator not found, HTTP status: ", $httpResponse.status

モデレーター一覧を取得

パラメータ

Name	Type	Required	Description
tenantId	string	はい
skip	float64	いいえ

レスポンス

戻り値: Option[GetModeratorsResponse]

例

getModerators の例

Copy

let (response, httpResponse) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let moderators = response.get()
  echo "Received moderators response:", moderators
else:
  echo "No moderators returned"

モデレーターを更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateModeratorBody	UpdateModeratorBody	いいえ

レスポンス

例

updateModerator の例

Copy

let modBody: UpdateModeratorBody = UpdateModeratorBody(
  displayName = "Alice Moderator",
  email = "alice@newsdaily.com",
  isActive = true,
  permissions = @["delete_comments", "ban_users"]
)
let (response, httpResponse) = client.updateModerator(tenantId = "news-tenant-456", id = "moderator-789", updateModeratorBody = modBody)
if response.isSome:
  let apiEmpty = response.get()
  echo "Moderator updated successfully. HTTP status: ", httpResponse.status
else:
  echo "Failed to update moderator. HTTP status: ", httpResponse.status

通知カウントを削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

例

deleteNotificationCount の例

Copy

let (response, httpResponse) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notification-789")
if response.isSome:
  let emptyResp = response.get()
  echo "Notification count deleted for tenant: ", "my-tenant-123"
else:
  echo "Failed to delete notification count, status: ", $httpResponse.statusCode

キャッシュされた通知カウントを取得

パラメーター

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetCachedNotificationCountResponse]

例

getCachedNotificationCount の例

Copy

let (response, httpResponse) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "notification-789")
if response.isSome:
  let cached = response.get()
  echo "Cached notification count: ", $cached
else:
  echo "No cached notification count"

通知カウントを取得

パラメータ

名前	型	必須
tenantId	string	はい
userId	string	いいえ
urlId	string	はい
fromCommentId	string	いいえ
viewed	bool	いいえ

レスポンス

戻り値: Option[GetNotificationCountResponse]

例

getNotificationCount の例

Copy

let (response, httpResponse) = client.getNotificationCount(tenantId = "my-tenant-123", userId = "user-987", urlId = "news/2026/06/election-results", fromCommentId = "", viewed = false)
if response.isSome:
  let notifyData = response.get()
  echo notifyData

通知を取得

パラメータ

名称	型	必須
tenantId	string	はい
userId	string	いいえ
urlId	string	はい
fromCommentId	string	いいえ
viewed	bool	いいえ
skip	float64	いいえ

レスポンス

戻り値: Option[GetNotificationsResponse]

例

getNotifications の例

Copy

let (response, httpResponse) = client.getNotifications(tenantId = "my-tenant-123", userId = "user-456", urlId = "news/article-title", fromCommentId = "cmt-789", viewed = false, skip = 0.0)
if response.isSome:
  let notifications = response.get()
  echo notifications

通知を更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateNotificationBody	UpdateNotificationBody	いいえ
userId	string	いいえ

レスポンス

例

updateNotification の例

Copy

let (response, httpResponse) = client.updateNotification(
  tenantId = "my-tenant-123",
  id = "notif-456",
  updateNotificationBody = UpdateNotificationBody(
    enabled = true,
    channels = @["email", "push"],
    frequency = "immediate"
  ),
  userId = "user-789"
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

V1ページリアクトを作成

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
title	string	いいえ

レスポンス

例

createV1PageReact の例

Copy

let (response, httpResponse) = client.createV1PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/2026/market-rally",
  title = "Breaking News: Markets Rally Today"
)
if response.isSome:
  let pageReact = response.get()
  echo "Page react created: ", pageReact
else:
  echo "Failed to create page react: ", httpResponse

V2ページリアクトを作成

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
id	string	いいえ
title	string	いいえ

レスポンス

例

createV2PageReact の例

Copy

let (response, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/2026/06/fastcomments-release",
  id = "",
  title = ""
)
if response.isSome:
  let react = response.get()
  echo "Created page react: ", $react
else:
  echo "No react returned, HTTP status: ", $httpResponse.statusCode

V1ページリアクトを削除

パラメータ

Name	Type	Required	Description
tenantId	string	はい
urlId	string	はい

レスポンス

例

deleteV1PageReact の例

Copy

let (response, httpResponse) = client.deleteV1PageReact(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let deletedReact = response.get()
  echo "Deleted react:", deletedReact
else:
  echo "No react returned for tenant: my-tenant-123, url: news/article-title"

V2ページリアクトを削除

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
id	string	いいえ

レスポンス

例

deleteV2PageReact の例

Copy

let (response, httpResponse) = client.deleteV2PageReact(tenantId = "my-tenant-123", urlId = "news/2026/politics-election", id = "react-456")
if response.isSome:
  let react = response.get()
  echo react
else:
  echo "No reaction returned, status: ", httpResponse.status

V1ページいいねを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
urlId	string	はい

レスポンス

返却: Option[GetV1PageLikes]

例

getV1PageLikes の例

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/how-to-train-your-dragon")
if response.isSome:
  let pageLikes = response.get()
  echo "Fetched page likes for url:", "news/how-to-train-your-dragon"
else:
  echo "No likes returned for url:", "news/how-to-train-your-dragon"

V2ページリアクトを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
urlId	string	はい

レスポンス

戻り値: Option[GetV2PageReacts]

例

getV2PageReacts の例

Copy

let (response, httpResponse) = client.getV2PageReacts(tenantId = "my-tenant-123", urlId = "news/elections/2026/us-primary-results")
if response.isSome:
  let reacts = response.get()
  echo "Received reacts: ", $reacts
else:
  echo "No reacts available"

V2ページリアクトユーザーを取得

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetV2PageReactUsersResponse]

例

getV2PageReactUsers の例

Copy

let (response, httpResponse) = client.getV2PageReactUsers(tenantId = "my-tenant-123", urlId = "news/article-title", id = "")
if response.isSome:
  let usersResp = response.get()
  echo repr(usersResp)
else:
  echo "No page react users returned. HTTP response: ", repr(httpResponse)

ページを追加

パラメータ

名前	型	必須	説明
tenantId	string	はい
createAPIPageData	CreateAPIPageData	いいえ

レスポンス

戻り値: Option[AddPageAPIResponse]

例

addPage の例

Copy

var createData: CreateAPIPageData
createData.url = "news/nim-4-release"
createData.title = "Nim 4 Release Coverage"
createData.path = "/news/nim-4-release"
createData.isEnabled = true
createData.tags = @["nim", "release"]
createData.description = "Coverage of Nim 4 release"
let (response, httpResponse) = client.addPage(tenantId = "my-tenant-123", createAPIPageData = createData)
if response.isSome:
  let pageResp = response.get()
  echo pageResp

ページを削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[DeletePageAPIResponse]

例

deletePage の例

Copy

let (response, httpResponse) = client.deletePage(tenantId = "site-tenant-456", id = "news/winter-updates-2025")
if response.isSome:
  let deleted = response.get()
  echo "DeletePageAPIResponse:", deleted
else:
  echo "Delete failed, HTTP response:", httpResponse

オフラインユーザーを取得

現在オンラインではない、ページ上の過去のコメント投稿者。displayNameでソートされています。 /users/online を使い切った後に、"Members" セクションをレンダリングするために使用します。 commenterName によるカーソルページネーション: サーバーは部分インデックス {tenantId, urlId, commenterName} を afterName 以降へ $gt で順に走査し、$skip のコストは発生しません。

パラメータ

名前	型	必須
tenantId	string	はい
urlId	string	はい
afterName	string	いいえ
afterUserId	string	いいえ

レスポンス

返却: Option[PageUsersOfflineResponse]

例

getOfflineUsers の例

Copy

let (response, httpResponse) = client.getOfflineUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-how-to-code",
  afterName = "",
  afterUserId = ""
)
if response.isSome:
  let offlinePage = response.get()
  echo "Received offline users page"
  discard httpResponse.statusCode

オンラインユーザーを取得

ページの現在オンラインの閲覧者: 今まさにそのページに対してWebSocketセッションがサブスクライブされているユーザー。
anonCount + totalCount を返します（ルーム全体の購読者数。個々に列挙しない匿名閲覧者を含む）。

パラメーター

Name	Type	Required
tenantId	string	はい
urlId	string	はい
afterName	string	いいえ
afterUserId	string	いいえ

レスポンス

返却値: Option[PageUsersOnlineResponse]

例

getOnlineUsers の例

Copy

let (response, httpResponse) = client.getOnlineUsers(tenantId = "my-tenant-123", urlId = "news/politics/top-story", afterName = "", afterUserId = "")
if response.isSome:
  let page = response.get()
  echo "Received online users page:"
  echo page
else:
  echo "No online users returned. HTTP status: ", httpResponse.statusCode

URL IDでページを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
urlId	string	はい

レスポンス

戻り値: Option[GetPageByURLIdAPIResponse]

例

getPageByURLId の例

Copy

let (response, httpResponse) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let page = response.get()
  echo "Page ID: ", page.id
  echo "Title: ", page.title
  echo "URL: ", page.url
  echo "Published: ", $page.published
  echo "Tags: ", $page.tags
else:
  echo "No page found. HTTP status: ", httpResponse.statusCode

ページ一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい

レスポンス

戻り値: Option[GetPagesAPIResponse]

例

getPages の例

Copy

let (response, httpResponse) = client.getPages(tenantId = "news-site-456")
if response.isSome:
  let pages = response.get()
  echo "Received pages response: ", pages
else:
  echo "No pages returned. HTTP response: ", httpResponse

ページ一覧を取得（公開）

テナントのページを一覧表示します。FChat デスクトップクライアントがルームリストを生成するために使用します。各ページの解決済みカスタム設定で enableFChat が true である必要があります。 SSO を必要とするページは、リクエスト元ユーザーのグループアクセスに対してフィルタされます。

パラメータ

名前	型	必須
tenantId	string	はい
cursor	string	いいえ
limit	int	いいえ
q	string	いいえ
sortBy	PagesSortBy	いいえ
hasComments	bool	いいえ

レスポンス

戻り値: Option[GetPublicPagesResponse]

例

getPagesPublic の例

Copy

let (response, httpResponse) = client.getPagesPublic(
  tenantId = "my-tenant-123",
  cursor = "",
  limit = 0,
  q = "",
  sortBy = PagesSortBy(0),
  hasComments = false
)
if response.isSome:
  let pages = response.get()
  echo "Retrieved public pages: ", $pages
else:
  echo "No pages returned, HTTP status: ", $httpResponse.status

ユーザー情報を取得

テナントの大量ユーザー情報。userIds を指定すると、User / SSOUser から表示用情報を返します。コメントウィジェットが、プレゼンスイベントでちょうど出現したユーザーを補完するために使用します。ページコンテキストなし：プライバシーは一律に適用されます（非公開プロファイルはマスクされます）。

パラメータ

名前	型	必須	説明
tenantId	string	はい
ids	string	いいえ

レスポンス

戻り値: Option[PageUsersInfoResponse]

例

getUsersInfo の例

Copy

let (response, httpResponse) = client.getUsersInfo(tenantId = "my-tenant-123", ids = "user-42,user-87")
if response.isSome:
  let usersInfo = response.get()
  echo "Retrieved users info:", usersInfo
else:
  echo "No users info returned. HTTP status:", httpResponse.status

ページを部分更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateAPIPageData	UpdateAPIPageData	いいえ

レスポンス

戻り値: Option[PatchPageAPIResponse]

例

patchPage の例

Copy

let updateData = UpdateAPIPageData(
  title = "Breaking: Major Event Update",
  urlId = "news/major-event-update",
  visible = true,
  tags = @["breaking", "headline"],
  sortOrder = 5
)
let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/major-event-update",
  updateAPIPageData = updateData
)
if response.isSome:
  let page = response.get()
  discard page

保留中Webhookイベントを削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

例

deletePendingWebhookEvent の例

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "wh_evt_9f8b7a6c")
if response.isSome:
  let apiEmpty = response.get()
  echo "Pending webhook event deleted for tenant my-tenant-123"
else:
  echo "Failed to delete pending webhook event"

保留中Webhookイベント数を取得

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
externalId	string	いいえ
eventType	string	いいえ
domain	string	いいえ
attemptCountGT	float64	いいえ

レスポンス

戻り値: Option[GetPendingWebhookEventCountResponse]

例

getPendingWebhookEventCount の例

Copy

let (response, httpResponse) = client.getPendingWebhookEventCount(
  tenantId = "my-tenant-123",
  commentId = "cmt-456abc",
  externalId = "ext-7890",
  eventType = "comment_created",
  domain = "news.example.com",
  attemptCountGT = 2.0
)
if response.isSome:
  let pending = response.get()
  echo pending
else:
  echo "No pending webhook event count returned; HTTP status: ", httpResponse.status

保留中Webhookイベントを取得

パラメータ

名前	型	必須
tenantId	string	はい
commentId	string	はい
externalId	string	いいえ
eventType	string	いいえ
domain	string	いいえ
attemptCountGT	float64	いいえ
skip	float64	いいえ

レスポンス

戻り値: Option[GetPendingWebhookEventsResponse]

例

getPendingWebhookEvents の例

Copy

let (response, httpResponse) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0,
  skip = 0.0
)
if response.isSome:
  let pending = response.get()
  discard pending

質問設定を作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createQuestionConfigBody	CreateQuestionConfigBody	いいえ

レスポンス

戻り値: Option[CreateQuestionConfigResponse]

例

createQuestionConfig の例

Copy

let (response, httpResponse) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = CreateQuestionConfigBody(
    label = "Article Question",
    required = true,
    minLength = 20,
    maxLength = 1000,
    allowedTags = @["comment","question","feedback"],
    notifyModerators = false
  )
)
if response.isSome:
  let cfg = response.get()
  echo "Created question config id: ", cfg.id

質問設定を削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

例

deleteQuestionConfig の例

Copy

let (response, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let deleted = response.get()
  echo "Question config deleted for tenant: ", "my-tenant-123"
else:
  echo "Failed to delete question config"

質問設定を取得

パラメータ

Name	Type	Required	Description
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetQuestionConfigResponse]

例

getQuestionConfig の例

Copy

let (response, httpResponse) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "qst-456")
if response.isSome:
  let cfg = response.get()
  discard cfg

質問設定一覧を取得

パラメータ

名前	型	必須	説明
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 "Received question configs for tenant my-tenant-123"
  echo configs
else:
  echo "No question configs returned"

質問設定を更新

Parameters

Name	Type	Required
tenantId	string	はい
id	string	いいえ
updateQuestionConfigBody	UpdateQuestionConfigBody	いいえ

Response

Example

updateQuestionConfig の例

Copy

let (response, httpResponse) = client.updateQuestionConfig(tenantId = "my-tenant-123", id = "question-config-456", updateQuestionConfigBody = default(UpdateQuestionConfigBody))
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

質問結果を作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createQuestionResultBody	CreateQuestionResultBody	いいえ

レスポンス

戻り値: Option[CreateQuestionResultResponse]

例

createQuestionResult の例

Copy

let (response, httpResponse) = client.createQuestionResult(
  tenantId = "my-tenant-123",
  createQuestionResultBody = CreateQuestionResultBody(
    questionId = "q-2026-001",
    userId = "user-42",
    correct = true,
    score = 95,
    tags = @["news","reader-question"]
  )
)
if response.isSome:
  let result = response.get()
  echo "Created question result id: ", result.id
  echo "HTTP status: ", httpResponse.status.code

質問結果を削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

例

deleteQuestionResult の例

Copy

let tenantId = "my-tenant-123"
let resultId = "question-result-456"
let (response, httpResponse) = client.deleteQuestionResult(tenantId = tenantId, id = resultId)
if response.isSome:
  let emptyResp = response.get()
  echo "Deleted question result:", resultId

質問結果を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

返り値: Option[GetQuestionResultResponse]

例

getQuestionResult の例

Copy

let (response, httpResponse) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if response.isSome:
  let result = response.get()
  echo "Question result received:"
  echo result
else:
  echo "No question result returned, HTTP status: ", $httpResponse.status

質問結果一覧を取得

パラメータ

Name	Type	Required
tenantId	string	はい
urlId	string	はい
userId	string	いいえ
startDate	string	いいえ
questionId	string	いいえ
questionIds	string	いいえ
skip	float64	いいえ

レスポンス

戻り値: Option[GetQuestionResultsResponse]

例

getQuestionResults の例

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  urlId = "news/2026/election-analysis",
  userId = "user-42",
  startDate = "2026-06-01T00:00:00Z",
  questionId = "q-6789",
  questionIds = @["q-6789", "q-6790"],
  skip = 0.0
)
if response.isSome:
  let results = response.get()
  echo "Received question results"
else:
  echo "No results returned"

質問結果を更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateQuestionResultBody	UpdateQuestionResultBody	いいえ

レスポンス

例

updateQuestionResult の例

Copy

let (response, httpResponse) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-result-456",
  updateQuestionResultBody = UpdateQuestionResultBody(
    questionId: "q-789",
    userId: "user-42",
    score: 92,
    passed: true,
    tags: @["quiz", "math"]
  )
)
if response.isSome:
  let apiResp = response.get()
  echo "Question result updated successfully"
else:
  echo "No response body; HTTP status: ", httpResponse.status.code

質問結果を集計

パラメータ

名前	型	必須
tenantId	string	はい
questionId	string	いいえ
questionIds	seq[string]	いいえ
urlId	string	はい
timeBucket	AggregateTimeBucket	いいえ
startDate	string	いいえ
forceRecalculate	bool	いいえ

レスポンス

戻り値: Option[AggregateQuestionResultsResponse]

例

aggregateQuestionResults の例

Copy

let (response, httpResponse) = client.aggregateQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "",
  questionIds = @[],
  urlId = "news/article-title",
  timeBucket = AggregateTimeBucket(0),
  startDate = "",
  forceRecalculate = false
)
if response.isSome:
  let results = response.get()
  discard results

質問結果を一括集計

パラメータ

名前	型	必須
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

レスポンス

戻り値: Option[BulkAggregateQuestionResultsResponse]

例

bulkAggregateQuestionResults の例

Copy

let (response, httpResponse) = client.bulkAggregateQuestionResults(
  tenantId = "my-tenant-123",
  bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(),
  forceRecalculate = false
)
if response.isSome:
  let aggregated = response.get()
  echo "Aggregated question results received"

コメントと質問結果を結合

パラメータ

名前	型	必須
tenantId	string	はい
questionId	string	いいえ
questionIds	seq[string]	いいえ
urlId	string	はい
startDate	string	いいえ
forceRecalculate	bool	いいえ
minValue	float64	いいえ
maxValue	float64	いいえ
limit	float64	いいえ

レスポンス

戻り値: Option[CombineQuestionResultsWithCommentsResponse]

例

combineCommentsWithQuestionResults の例

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "",
  questionIds = @[],
  urlId = "news/article-2026-climate-change",
  startDate = "",
  forceRecalculate = false,
  minValue = 0.0,
  maxValue = 0.0,
  limit = 0.0
)
if response.isSome:
  let combined = response.get()
  echo "Combined results received for tenant:", " my-tenant-123"
else:
  echo "No combined results returned"

SSOユーザーを追加

パラメータ

名前	型	必須	説明
tenantId	string	はい
createAPISSOUserData	CreateAPISSOUserData	いいえ

レスポンス

戻り値: Option[AddSSOUserAPIResponse]

例

addSSOUser の例

Copy

let (response, httpResponse) = client.addSSOUser(
  tenantId = "my-tenant-123",
  createAPISSOUserData = CreateAPISSOUserData(
    id = "sso-456",
    email = "alice.johnson@newsorg.com",
    name = "Alice Johnson",
    roles = @["editor", "contributor"],
    isActive = true,
    isAdmin = false
  )
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp
else:
  discard httpResponse

SSOユーザーを削除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
deleteComments	bool	いいえ
commentDeleteMode	string	いいえ

レスポンス

返却値: Option[DeleteSSOUserAPIResponse]

例

deleteSSOUser の例

Copy

let (response, httpResponse) = client.deleteSSOUser(tenantId = "my-tenant-123", id = "sso-user-9876", deleteComments = true, commentDeleteMode = "hard")
if response.isSome:
  let deleted = response.get()
  discard deleted
else:
  discard httpResponse

メールでSSOユーザーを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
email	string	いいえ

レスポンス

戻り値: Option[GetSSOUserByEmailAPIResponse]

例

getSSOUserByEmail の例

Copy

let (response, httpResponse) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "alice@newsco.com")
if response.isSome:
  let ssoUser = response.get()
  echo "SSO user found: ", ssoUser.email
else:
  echo "No SSO user found. HTTP status: ", httpResponse.status

IDでSSOユーザーを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetSSOUserByIdAPIResponse]

例

getSSOUserById の例

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "user-789")
if response.isSome:
  let ssoUser: GetSSOUserByIdAPIResponse = response.get()
  echo "SSO user retrieved: ", $ssoUser
else:
  echo "No SSO user found, HTTP status: ", httpResponse.statusCode

SSOユーザー一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
skip	int	いいえ

レスポンス

戻り値: Option[GetSSOUsersResponse]

例

getSSOUsers の例

Copy

let (response, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if response.isSome:
  let ssoUsers = response.get()
  echo ssoUsers
else:
  echo "No SSO users returned; HTTP response:", httpResponse

SSOユーザーを部分更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateAPISSOUserData	UpdateAPISSOUserData	いいえ
updateComments	bool	いいえ

レスポンス

返却値: Option[PatchSSOUserAPIResponse]

例

patchSSOUser の例

Copy

let (response, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-987",
    username = "j.smith",
    email = "j.smith@news.example.com",
    displayName = "John Smith",
    roles = @["author", "editor"],
    avatarUrl = "https://cdn.news.example.com/avatars/j.smith.png"
  ),
  updateComments = true
)
if response.isSome:
  let patched = response.get()
  echo patched

SSOユーザーを置換/更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateAPISSOUserData	UpdateAPISSOUserData	いいえ
updateComments	bool	いいえ

レスポンス

戻り値: Option[PutSSOUserAPIResponse]

例

putSSOUser の例

Copy

let (response, httpResponse) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-789",
    displayName = "Jane Doe",
    email = "jane.doe@example.com",
    avatarUrl = "https://cdn.news-site.com/avatars/jane.jpg",
    roles = @["member", "subscriber"]
  ),
  updateComments = true
)
if response.isSome:
  let result = response.get()
  echo "SSO user updated:", result

サブスクリプションを作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	いいえ

レスポンス

戻り値: Option[CreateSubscriptionAPIResponse]

例

createSubscription の例

Copy

let createData = CreateAPIUserSubscriptionData(
  subscriberId = "user-987",
  email = "jane.doe@newsreader.com",
  urlId = "news/local-weather",
  active = true,
  tags = @["weather", "local"],
  frequency = "immediate"
)
let (response, httpResponse) = client.createSubscription(tenantId = "my-tenant-123", createAPIUserSubscriptionData = createData)
if response.isSome:
  let created = response.get()
  echo "Created subscription id: ", created.id

サブスクリプションを削除

パラメータ

Name	Type	Required
tenantId	string	はい
id	string	いいえ
userId	string	いいえ

レスポンス

戻り値: Option[DeleteSubscriptionAPIResponse]

例

deleteSubscription の例

Copy

let (response, httpResponse) = client.deleteSubscription(tenantId = "my-tenant-123", id = "sub-98765", userId = "user-456")
if response.isSome:
  let deleteResp = response.get()
  echo "Delete subscription response received"
else:
  echo "No subscription response"

サブスクリプション一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
userId	string	いいえ

レスポンス

戻り値: Option[GetSubscriptionsAPIResponse]

例

getSubscriptions の例

Copy

let (response, httpResponse) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "")
if response.isSome:
  let subscriptions = response.get()
  discard subscriptions

サブスクリプションを更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	いいえ
userId	string	いいえ

レスポンス

戻り値: Option[UpdateSubscriptionAPIResponse]

例

updateSubscription の例

Copy

let (response, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(
    subscribed = true,
    channels = @["email", "push"]
  ),
  userId = "user-789"
)
if response.isSome:
  let updated = response.get()
  echo "Subscription updated:", updated
else:
  echo "Update failed, HTTP response:", httpResponse

テナントの日次使用量を取得

パラメータ

名前	型	必須
tenantId	string	はい
yearNumber	float64	いいえ
monthNumber	float64	いいえ
dayNumber	float64	いいえ
skip	float64	いいえ

レスポンス

戻り値: Option[GetTenantDailyUsagesResponse]

例

getTenantDailyUsages の例

Copy

let (response, httpResponse) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  yearNumber = 2026.0,
  monthNumber = 6.0,
  dayNumber = 19.0,
  skip = 0.0
)
if response.isSome:
  let usage = response.get()
  discard usage

テナントパッケージを作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createTenantPackageBody	CreateTenantPackageBody	いいえ

レスポンス

返却値: Option[CreateTenantPackageResponse]

例

createTenantPackage の例

Copy

let (response, httpResponse) = client.createTenantPackage(tenantId = "my-tenant-123", createTenantPackageBody = CreateTenantPackageBody())
if response.isSome:
  let pkg = response.get()
  echo "Created tenant package: ", $pkg
else:
  echo "Failed to create tenant package, HTTP response: ", $httpResponse

テナントパッケージを削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

例

deleteTenantPackage の例

Copy

let (response, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "package-987")
if response.isSome:
  let emptyResp = response.get()
  echo emptyResp
else:
  echo "Failed to delete tenant package"

テナントパッケージを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetTenantPackageResponse]

例

getTenantPackage の例

Copy

let (response, httpResponse) = client.getTenantPackage(tenantId = "my-tenant-123", id = "premium-2026")
if response.isSome:
  let pkg = response.get()
  echo "Retrieved tenant package:"
  echo pkg
else:
  echo "Tenant package not found"

テナントパッケージ一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
skip	float64	いいえ

レスポンス

返却値: Option[GetTenantPackagesResponse]

例

getTenantPackages の例

Copy

let (response, httpResponse) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let packages = response.get()
  echo "Received tenant packages:"
  echo packages
else:
  echo "No packages found for tenant 'my-tenant-123'"

テナントパッケージを置換

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
replaceTenantPackageBody	ReplaceTenantPackageBody	いいえ

レスポンス

例

replaceTenantPackage の例

Copy

let (response, httpResponse) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-987",
  replaceTenantPackageBody = ReplaceTenantPackageBody(
    name = "Premium Plan",
    priceCents = 999,
    seats = 50,
    enabled = true,
    features = @["moderation", "analytics", "priority-support"]
  )
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

テナントパッケージを更新

パラメーター

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateTenantPackageBody	UpdateTenantPackageBody	いいえ

レスポンス

例

updateTenantPackage の例

Copy

let packageBody = UpdateTenantPackageBody(
  name: "Pro Plan",
  priceCents: 1999,
  active: true,
  features: @["priority-support", "advanced-moderation"]
)
let (response, httpResponse) = client.updateTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-789",
  updateTenantPackageBody = packageBody
)
if response.isSome:
  let apiEmpty = response.get()
  echo "Tenant package updated successfully, HTTP status: " & $httpResponse.status

テナントユーザーを作成

パラメータ

Name	Type	Required	Description
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

レスポンス

返り値: Option[CreateTenantUserResponse]

例

createTenantUser の例

Copy

let (response, httpResponse) = client.createTenantUser(tenantId = "my-tenant-123",
  createTenantUserBody = CreateTenantUserBody(userId = "user-456",
    email = "jane.doe@example.com",
    displayName = "Jane Doe",
    roles = @["editor"],
    isAdmin = false))
if response.isSome:
  let created = response.get()
  discard created

テナントユーザーを削除

パラメータ

Name	型	必須
tenantId	string	はい
id	string	いいえ
deleteComments	string	いいえ
commentDeleteMode	string	いいえ

レスポンス

例

deleteTenantUser の例

Copy

let (response, httpResponse) = client.deleteTenantUser(tenantId = "my-tenant-123", id = "user-789", deleteComments = "true", commentDeleteMode = "soft")
if response.isSome:
  let apiResp = response.get()
  echo "Tenant user deleted, response: ", apiResp
else:
  echo "Failed to delete tenant user, HTTP status: ", $httpResponse.status

テナントユーザーを取得

パラメータ

Name	Type	Required	Description
tenantId	string	はい
id	string	いいえ

レスポンス

返却値: Option[GetTenantUserResponse]

例

getTenantUser の例

Copy

let (response, httpResponse) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-789")
if response.isSome:
  let tenantUser = response.get()
  echo "User fetched:", tenantUser
else:
  echo "No user found, HTTP status:", httpResponse.status

テナントユーザー一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
skip	float64	いいえ

レスポンス

戻り値: Option[GetTenantUsersResponse]

例

getTenantUsers の例

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let tenantUsers = response.get()
  echo "Retrieved tenant users"
else:
  echo "No tenant users returned"

テナントユーザーを置換

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
replaceTenantUserBody	ReplaceTenantUserBody	いいえ
updateComments	string	いいえ

レスポンス

例

replaceTenantUser の例

Copy

let body = ReplaceTenantUserBody(
  displayName = "Jane Doe",
  email = "jane.doe@example.com",
  externalId = "jdoe-789",
  admin = false,
  enabled = true,
  tags = @["editor", "subscriber"]
)
let (response, httpResponse) = client.replaceTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  replaceTenantUserBody = body,
  updateComments = "true"
)
if response.isSome:
  let apiEmpty = response.get()
  echo "ReplaceTenantUser succeeded, http status:", httpResponse.status

ログインリンクを送信

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
redirectURL	string	いいえ

レスポンス

例

sendLoginLink の例

Copy

let (response, httpResponse) = client.sendLoginLink(tenantId = "my-tenant-123", id = "user-456", redirectURL = "https://app.newsportal.com/welcome")
if response.isSome:
  let apiResp = response.get()
  echo "Login link sent successfully"
else:
  echo "Failed to send login link, HTTP status: ", $httpResponse.status

テナントユーザーを更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateTenantUserBody	UpdateTenantUserBody	いいえ
updateComments	string	いいえ

レスポンス

例

updateTenantUser の例

Copy

let (response, httpResponse) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-987",
  updateTenantUserBody = UpdateTenantUserBody(
    displayName = "Jane Doe",
    email = "jane.doe@example.com",
    roles = @["moderator", "editor"],
    isActive = true
  ),
  updateComments = "true"
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

テナントを作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createTenantBody	CreateTenantBody	いいえ

レスポンス

戻り値: Option[CreateTenantResponse]

例

createTenant の例

Copy

let (response, httpResponse) = client.createTenant(
  tenantId = "my-tenant-123",
  createTenantBody = CreateTenantBody(
    name = "My Tenant 123",
    domain = "news.example.com",
    allowAnonymous = false,
    allowedOrigins = @["https://news.example.com", "https://api.news.example.com"],
    description = "Comments for News Example"
  )
)
if response.isSome:
  let created = response.get()
  echo "Created tenant: ", created.tenantId
else:
  echo "Failed to create tenant, status: ", httpResponse.status

テナントを削除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
sure	string	いいえ

レスポンス

例

deleteTenant の例

Copy

let (response, httpResponse) = client.deleteTenant(tenantId = "my-tenant-123", id = "", sure = "")
if response.isSome:
  let emptyResp = response.get()
else:
  discard httpResponse

テナントを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	いいえ

レスポンス

戻り値: Option[GetTenantResponse]

例

getTenant の例

Copy

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

テナント一覧を取得

パラメータ

名前	型	必須
tenantId	string	はい
meta	string	いいえ
skip	float64	いいえ

レスポンス

戻り値: Option[GetTenantsResponse]

例

getTenants の例

Copy

let (response, httpResponse) = client.getTenants(tenantId = "my-tenant-123", meta = "env=production", skip = 0.0)
if response.isSome:
  let tenantsResp = response.get()
  discard tenantsResp
  echo "Tenants fetched successfully"
else:
  echo "Request failed with status ", httpResponse.status

テナントを更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	いいえ
updateTenantBody	UpdateTenantBody	いいえ

レスポンス