SDK Nim de FastComments

Exemple

Exemple de 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"

blockFromCommentPublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
publicBlockFromCommentParams	PublicBlockFromCommentParams	Non
sso	string	Non

Réponse

Renvoie : Option[BlockSuccess]

Exemple

Exemple de 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

unBlockCommentPublic

Paramètres

Name	Type	Requis
tenantId	string	Oui
commentId	string	Oui
publicBlockFromCommentParams	PublicBlockFromCommentParams	Non
sso	string	Non

Réponse

Retourne : Option[UnblockSuccess]

Exemple

Exemple de 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

checkedCommentsForBlocked

Paramètres

Name	Type	Required
tenantId	string	Oui
commentIds	string	Non
sso	string	Non

Response

Renvoie : Option[CheckBlockedCommentsResponse]

Exemple

Exemple de 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

blockUserFromComment

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
blockFromCommentParams	BlockFromCommentParams	Non
userId	string	Non
anonUserId	string	Non

Response

Retourne : Option[BlockSuccess]

Exemple

Exemple de 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

createCommentPublic

Paramètres

Nom	Type	Requis
tenantId	string	Oui
urlId	string	Oui
broadcastId	string	Non
commentData	CommentData	Non
sessionId	string	Non
sso	string	Non

Réponse

Retourne : Option[SaveCommentsResponseWithPresence]

Exemple

Exemple de 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

deleteComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
contextUserId	string	Non
isLive	bool	Non

Réponse

Retourne : Option[DeleteCommentResult]

Exemple

Exemple de 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

deleteCommentPublic

Paramètres

Nom	Type	Requis
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
editKey	string	Non
sso	string	Non

Réponse

Renvoie : Option[PublicAPIDeleteCommentResponse]

Exemple

Exemple de 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

deleteCommentVote

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
voteId	string	Non
urlId	string	Oui
broadcastId	string	Non
editKey	string	Non
sso	string	Non

Réponse

Retourne: Option[VoteDeleteResponse]

Exemple

Exemple de 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

flagComment

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
userId	string	Non
anonUserId	string	Non

Réponse

Renvoie : Option[FlagCommentResponse]

Exemple

Exemple de 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"

getComment

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[APIGetCommentResponse]

Exemple

Exemple de 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"

getComments

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
page	int	Non
limit	int	Non
skip	int	Non
asTree	bool	Non
skipChildren	int	Non
limitChildren	int	Non
maxTreeDepth	int	Non
urlId	string	Oui
userId	string	Non
anonUserId	string	Non
contextUserId	string	Non
hashTag	string	Non
parentId	string	Non
direction	SortDirections	Non
fromDate	int64	Non
toDate	int64	Non

Réponse

Retourne : Option[APIGetCommentsResponse]

Exemple

Exemple de 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

getCommentsPublic

req tenantId urlId

Paramètres

Name	Type	Requis
tenantId	string	Oui
urlId	string	Oui
page	int	Non
direction	SortDirections	Non
sso	string	Non
skip	int	Non
skipChildren	int	Non
limit	int	Non
limitChildren	int	Non
countChildren	bool	Non
fetchPageForCommentId	string	Non
includeConfig	bool	Non
countAll	bool	Non
includei10n	bool	Non
locale	string	Non
modules	string	Non
isCrawler	bool	Non
includeNotificationCount	bool	Non
asTree	bool	Non
maxTreeDepth	int	Non
useFullTranslationIds	bool	Non
parentId	string	Non
searchText	string	Non
hashTags	seq[string]	Non
userId	string	Non
customConfigStr	string	Non
afterCommentId	string	Non
beforeCommentId	string	Non

Réponse

Renvoie : Option[GetCommentsResponseWithPresencePublicComment]

Exemple

Exemple de 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

getCommentText

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

Réponse

Renvoie : Option[PublicAPIGetCommentTextResponse]

Exemple

Exemple de 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"

getCommentVoteUserNames

Paramètres

Name	Type	Requis
tenantId	string	Oui
commentId	string	Oui
dir	int	Non
sso	string	Non

Réponse

Retourne: Option[GetCommentVoteUserNamesSuccessResponse]

Exemple

Exemple d'utilisation de 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

lockComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
sso	string	Non

Réponse

Exemple

Exemple de 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

pinComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie : Option[ChangeCommentPinStatusResponse]

Exemple

Exemple de 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"

saveComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
createCommentParams	CreateCommentParams	Non
isLive	bool	Non
doSpamCheck	bool	Non
sendEmails	bool	Non
populateNotifications	bool	Non

Réponse

Retourne : Option[APISaveCommentResponse]

Exemple

Exemple de 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

saveCommentsBulk

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
createCommentParams	seq[CreateCommentParams]	Non
isLive	bool	Non
doSpamCheck	bool	Non
sendEmails	bool	Non
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	Non
id	string	Non
fromName	string	Non

Réponse

Exemple

Exemple de 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"

setCommentText

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
commentTextUpdateRequest	CommentTextUpdateRequest	Non
editKey	string	Non
sso	string	Non

Réponse

Renvoie : Option[PublicAPISetCommentTextResponse]

Exemple

Exemple de 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

unBlockUserFromComment

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
unBlockFromCommentParams	UnBlockFromCommentParams	Non
userId	string	Non
anonUserId	string	Non

Réponse

Renvoie: Option[UnblockSuccess]

Exemple

Exemple de unBlockUserFromComment

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"

unFlagComment

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
userId	string	Non
anonUserId	string	Non

Réponse

Renvoie : Option[FlagCommentResponse]

Exemple

Exemple d'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

unLockComment

Paramètres

Nom	Type	Requis
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
sso	string	Non

Réponse

Exemple

Exemple de 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

unPinComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie : Option[ChangeCommentPinStatusResponse]

Exemple

Exemple d'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

updateComment

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
updatableCommentParams	UpdatableCommentParams	Non
contextUserId	string	Non
doSpamCheck	bool	Non
isLive	bool	Non

Réponse

Exemple

Exemple de 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

voteComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
urlId	string	Oui
broadcastId	string	Non
voteBodyParams	VoteBodyParams	Non
sessionId	string	Non
sso	string	Non

Réponse

Renvoie : Option[VoteResponse]

Exemple

Exemple de 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

getCommentsForUser

Paramètres

Name	Type	Requis
userId	string	Non
direction	SortDirections	Non
repliesToUserId	string	Non
page	float64	Non
includei10n	bool	Non
locale	string	Non
isCrawler	bool	Non

Réponse

Retourne : Option[GetCommentsForUserResponse]

Exemple

Exemple de 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

addDomainConfig

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
addDomainConfigParams	AddDomainConfigParams	Non

Réponse

Renvoie: Option[AddDomainConfigResponse]

Exemple

Exemple 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

deleteDomainConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
domain	string	Non

Réponse

Renvoie : Option[DeleteDomainConfigResponse]

Exemple

Exemple de 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

getDomainConfig

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
domain	string	Non

Réponse

Retourne : Option[GetDomainConfigResponse]

Exemple

Exemple 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

getDomainConfigs

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui

Réponse

Renvoie : Option[GetDomainConfigsResponse]

Exemple

Exemple de 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"

patchDomainConfig

Paramètres

Nom	Type	Requis
tenantId	string	Oui
domainToUpdate	string	Non
patchDomainConfigParams	PatchDomainConfigParams	Non

Réponse

Renvoie : Option[PatchDomainConfigResponse]

Exemple

Exemple de 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

putDomainConfig

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
domainToUpdate	string	Non
updateDomainConfigParams	UpdateDomainConfigParams	Non

Réponse

Renvoie: Option[PutDomainConfigResponse]

Exemple

Exemple 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

createEmailTemplate

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
createEmailTemplateBody	CreateEmailTemplateBody	Non

Réponse

Retourne: Option[CreateEmailTemplateResponse]

Exemple

Exemple de 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

deleteEmailTemplate

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de 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"

deleteEmailTemplateRenderError

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
errorId	string	Non

Réponse

Exemple

Exemple de deleteEmailTemplateRenderError

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

getEmailTemplate

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetEmailTemplateResponse]

Exemple

Exemple de getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui

Réponse

Renvoie: Option[GetEmailTemplateDefinitionsResponse]

Exemple

Exemple de 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

getEmailTemplateRenderErrors

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
skip	float64	Non

Réponse

Renvoie: Option[GetEmailTemplateRenderErrorsResponse]

Exemple

Exemple de 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

getEmailTemplates

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetEmailTemplatesResponse]

Exemple

Exemple de 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"

renderEmailTemplate

Paramètres

Nom	Type	Requis
tenantId	string	Oui
renderEmailTemplateBody	RenderEmailTemplateBody	Non
locale	string	Non

Réponse

Renvoie : Option[RenderEmailTemplateResponse]

Exemple

Exemple de 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

updateEmailTemplate

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateEmailTemplateBody	UpdateEmailTemplateBody	Non

Réponse

Exemple

Exemple de 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

getEventLog

req tenantId urlId userIdWS

Paramètres

Nom	Type	Requis
tenantId	string	Oui
urlId	string	Oui
userIdWS	string	Non
startTime	int64	Non
endTime	int64	Non

Réponse

Retourne: Option[GetEventLogResponse]

Exemple

Exemple de 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

getGlobalEventLog

req tenantId urlId userIdWS

Paramètres

Nom	Type	Requis
tenantId	string	Oui
urlId	string	Oui
userIdWS	string	Non
startTime	int64	Non
endTime	int64	Non

Réponse

Renvoie: Option[GetEventLogResponse]

Exemple

Exemple de 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

createFeedPost

Paramètres

Nom	Type	Requis
tenantId	string	Oui
createFeedPostParams	CreateFeedPostParams	Non
broadcastId	string	Non
isLive	bool	Non
doSpamCheck	bool	Non
skipDupCheck	bool	Non

Réponse

Renvoie: Option[CreateFeedPostsResponse]

Exemple

Exemple de 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

createFeedPostPublic

Paramètres

Nom	Type	Requis
tenantId	string	Oui
createFeedPostParams	CreateFeedPostParams	Non
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie: Option[CreateFeedPostResponse]

Exemple

Exemple de 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

deleteFeedPostPublic

Paramètres

Nom	Type	Requis
tenantId	string	Oui
postId	string	Non
broadcastId	string	Non
sso	string	Non

Réponse

Retourne : Option[DeleteFeedPostPublicResponse]

Exemple

Exemple de 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"

getFeedPosts

req tenantId afterId

Paramètres

Nom	Type	Requis
tenantId	string	Oui
afterId	string	Non
limit	int	Non
tags	seq[string]	Non

Réponse

Renvoie: Option[GetFeedPostsResponse]

Exemple

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

getFeedPostsPublic

req tenantId afterId

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
afterId	string	Non
limit	int	Non
tags	seq[string]	Non
sso	string	Non
isCrawler	bool	Non
includeUserInfo	bool	Non

Réponse

Renvoie: Option[PublicFeedPostsResponse]

Exemple

Exemple de 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

getFeedPostsStats

Paramètres

Name	Type	Required
tenantId	string	Oui
postIds	seq[string]	Non
sso	string	Non

Réponse

Renvoie: Option[FeedPostsStatsResponse]

Exemple

Exemple de 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

getUserReactsPublic

Paramètres

Name	Type	Obligatoire
tenantId	string	Oui
postIds	seq[string]	Non
sso	string	Non

Réponse

Renvoie : Option[UserReactsResponse]

Exemple

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

reactFeedPostPublic

Paramètres

Name	Type	Requis
tenantId	string	Oui
postId	string	Non
reactBodyParams	ReactBodyParams	Non
isUndo	bool	Non
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie : Option[ReactFeedPostResponse]

Exemple

Exemple de 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

updateFeedPost

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
feedPost	FeedPost	Non

Réponse

Exemple

Exemple d'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

updateFeedPostPublic

Paramètres

Nom	Type	Requis
tenantId	string	Oui
postId	string	Non
updateFeedPostParams	UpdateFeedPostParams	Non
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie : Option[CreateFeedPostResponse]

Exemple

Exemple de 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

flagCommentPublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
isFlagged	bool	Non
sso	string	Non

Réponse

Exemple

Exemple de 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

getGifLarge

Paramètres

Name	Type	Requis	Description
tenantId	string	Oui
largeInternalURLSanitized	string	Non

Réponse

Renvoie : Option[GifGetLargeResponse]

Exemple

Exemple de 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

getGifsSearch

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
search	string	Non
locale	string	Non
rating	string	Non
page	float64	Non

Réponse

Renvoie: Option[GetGifsSearchResponse]

Exemple

Exemple de 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

getGifsTrending

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
locale	string	Non
rating	string	Non
page	float64	Non

Réponse

Renvoie : Option[GetGifsTrendingResponse]

Exemple

Exemple de 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()

addHashTag

Paramètres

Name	Type	Obligatoire	Description
tenantId	string	Oui
createHashTagBody	CreateHashTagBody	Non

Réponse

Renvoie: Option[CreateHashTagResponse]

Exemple

Exemple d'appel 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

addHashTagsBulk

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Non

Réponse

Renvoie: Option[BulkCreateHashTagsResponse]

Exemple

Exemple 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

deleteHashTag

Paramètres

Name	Type	Required
tag	string	Non
tenantId	string	Oui
deleteHashTagRequestBody	DeleteHashTagRequestBody	Non

Réponse

Exemple

Exemple de 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

getHashTags

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
page	float64	Non

Réponse

Renvoie: Option[GetHashTagsResponse]

Exemple

Exemple de 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"

patchHashTag

Paramètres

Nom	Type	Requis
tag	string	Non
tenantId	string	Oui
updateHashTagBody	UpdateHashTagBody	Non

Réponse

Renvoie : Option[UpdateHashTagResponse]

Exemple

Exemple de 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

deleteModerationVote

Paramètres

Nom	Type	Requis
commentId	string	Yes
voteId	string	No
sso	string	No

Réponse

Retourne : Option[VoteDeleteResponse]

Exemple

Exemple de 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

getApiComments

Paramètres

Nom	Type	Requis
page	float64	Non
count	float64	Non
textSearch	string	Non
byIPFromComment	string	Non
filters	string	Non
searchFilters	string	Non
sorts	string	Non
demo	bool	Non
sso	string	Non

Réponse

Retourne : Option[ModerationAPIGetCommentsResponse]

Exemple

Exemple de 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

getApiExportStatus

Paramètres

Nom	Type	Obligatoire	Description
batchJobId	string	Non
sso	string	Non

Réponse

Retourne: Option[ModerationExportStatusResponse]

Exemple

Exemple de 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

getApiIds

Paramètres

Nom	Type	Obligatoire
textSearch	string	Non
byIPFromComment	string	Non
filters	string	Non
searchFilters	string	Non
afterId	string	Non
demo	bool	Non
sso	string	Non

Réponse

Renvoie: Option[ModerationAPIGetCommentIdsResponse]

Exemple

Exemple de 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

getBanUsersFromComment

Paramètres

Nom	Type	Requis	Description
commentId	string	Oui
sso	string	Non

Réponse

Retourne : Option[GetBannedUsersFromCommentResponse]

Exemple

Exemple de 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"

getCommentBanStatus

Paramètres

Nom	Type	Requis	Description
commentId	string	Oui
sso	string	Non

Réponse

Renvoie: Option[GetCommentBanStatusResponse]

Exemple

Exemple de 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"

getCommentChildren

Paramètres

Name	Type	Requis	Description
commentId	string	Oui
sso	string	Non

Réponse

Retourne: Option[ModerationAPIChildCommentsResponse]

Exemple

Exemple de getCommentChildren

Copy

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

getCount

Paramètres

Nom	Type	Requis
textSearch	string	Non
byIPFromComment	string	Non
filter	string	Non
searchFilters	string	Non
demo	bool	Non
sso	string	Non

Réponse

Renvoie : Option[ModerationAPICountCommentsResponse]

Exemple

Exemple de 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"

getCounts

Paramètres

Name	Type	Requis	Description
sso	string	Non

Response

Renvoie : Option[GetBannedUsersCountResponse]

Exemple

Exemple de 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

getLogs

Paramètres

Name	Type	Requis	Description
commentId	string	Oui
sso	string	Non

Réponse

Renvoie : Option[ModerationAPIGetLogsResponse]

Exemple

Exemple de getLogs

Copy

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

getManualBadges

Paramètres

Nom	Type	Requis	Description
sso	string	Non

Réponse

Retourne : Option[GetTenantManualBadgesResponse]

Exemple

Exemple de 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

getManualBadgesForUser

Paramètres

Nom	Type	Obligatoire
badgesUserId	string	Non
commentId	string	Oui
sso	string	Non

Réponse

Renvoie : Option[GetUserManualBadgesResponse]

Exemple

Exemple de 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

getModerationComment

Paramètres

Nom	Type	Requis
commentId	string	Oui
includeEmail	bool	Non
includeIP	bool	Non
sso	string	Non

Réponse

Renvoie: Option[ModerationAPICommentResponse]

Exemple

Exemple de 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"

getModerationCommentText

Paramètres

Name	Type	Requis	Description
commentId	string	Oui
sso	string	Non

Réponse

Renvoie : Option[GetCommentTextResponse]

Exemple

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

getPreBanSummary

Paramètres

Nom	Type	Requis
commentId	string	Oui
includeByUserIdAndEmail	bool	Non
includeByIP	bool	Non
includeByEmailDomain	bool	Non
sso	string	Non

Réponse

Renvoie: Option[PreBanSummary]

Exemple

Exemple 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

getSearchCommentsSummary

Paramètres

Name	Type	Obligatoire
value	string	Non
filters	string	Non
searchFilters	string	Non
sso	string	Non

Réponse

Renvoie : Option[ModerationCommentSearchResponse]

Exemple

Exemple 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

getSearchPages

Paramètres

Name	Type	Obligatoire	Description
value	string	Non
sso	string	Non

Réponse

Retourne : Option[ModerationPageSearchResponse]

Exemple

Exemple de 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"

getSearchSites

Paramètres

Nom	Type	Obligatoire	Description
value	string	Non
sso	string	Non

Réponse

Renvoie: Option[ModerationSiteSearchResponse]

Exemple

Exemple de 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

getSearchSuggest

Paramètres

Nom	Type	Requis	Description
textSearch	string	Non
sso	string	Non

Réponse

Retourne: Option[ModerationSuggestResponse]

Exemple

Exemple de 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

getSearchUsers

Paramètres

Nom	Type	Requis	Description
value	string	Non
sso	string	Non

Réponse

Renvoie: Option[ModerationUserSearchResponse]

Exemple

Exemple de 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"

getTrustFactor

Paramètres

Nom	Type	Obligatoire	Description
userId	string	Non
sso	string	Non

Réponse

Renvoie: Option[GetUserTrustFactorResponse]

Exemple

Exemple de 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

getUserBanPreference

Paramètres

Nom	Type	Obligatoire	Description
sso	string	Non

Réponse

Renvoie: Option[APIModerateGetUserBanPreferencesResponse]

Exemple

Exemple de 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"

getUserInternalProfile

Paramètres

Nom	Type	Obligatoire	Description
commentId	string	Oui
sso	string	Non

Réponse

Retourne: Option[GetUserInternalProfileResponse]

Exemple

Exemple 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

postAdjustCommentVotes

Paramètres

Nom	Type	Requis
commentId	string	Oui
adjustCommentVotesParams	AdjustCommentVotesParams	Non
sso	string	Non

Réponse

Renvoie : Option[AdjustVotesResponse]

Exemple

Exemple de 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

postApiExport

Paramètres

Name	Type	Obligatoire
textSearch	string	Non
byIPFromComment	string	Non
filters	string	Non
searchFilters	string	Non
sorts	string	Non
sso	string	Non

Réponse

Retourne: Option[ModerationExportResponse]

Exemple

Exemple de 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

postBanUserFromComment

Paramètres

Nom	Type	Requis
commentId	string	Oui
banEmail	bool	Non
banEmailDomain	bool	Non
banIP	bool	Non
deleteAllUsersComments	bool	Non
bannedUntil	string	Non
isShadowBan	bool	Non
updateId	string	Non
banReason	string	Non
sso	string	Non

Réponse

Renvoie: Option[BanUserFromCommentResult]

Exemple

Exemple de 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"

postBanUserUndo

Paramètres

Nom	Type	Requis	Description
banUserUndoParams	BanUserUndoParams	Non
sso	string	Non

Réponse

Exemple

Exemple de 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

postBulkPreBanSummary

Paramètres

Name	Type	Requis
bulkPreBanParams	BulkPreBanParams	Non
includeByUserIdAndEmail	bool	Non
includeByIP	bool	Non
includeByEmailDomain	bool	Non
sso	string	Non

Réponse

Renvoie : Option[BulkPreBanSummary]

Exemple

Exemple de 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

postCommentsByIds

Paramètres

Nom	Type	Obligatoire	Description
commentsByIdsParams	CommentsByIdsParams	Non
sso	string	Non

Réponse

Renvoie: Option[ModerationAPIChildCommentsResponse]

Exemple

Exemple de 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

postFlagComment

Paramètres

Nom	Type	Obligatoire	Description
commentId	string	Oui
sso	string	Non

Réponse

Exemple

Exemple de 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"

postRemoveComment

Paramètres

Nom	Type	Requis	Description
commentId	string	Oui
sso	string	Non

Réponse

Retourne: Option[PostRemoveCommentResponse]

Exemple

Exemple de 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

postRestoreDeletedComment

Paramètres

Nom	Type	Obligatoire	Description
commentId	string	Oui
sso	string	Non

Réponse

Exemple

Exemple de 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"

postSetCommentApprovalStatus

Paramètres

Nom	Type	Requis
commentId	string	Oui
approved	bool	Non
sso	string	Non

Réponse

Renvoie : Option[SetCommentApprovedResponse]

Exemple

Exemple de postSetCommentApprovalStatus

Copy

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

postSetCommentReviewStatus

Paramètres

Name	Type	Required
commentId	string	Oui
reviewed	bool	Non
sso	string	Non

Réponse

Exemple

Exemple de 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

postSetCommentSpamStatus

Paramètres

Nom	Type	Requis
commentId	string	Oui
spam	bool	Non
permNotSpam	bool	Non
sso	string	Non

Réponse

Exemple

Exemple de 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

postSetCommentText

Paramètres

Nom	Type	Requis
commentId	string	Oui
setCommentTextParams	SetCommentTextParams	Non
sso	string	Non

Réponse

Retourne: Option[SetCommentTextResponse]

Exemple

Exemple de 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"

postUnFlagComment

Paramètres

Nom	Type	Obligatoire	Description
commentId	string	Oui
sso	string	Non

Réponse

Exemple

Exemple de 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

postVote

Paramètres

Nom	Type	Requis
commentId	string	Oui
direction	string	Non
sso	string	Non

Réponse

Renvoie: Option[VoteResponse]

Exemple

Exemple de 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"

putAwardBadge

Paramètres

Nom	Type	Obligatoire
badgeId	string	Non
userId	string	Non
commentId	string	Oui
broadcastId	string	Non
sso	string	Non

Réponse

Retourne: Option[AwardUserBadgeResponse]

Exemple

Exemple de 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"

putCloseThread

Paramètres

Nom	Type	Requis	Description
urlId	string	Oui
sso	string	Non

Réponse

Exemple

Exemple pour 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

putRemoveBadge

Paramètres

Nom	Type	Requis
badgeId	string	Non
userId	string	Non
commentId	string	Oui
broadcastId	string	Non
sso	string	Non

Réponse

Retourne: Option[RemoveUserBadgeResponse]

Exemple

Exemple de 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

putReopenThread

Paramètres

Nom	Type	Requis	Description
urlId	string	Oui
sso	string	Non

Réponse

Exemple

Exemple de 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

setTrustFactor

Paramètres

Nom	Type	Obligatoire
userId	string	Non
trustFactor	string	Non
sso	string	Non

Réponse

Renvoie: Option[SetUserTrustFactorResponse]

Exemple

Exemple de 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"

createModerator

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createModeratorBody	CreateModeratorBody	Non

Réponse

Renvoie: Option[CreateModeratorResponse]

Exemple

Exemple de 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

deleteModerator

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
sendEmail	string	Non

Réponse

Exemple

Exemple de 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"

getModerator

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne: Option[GetModeratorResponse]

Exemple

Exemple de 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

getModerators

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetModeratorsResponse]

Exemple

Exemple de 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"

updateModerator

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
updateModeratorBody	UpdateModeratorBody	Non

Réponse

Exemple

Exemple pour 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

deleteNotificationCount

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de 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

getCachedNotificationCount

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetCachedNotificationCountResponse]

Exemple

Exemple de 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"

getNotificationCount

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
userId	string	No
urlId	string	Yes
fromCommentId	string	No
viewed	bool	No

Réponse

Renvoie: Option[GetNotificationCountResponse]

Exemple

Exemple de 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

getNotifications

Paramètres

Name	Type	Required
tenantId	string	Oui
userId	string	Non
urlId	string	Oui
fromCommentId	string	Non
viewed	bool	Non
skip	float64	Non

Réponse

Retourne : Option[GetNotificationsResponse]

Exemple

Exemple de 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

updateNotification

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateNotificationBody	UpdateNotificationBody	Non
userId	string	Non

Réponse

Exemple

Exemple de 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

createV1PageReact

Paramètres

Name	Type	Required
tenantId	string	Oui
urlId	string	Oui
title	string	Non

Réponse

Renvoie : Option[CreateV1PageReact]

Exemple

Exemple de 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

createV2PageReact

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
id	string	Non
title	string	Non

Réponse

Renvoie : Option[CreateV1PageReact]

Exemple

Exemple de 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

deleteV1PageReact

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Renvoie: Option[CreateV1PageReact]

Exemple

Exemple de 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"

deleteV2PageReact

Paramètres

Name	Type	Required
tenantId	string	Oui
urlId	string	Oui
id	string	Non

Réponse

Retourne: Option[CreateV1PageReact]

Exemple

Exemple de 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

getV1PageLikes

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Retourne : Option[GetV1PageLikes]

Exemple

Exemple de 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"

getV2PageReacts

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Retourne: Option[GetV2PageReacts]

Exemple

Exemple de 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"

getV2PageReactUsers

Paramètres

Nom	Type	Requis
tenantId	string	Oui
urlId	string	Oui
id	string	Non

Réponse

Retourne : Option[GetV2PageReactUsersResponse]

Exemple

Exemple de 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)

addPage

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
createAPIPageData	CreateAPIPageData	Non

Réponse

Retourne : Option[AddPageAPIResponse]

Exemple

Exemple 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

deletePage

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne: Option[DeletePageAPIResponse]

Exemple

Exemple de 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

getOfflineUsers

Commentateurs précédents sur la page qui NE sont PAS actuellement en ligne. Triés par displayName. Utilisez ceci après avoir épuisé /users/online pour afficher une section «Membres». Pagination par curseur sur commenterName : le serveur parcourt l'index partiel {tenantId, urlId, commenterName} index depuis afterName vers l'avant via $gt, sans coût lié à $skip.

Paramètres

Name	Type	Required
tenantId	string	Oui
urlId	string	Oui
afterName	string	Non
afterUserId	string	Non

Réponse

Renvoie : Option[PageUsersOfflineResponse]

Exemple

Exemple de 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

getOnlineUsers

Visiteurs actuellement en ligne d'une page : personnes dont la session websocket est abonnée à la page en ce moment. Renvoie anonCount + totalCount (abonnés à l'échelle de la salle, y compris les visiteurs anonymes que nous n'énumérons pas).

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
afterName	string	Non
afterUserId	string	Non

Réponse

Retourne: Option[PageUsersOnlineResponse]

Exemple

Exemple de 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

getPageByURLId

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Retourne: Option[GetPageByURLIdAPIResponse]

Exemple

Exemple de 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

getPages

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui

Réponse

Renvoie: Option[GetPagesAPIResponse]

Exemple

Exemple de 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

getPagesPublic

Lister les pages d'un locataire. Utilisé par le client de bureau FChat pour remplir sa liste de salles. Requiert que enableFChat soit true dans la configuration personnalisée résolue pour chaque page. Les pages nécessitant SSO sont filtrées en fonction de l'accès aux groupes de l'utilisateur demandeur.

Paramètres

Name	Type	Required
tenantId	string	Oui
cursor	string	Non
limit	int	Non
q	string	Non
sortBy	PagesSortBy	Non
hasComments	bool	Non

Réponse

Retourne : Option[GetPublicPagesResponse]

Exemple

Exemple 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

getUsersInfo

Informations utilisateur en masse pour un locataire. Étant donné des userIds, renvoie les informations d'affichage de User / SSOUser. Utilisé par le widget de commentaires pour enrichir les utilisateurs qui viennent d'apparaître via un événement de présence. Pas de contexte de page : la confidentialité est appliquée uniformément (les profils privés sont masqués).

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
ids	string	Non

Réponse

Renvoie: Option[PageUsersInfoResponse]

Exemple

Exemple de 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

patchPage

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateAPIPageData	UpdateAPIPageData	Non

Réponse

Renvoie : Option[PatchPageAPIResponse]

Exemple

Exemple de 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

deletePendingWebhookEvent

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de 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"

getPendingWebhookEventCount

Paramètres

Nom	Type	Requis
tenantId	string	Oui
commentId	string	Oui
externalId	string	Non
eventType	string	Non
domain	string	Non
attemptCountGT	float64	Non

Réponse

Retourne: Option[GetPendingWebhookEventCountResponse]

Exemple

Exemple de 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

getPendingWebhookEvents

Paramètres

Nom	Type	Requis
tenantId	string	Oui
commentId	string	Oui
externalId	string	Non
eventType	string	Non
domain	string	Non
attemptCountGT	float64	Non
skip	float64	Non

Réponse

Retourne : Option[GetPendingWebhookEventsResponse]

Exemple

Exemple de 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

createQuestionConfig

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
createQuestionConfigBody	CreateQuestionConfigBody	Non

Réponse

Renvoie : Option[CreateQuestionConfigResponse]

Exemple

Exemple de 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

deleteQuestionConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de 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"

getQuestionConfig

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetQuestionConfigResponse]

Exemple

Exemple de getQuestionConfig

Copy

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

getQuestionConfigs

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetQuestionConfigsResponse]

Exemple

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

updateQuestionConfig

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
updateQuestionConfigBody	UpdateQuestionConfigBody	Non

Réponse

Exemple

Exemple de 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

createQuestionResult

Paramètres

Name	Type	Obligatoire	Description
tenantId	string	Oui
createQuestionResultBody	CreateQuestionResultBody	Non

Réponse

Renvoie : Option[CreateQuestionResultResponse]

Exemple

Exemple de 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

deleteQuestionResult

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de 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

getQuestionResult

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetQuestionResultResponse]

Exemple

Exemple de 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

getQuestionResults

Paramètres

Name	Type	Requis
tenantId	string	Oui
urlId	string	Oui
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	float64	Non

Réponse

Renvoie : Option[GetQuestionResultsResponse]

Exemple

Exemple de 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"

updateQuestionResult

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateQuestionResultBody	UpdateQuestionResultBody	Non

Réponse

Exemple

Exemple de 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

aggregateQuestionResults

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
questionId	string	Non
questionIds	seq[string]	Non
urlId	string	Oui
timeBucket	AggregateTimeBucket	Non
startDate	string	Non
forceRecalculate	bool	Non

Réponse

Retourne : Option[AggregateQuestionResultsResponse]

Exemple

Exemple 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

bulkAggregateQuestionResults

Paramètres

Name	Type	Required
tenantId	string	Oui
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Non
forceRecalculate	bool	Non

Réponse

Renvoie : Option[BulkAggregateQuestionResultsResponse]

Exemple

Exemple de 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"

combineCommentsWithQuestionResults

Paramètres

Nom	Type	Requis
tenantId	string	Oui
questionId	string	Non
questionIds	seq[string]	Non
urlId	string	Oui
startDate	string	Non
forceRecalculate	bool	Non
minValue	float64	Non
maxValue	float64	Non
limit	float64	Non

Réponse

Renvoie : Option[CombineQuestionResultsWithCommentsResponse]

Exemple

Exemple de 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"

addSSOUser

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createAPISSOUserData	CreateAPISSOUserData	Non

Réponse

Retourne: Option[AddSSOUserAPIResponse]

Exemple

Exemple 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

deleteSSOUser

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
deleteComments	bool	Non
commentDeleteMode	string	Non

Réponse

Renvoie : Option[DeleteSSOUserAPIResponse]

Exemple

Exemple 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

getSSOUserByEmail

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
email	string	Non

Réponse

Renvoie: Option[GetSSOUserByEmailAPIResponse]

Exemple

Exemple de 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

getSSOUserById

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetSSOUserByIdAPIResponse]

Exemple

Exemple 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

getSSOUsers

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
skip	int	Non

Réponse

Renvoie: Option[GetSSOUsersResponse]

Exemple

Exemple 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

patchSSOUser

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateAPISSOUserData	UpdateAPISSOUserData	Non
updateComments	bool	Non

Réponse

Retourne: Option[PatchSSOUserAPIResponse]

Exemple

Exemple de 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

putSSOUser

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateAPISSOUserData	UpdateAPISSOUserData	Non
updateComments	bool	Non

Réponse

Renvoie : Option[PutSSOUserAPIResponse]

Exemple

Exemple de 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

createSubscription

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Non

Réponse

Renvoie : Option[CreateSubscriptionAPIResponse]

Exemple

Exemple de 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

deleteSubscription

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
userId	string	Non

Réponse

Renvoie : Option[DeleteSubscriptionAPIResponse]

Exemple

Exemple de 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"

getSubscriptions

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
userId	string	Non

Réponse

Retourne: Option[GetSubscriptionsAPIResponse]

Exemple

Exemple de getSubscriptions

Copy

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

updateSubscription

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Non
userId	string	Non

Réponse

Renvoie: Option[UpdateSubscriptionAPIResponse]

Exemple

Exemple de 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

getTenantDailyUsages

Paramètres

Nom	Type	Requis
tenantId	string	Oui
yearNumber	float64	Non
monthNumber	float64	Non
dayNumber	float64	Non
skip	float64	Non

Réponse

Renvoie : Option[GetTenantDailyUsagesResponse]

Exemple

Exemple de 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

createTenantPackage

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
createTenantPackageBody	CreateTenantPackageBody	Non

Réponse

Renvoie : Option[CreateTenantPackageResponse]

Exemple

Exemple de 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

deleteTenantPackage

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de 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"

getTenantPackage

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetTenantPackageResponse]

Exemple

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

getTenantPackages

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetTenantPackagesResponse]

Exemple

Exemple de 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'"

replaceTenantPackage

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
replaceTenantPackageBody	ReplaceTenantPackageBody	Non

Réponse

Exemple

Exemple de 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

updateTenantPackage

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
updateTenantPackageBody	UpdateTenantPackageBody	Non

Réponse

Exemple

Exemple d'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

createTenantUser

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantUserBody	CreateTenantUserBody	Non

Réponse

Retourne: Option[CreateTenantUserResponse]

Exemple

Exemple de 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

deleteTenantUser

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
deleteComments	string	Non
commentDeleteMode	string	Non

Réponse

Exemple

Exemple de 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

getTenantUser

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[GetTenantUserResponse]

Exemple

Exemple de 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

getTenantUsers

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Retourne : Option[GetTenantUsersResponse]

Exemple

Exemple de 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"

replaceTenantUser

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
replaceTenantUserBody	ReplaceTenantUserBody	Non
updateComments	string	Non

Réponse

Exemple

Exemple de 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

sendLoginLink

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
redirectURL	string	Non

Réponse

Exemple

Exemple de 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

updateTenantUser

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateTenantUserBody	UpdateTenantUserBody	Non
updateComments	string	Non

Réponse

Exemple

Exemple de 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

createTenant

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantBody	CreateTenantBody	Non

Réponse

Retourne: Option[CreateTenantResponse]

Exemple

Exemple de 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

deleteTenant

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
sure	string	Non

Réponse

Exemple

Exemple de deleteTenant

Copy

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

getTenant

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetTenantResponse]

Exemple

Exemple de 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

getTenants

Paramètres

Nom	Type	Requis
tenantId	string	Oui
meta	string	Non
skip	float64	Non

Réponse

Renvoie: Option[GetTenantsResponse]

Exemple

Exemple de 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

updateTenant

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateTenantBody	UpdateTenantBody	Non

Réponse