FastComments Nim SDK

Este é o SDK oficial em Nim para o FastComments.

SDK oficial em Nim para a API do FastComments

Repositório

Requisitos

Nim >= 1.6.0
nimcrypto >= 0.5.4

Instalação

Usando Nimble

nimble install fastcomments

Compilando a partir do código-fonte

nimble build

Conteúdo da Biblioteca

Esta biblioteca contém o cliente de API gerado e as utilidades SSO para facilitar o trabalho com a API.

Documentação da biblioteca do cliente da API

APIs Públicas vs APIs Seguras

Para o cliente de API, existem dois módulos de API, api_default e api_public. O api_default contém métodos que requerem sua chave de API, e o api_public contém chamadas de API que podem ser feitas diretamente de um navegador/dispositivo móvel/etc sem autenticação.

Início rápido

Usando APIs autenticadas (DefaultAPI)

Importante: Endpoints autenticados exigem que sua chave de API seja definida no cabeçalho x-api-key.

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

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

# Faça chamadas de API autenticadas
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  page = 0,
  limit = 0,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "your-url-id",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.DESC
)

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

Usando APIs públicas (PublicAPI)

Endpoints públicos não requerem autenticação:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Faça chamadas de API públicas
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  page = 0,
  direction = SortDirections.DESC,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 0,
  limitChildren = 0,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = false,
  countAll = false,
  includei10n = false,
  locale = "",
  modules = "",
  isCrawler = false,
  includeNotificationCount = false,
  asTree = false,
  maxTreeDepth = 0,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "",
  hashTags = @[],
  userId = "",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)

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

Problemas Comuns

401 authentication error: Certifique-se de definir o cabeçalho x-api-key no seu HttpClient antes de fazer solicitações do DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Use api_default para solicitações autenticadas do lado do servidor, api_public para solicitações do lado do cliente/públicas.

Fazendo chamadas de API

Todos os métodos da API neste SDK retornam tuplas de (Option[ResponseType], Response). O primeiro elemento contém a resposta analisada se for bem-sucedida, e o segundo elemento é a resposta HTTP bruta.

Exemplo: Recuperando Comentários

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

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

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  page = 0,
  limit = 0,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "your-url-id",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.DESC
)

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

Observações

IDs de Broadcast

Você verá que deve passar um broadcastId em algumas chamadas de API. Quando receber eventos, você receberá esse ID de volta, então saberá ignorar o evento se planeja aplicar alterações de forma otimista no cliente (o que você provavelmente vai querer fazer, já que oferece a melhor experiência). Passe um UUID aqui. O ID deve ser suficientemente único para não ocorrer duas vezes em uma sessão do navegador.

Para exemplos de SSO, veja abaixo.

Uso de SSO

SSO Simples

import fastcomments/sso

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

echo "SSO Token: ", token

SSO Seguro

import fastcomments/sso

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

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

echo "Secure SSO Token: ", token

Documentação do fastcomments

Documentação para fastcomments

Documentação para Endpoints da API

Todas as URIs são relativas a https://fastcomments.com

Classe	Método	requisição HTTP	Descrição
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Agrega documentos agrupando-os (se groupBy for fornecido) e aplicando múltiplas operações. Diferentes operações (por exemplo sum, countDistinct, avg, etc.) são suportadas.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsPublic	GET /comments/{tenantId}	requer tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	requer tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	requer tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	requer tenantId urlId userIdWS
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Habilita ou desabilita notificações para um comentário específico.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Habilita ou desabilita notificações para uma página. Quando usuários estão inscritos em uma página, notificações são criadas para novos comentários raiz, e também
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Faz upload e redimensiona uma imagem
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentação para Modelos

Documentação para Autorização

api_key

Tipo: Chave de API
Nome do parâmetro da chave de API: x-api-key
Localização: cabeçalho HTTP

Agregação

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
aggregationRequest	AggregationRequest	Não
parentTenantId	string	Não
includeStats	bool	Não

Resposta

Retorna: Option[AggregationResponse]

Exemplo

Exemplo de aggregate

Copy

let (response, httpResponse) = client.aggregate(
  tenantId = "my-tenant-123",
  aggregationRequest = AggregationRequest(),
  parentTenantId = "",
  includeStats = false
)
if response.isSome:
  let aggregation = response.get()
  echo $aggregation

Obter logs de auditoria

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
limit	float64	Não
skip	float64	Não
order	SORTDIR	Não
after	float64	Não
before	float64	Não

Resposta

Retorna: Option[GetAuditLogs_200_response]

Exemplo

Exemplo de getAuditLogs

Copy

let (response, httpResponse) = client.getAuditLogs(
  tenantId = "my-tenant-123",
  limit = 100.0,
  skip = 0.0,
  order = SORTDIR(0),
  after = 0.0,
  before = 0.0
)
if response.isSome:
  let audit = response.get()
  echo audit

Bloquear a partir de comentário público

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
publicBlockFromCommentParams	PublicBlockFromCommentParams	Não
sso	string	Não

Resposta

Retorna: Option[BlockFromCommentPublic_200_response]

Exemplo

Exemplo de blockFromCommentPublic

Copy

let (response, httpResponse) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = "sso-token-7a9b3c"
)
if response.isSome:
  let blockResult = response.get()
  discard blockResult

Desbloquear comentário público

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
publicBlockFromCommentParams	PublicBlockFromCommentParams	Não
sso	string	Não

Resposta

Retorna: Option[UnBlockCommentPublic_200_response]

Exemplo

Exemplo de unBlockCommentPublic

Copy

let (response, httpResponse) = client.unBlockCommentPublic(
  tenantId = "news-site-456",
  commentId = "comment-abc123",
  publicBlockFromCommentParams = PublicBlockFromCommentParams{},
  sso = ""
)
if response.isSome:
  let unblocked = response.get()
  discard unblocked
else:
  discard httpResponse

Verificar comentários bloqueados

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentIds	string	Não
sso	string	Não

Resposta

Retorna: Option[CheckedCommentsForBlocked_200_response]

Exemplo

Exemplo de checkedCommentsForBlocked

Copy

let (response, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "",
  sso = ""
)
if response.isSome:
  let checked = response.get()
  echo "Checked comments received for tenant my-tenant-123"
  echo checked
else:
  echo "No checked comments (HTTP status: ", $httpResponse.statusCode, ")"

Bloquear usuário a partir do comentário

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
blockFromCommentParams	BlockFromCommentParams	Não
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[BlockFromCommentPublic_200_response]

Exemplo

Exemplo de blockUserFromComment

Copy

let (response, httpResponse) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-98765",
  blockFromCommentParams = BlockFromCommentParams(),
  userId = "user-456",
  anonUserId = ""
)
if response.isSome:
  let blocked = response.get()
  echo "Block confirmed for tenant:", " my-tenant-123"

Criar comentário público

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlId	string	Sim
broadcastId	string	Não
commentData	CommentData	Não
sessionId	string	Não
sso	string	Não

Resposta

Retorna: Option[CreateCommentPublic_200_response]

Exemplo

Exemplo de createCommentPublic

Copy

let (response, httpResponse) = client.createCommentPublic(
  tenantId = "my-tenant-123",
  urlId = "news/breaking-elections-2025",
  broadcastId = "broadcast-456",
  commentData = CommentData(
    content = "Great reporting — thanks for the clear analysis!",
    authorName = "Jane Doe",
    authorEmail = "jane.doe@example.com",
    isVerified = false,
    tags = @["politics", "analysis"]
  ),
  sessionId = "session-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let created = response.get()
  echo "Created comment:", created
else:
  echo "No comment returned, HTTP status: ", httpResponse.status`

Excluir comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
contextUserId	string	Não
isLive	bool	Não

Resposta

Retorna: Option[DeleteComment_200_response]

Exemplo

Exemplo de deleteComment

Copy

let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "cmt-456abc", contextUserId = "user-789", isLive = true)
if response.isSome:
  let deleted = response.get()
  discard deleted
  echo "Delete succeeded"
else:
  echo "No delete response"

Excluir comentário público

Parâmetros

Name	Type	Required
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Não
editKey	string	Não
sso	string	Não

Resposta

Retorna: Option[DeleteCommentPublic_200_response]

Exemplo

Exemplo de deleteCommentPublic

Copy

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

Excluir voto de comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
voteId	string	Não
urlId	string	Sim
broadcastId	string	Não
editKey	string	Não
sso	string	Não

Resposta

Retorna: Option[DeleteCommentVote_200_response]

Exemplo

Exemplo de deleteCommentVote

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  voteId = "",
  urlId = "news/breaking-story-2025",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  discard deleted
  echo "Vote removed for comment cmt-789"
else:
  echo "No response body returned"

Denunciar comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[FlagComment_200_response]

Exemplo

Exemplo de flagComment

Copy

let (response, httpResponse) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-98765", userId = "user-8342", anonUserId = "")
if response.isSome:
  let flagged = response.get()
  echo "Flagged comment response: ", flagged
else:
  echo "Flag comment failed: ", httpResponse

Obter comentário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetComment_200_response]

Exemplo

Exemplo de getComment

Copy

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

Obter comentários

Parâmetros

Name	Tipo	Obrigatório
tenantId	string	Sim
page	int	Não
limit	int	Não
skip	int	Não
asTree	bool	Não
skipChildren	int	Não
limitChildren	int	Não
maxTreeDepth	int	Não
urlId	string	Sim
userId	string	Não
anonUserId	string	Não
contextUserId	string	Não
hashTag	string	Não
parentId	string	Não
direction	SortDirections	Não

Resposta

Retorna: Option[GetComments_200_response]

Exemplo

Exemplo de getComments

Copy

let (response, httpResponse) = client.getComments(
  tenantId = "my-tenant-123",
  page = 1,
  limit = 20,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "news/2025-election-night",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.Desc
)
if response.isSome:
  let comments = response.get()
  echo "Status: ", httpResponse.status, " Comments: ", comments

Obter comentários públicos

Parâmetros

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

Resposta

Retorna: Option[GetCommentsPublic_200_response]

Exemplo

Exemplo de getCommentsPublic

Copy

let (response, httpResponse) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/world/article-2025",
  page = 1,
  direction = SortDirections(0),
  sso = "sso_token_abc",
  skip = 0,
  skipChildren = 0,
  limit = 20,
  limitChildren = 5,
  countChildren = false,
  fetchPageForCommentId = "cmt_789",
  includeConfig = true,
  countAll = false,
  includei10n = true,
  locale = "en-US",
  modules = "reactions,moderation",
  isCrawler = false,
  includeNotificationCount = true,
  asTree = true,
  maxTreeDepth = 3,
  useFullTranslationIds = false,
  parentId = "parent_123",
  searchText = "openAI integration",
  hashTags = @["ai", "technology"],
  userId = "user_456",
  customConfigStr = "{}",
  afterCommentId = "cmt_100",
  beforeCommentId = ""
)
if response.isSome:
  let comments = response.get()
  discard comments
else:
  discard httpResponse

Obter texto do comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
editKey	string	Não
sso	string	Não

Resposta

Retorna: Option[GetCommentText_200_response]

Exemplo

Exemplo de getCommentText

Copy

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

Obter nomes de usuários que votaram em comentário

Parâmetros

Name	Type	Required
tenantId	string	Sim
commentId	string	Sim
dir	int	Não
sso	string	Não

Resposta

Retorna: Option[GetCommentVoteUserNames_200_response]

Exemplo

Exemplo de getCommentVoteUserNames

Copy

let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "c_987654321", dir = 0, sso = "")
if response.isSome:
  let res = response.get()
  for userName in res.userNames:
    echo userName

Bloquear comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[LockComment_200_response]

Exemplo

Exemplo de lockComment

Copy

let (response, httpResponse) = client.lockComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-98765",
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let lockResp = response.get()
  discard lockResp

Fixar comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[PinComment_200_response]

Exemplo

Exemplo de pinComment

Copy

let (response, httpResponse) = client.pinComment(tenantId = "my-tenant-123", commentId = "cmt-98765", broadcastId = "", sso = "")
if response.isSome:
  let pinned = response.get()
  echo "Pinned comment response received"
else:
  echo "No pin response"

Salvar comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createCommentParams	CreateCommentParams	Não
isLive	bool	Não
doSpamCheck	bool	Não
sendEmails	bool	Não
populateNotifications	bool	Não

Resposta

Retorna: Option[SaveComment_200_response]

Exemplo

Exemplo de saveComment

Copy

let (response, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = CreateCommentParams(
    content = "This article was really helpful, thanks!",
    urlId = "news/2025-11/ai-regulations",
    authorName = "Jane Doe",
    authorEmail = "jane.doe@example.com",
    tags = @["policy", "analysis"]
  ),
  isLive = true,
  doSpamCheck = true,
  sendEmails = true,
  populateNotifications = false
)
if response.isSome:
  let saved = response.get()
  discard saved

Salvar comentários em massa

Parâmetros

Name	Type	Required
tenantId	string	Sim
createCommentParams	seq[CreateCommentParams]	Não
isLive	bool	Não
doSpamCheck	bool	Não
sendEmails	bool	Não
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	Não
id	string	Não
unBlockFromCommentParams	UnBlockFromCommentParams	Não
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[UnBlockCommentPublic_200_response]

Exemplo

Exemplo de saveCommentsBulk

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  isLive = true,
  doSpamCheck = true,
  sendEmails = false,
  populateNotifications = true,
  id = "batch-20251122",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-456",
  anonUserId = "anon-789"
)
if response.isSome:
  let unblocked = response.get()
  echo "Unblocked response received: ", unblocked
else:
  echo "No unblocked response, httpResponse: ", $httpResponse

Definir texto do comentário

Parâmetros

Name	Type	Required
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Não
commentTextUpdateRequest	CommentTextUpdateRequest	Não
editKey	string	Não
sso	string	Não

Resposta

Retorna: Option[SetCommentText_200_response]

Exemplo

Exemplo de setCommentText

Copy

let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  broadcastId = "broadcast-456",
  commentTextUpdateRequest = CommentTextUpdateRequest(text = "Updated comment text to fix typos and add clarity."),
  editKey = "edit-key-abc123",
  sso = "sso-token-xyz"
)
if response.isSome:
  let updated = response.get()

Desbloquear usuário a partir do comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
unBlockFromCommentParams	UnBlockFromCommentParams	Não
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[UnBlockCommentPublic_200_response]

Exemplo

Exemplo de unBlockUserFromComment

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "news-site-001",
  id = "cmt-8fj3k9",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-98765",
  anonUserId = ""
)
if response.isSome:
  let unblocked = response.get()
  discard unblocked

Remover denúncia do comentário

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[FlagComment_200_response]

Exemplo

Exemplo de unFlagComment

Copy

let (response, httpResponse) = client.unFlagComment(
  tenantId = "my-tenant-123",
  id = "flag-789",
  userId = "",
  anonUserId = ""
)
if response.isSome:
  let flagResponse = response.get()
  echo "Comment unflagged successfully"

Desbloquear comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[LockComment_200_response]

Exemplo

Exemplo de unLockComment

Copy

let (response, httpResponse) = client.unLockComment(tenantId = "my-tenant-123", commentId = "cmt-7f9a3b2d", broadcastId = "", sso = "")
if response.isSome:
  let lockResult = response.get()
  echo "Unlock response: ", $lockResult
else:
  echo "Unlock failed, HTTP response: ", $httpResponse

Desfixar comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[PinComment_200_response]

Exemplo

Exemplo de unPinComment

Copy

let (response, httpResponse) = client.unPinComment(tenantId = "my-tenant-123", commentId = "cmt-9f8b7a6", broadcastId = "", sso = "")
if response.isSome:
  let pinResp = response.get()
  echo "Unpinned comment successfully"
else:
  echo "Failed to unpin comment; HTTP response: ", httpResponse

Atualizar comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updatableCommentParams	UpdatableCommentParams	Não
contextUserId	string	Não
doSpamCheck	bool	Não
isLive	bool	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateComment

Copy

let updatableCommentParams = UpdatableCommentParams(content: "Fixed a typo in the second paragraph", tags: @["article-edit", "typo"], isApproved: true)
let (response, httpResponse) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = updatableCommentParams,
  contextUserId = "user-789",
  doSpamCheck = true,
  isLive = true
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

Votar em comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
urlId	string	Sim
broadcastId	string	Não
voteBodyParams	VoteBodyParams	Não
sessionId	string	Não
sso	string	Não

Resposta

Retorna: Option[VoteComment_200_response]

Exemplo

Exemplo de voteComment

Copy

let voteBody = VoteBodyParams()
let (response, httpResponse) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  urlId = "news/2025/fastcomments-integration",
  broadcastId = "",
  voteBodyParams = voteBody,
  sessionId = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  echo "Vote recorded for comment cmt-456789"
else:
  echo "Failed to record vote"

Adicionar configuração de domínio

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
addDomainConfigParams	AddDomainConfigParams	Não

Resposta

Retorna: Option[AddDomainConfig_200_response]

Exemplo

Exemplo de addDomainConfig

Copy

let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = AddDomainConfigParams())
if response.isSome:
  let domainConfig = response.get()
  discard domainConfig
else:
  discard httpResponse

Excluir configuração de domínio

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
domain	string	Não

Resposta

Retorna: Option[DeleteDomainConfig_200_response]

Exemplo

Exemplo de deleteDomainConfig

Copy

let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let result = response.get()
  echo "Deleted domain config result: ", result
else:
  echo "No response body, HTTP status: ", $httpResponse.status

Obter configuração de domínio

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
domain	string	Não

Resposta

Retorna: Option[GetDomainConfig_200_response]

Exemplo

Exemplo de getDomainConfig

Copy

let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let domainConfig = response.get()
  echo "Loaded domain config for tenant my-tenant-123:", $domainConfig
else:
  echo "No domain config; HTTP status:", $httpResponse.status

Obter configurações de domínio

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim

Resposta

Retorna: Option[GetDomainConfigs_200_response]

Exemplo

Exemplo de getDomainConfigs

Copy

let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if response.isSome:
  let domainConfigs = response.get()
  echo "Domain configs received:"
  echo domainConfigs
else:
  echo "Failed to retrieve domain configs."
  echo httpResponse

Alterar configuração de domínio

Parâmetros

Name	Type	Required
tenantId	string	Sim
domainToUpdate	string	Não
patchDomainConfigParams	PatchDomainConfigParams	Não

Resposta

Retorna: Option[GetDomainConfig_200_response]

Exemplo

Exemplo de patchDomainConfig

Copy

let (response, httpResponse) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/article-crowdsourcing",
  patchDomainConfigParams = PatchDomainConfigParams(
    allowedOrigins = @["https://www.news-site.com"],
    moderated = true,
    maxCommentLength = 1000
  )
)
if response.isSome:
  let domainConfig = response.get()
  echo "Updated domain config received"
else:
  echo "No domain config returned"

Substituir configuração de domínio

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
domainToUpdate	string	Não
updateDomainConfigParams	UpdateDomainConfigParams	Não

Resposta

Retorna: Option[GetDomainConfig_200_response]

Exemplo

Exemplo de putDomainConfig

Copy

let updateParams = UpdateDomainConfigParams(
  allowAnonymous = false,
  moderationEnabled = true,
  allowedOrigins = @["https://news.example.com"],
  maxCommentLength = 2000
)
let (response, httpResponse) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/example-article",
  updateDomainConfigParams = updateParams
)
if response.isSome:
  let domainCfg = response.get()
  discard domainCfg

Criar modelo de e-mail

Parâmetros

Name	Type	Obrigatório	Description
tenantId	string	Sim
createEmailTemplateBody	CreateEmailTemplateBody	Não

Resposta

Retorna: Option[CreateEmailTemplate_200_response]

Exemplo

Exemplo de createEmailTemplate

Copy

let (response, httpResponse) = client.createEmailTemplate(tenantId = "my-tenant-123", createEmailTemplateBody = CreateEmailTemplateBody(name = "Weekly Newsletter", subject = "Weekly updates from OurSite", fromName = "OurSite Team", fromEmail = "newsletter@oursite.com", bodyHtml = "<h1>Highlights</h1><p>Top stories this week...</p>", enabled = true, tags = @["newsletter", "weekly"]))
if response.isSome:
  let template = response.get()
  discard template

Excluir modelo de e-mail

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteEmailTemplate

Copy

let (response, httpResponse) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "tmpl-456")
if response.isSome:
  let deleted = response.get()
  echo deleted

Excluir erro de renderização do modelo de e-mail

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
errorId	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteEmailTemplateRenderError

Copy

let (response, httpResponse) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email-template",
  errorId = "render-error-2026"
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

Obter modelo de e-mail

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetEmailTemplate_200_response]

Exemplo

Exemplo de getEmailTemplate

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email-01")
if response.isSome:
  let template = response.get()
  echo "Template ID: ", template.id
  echo "Subject: ", template.subject
  echo "Body: ", template.body

Obter definições de modelos de e-mail

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim

Resposta

Retorna: Option[GetEmailTemplateDefinitions_200_response]

Exemplo

Exemplo de getEmailTemplateDefinitions

Copy

let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if response.isSome:
  let defs = response.get()
  echo "Received email template definitions for tenant my-tenant-123"
else:
  echo "No template definitions returned; HTTP status: ", httpResponse.status

Obter erros de renderização de modelo de e-mail

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
skip	float64	Não

Resposta

Retorna: Option[GetEmailTemplateRenderErrors_200_response]

Exemplo

Exemplo de getEmailTemplateRenderErrors

Copy

let (response, httpResponse) = client.getEmailTemplateRenderErrors(tenantId = "my-tenant-123", id = "welcome-email-template-001", skip = 0.0)
if response.isSome:
  let result = response.get()
  echo "Render errors:", result
else:
  echo "No render errors or request failed. HTTP status:", httpResponse.status

Obter modelos de e-mail

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	float64	Não

Resposta

Retorna: Option[GetEmailTemplates_200_response]

Exemplo

Exemplo 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 templates returned"

Renderizar modelo de e-mail

Parâmetros

Name	Type	Required
tenantId	string	Sim
renderEmailTemplateBody	RenderEmailTemplateBody	Não
locale	string	Não

Resposta

Retorna: Option[RenderEmailTemplate_200_response]

Exemplo

Exemplo de renderEmailTemplate

Copy

let renderBody = RenderEmailTemplateBody(templateId: "comment-notification", subject: "New comment on your article", variables: @["John Doe", "news/global-climate"])
let (response, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = renderBody, locale = "en-US")
if response.isSome:
  let rendered = response.get()
  echo rendered

Atualizar modelo de e-mail

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateEmailTemplateBody	UpdateEmailTemplateBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateEmailTemplate

Copy

let updateBody = UpdateEmailTemplateBody(
  name = "Welcome Email",
  subject = "Welcome to Example News",
  html = "<p>Hi {name}, welcome to Example News.</p>",
  isActive = true,
  tags = @["onboarding", "welcome"]
)
let (response, httpResponse) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-template-2026",
  updateEmailTemplateBody = updateBody
)
if response.isSome:
  let template = response.get()
  discard template

Obter registro de eventos

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Não
startTime	int64	Não
endTime	int64	Não

Resposta

Retorna: Option[GetEventLog_200_response]

Exemplo

Exemplo de getEventLog

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64
)
if response.isSome:
  let eventLog = response.get()
  echo "Received event log for ", "my-tenant-123"
else:
  echo "No event log returned. HTTP status: ", $httpResponse.status

Obter registro de eventos global

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Não
startTime	int64	Não
endTime	int64	Não

Resposta

Retorna: Option[GetEventLog_200_response]

Exemplo

Exemplo de getGlobalEventLog

Copy

let (response, httpResponse) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = int64(0),
  endTime = int64(0)
)
if response.isSome:
  let eventLog = response.get()
  echo eventLog
else:
  echo "No event log returned"

Criar publicação do feed

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createFeedPostParams	CreateFeedPostParams	Não
broadcastId	string	Não
isLive	bool	Não
doSpamCheck	bool	Não
skipDupCheck	bool	Não

Resposta

Retorna: Option[CreateFeedPost_200_response]

Exemplo

Exemplo de createFeedPost

Copy

let createParams = CreateFeedPostParams(
  content = "We're rolling out realtime comments to all users!",
  title = "Realtime Comments Rollout",
  url = "news/realtime-comments-rollout-2025",
  authorId = "prod-team",
  tags = @["release", "comments"]
)
let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = createParams,
  broadcastId = "broadcast-2025-11",
  isLive = true,
  doSpamCheck = true,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  echo "Feed post created, id: ", $created.id
else:
  echo "Failed to create feed post, HTTP status: ", $httpResponse.statusCode

Criar publicação do feed pública

Parâmetros

Name	Type	Required
tenantId	string	Sim
createFeedPostParams	CreateFeedPostParams	Não
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[CreateFeedPostPublic_200_response]

Exemplo

Exemplo de createFeedPostPublic

Copy

let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(
    title = "Product Launch Announcement",
    content = "We just launched a new commenting feature to improve engagement.",
    authorId = "team-product",
    url = "news/product-launch",
    tags = @["launch", "comments"],
    isFeatured = false
  ),
  broadcastId = "broadcast-009",
  sso = ""
)
if response.isSome:
  let created = response.get()
  discard created

Excluir publicação do feed pública

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Não
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[DeleteFeedPostPublic_200_response]

Exemplo

Exemplo de deleteFeedPostPublic

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  broadcastId = "broadcast-789",
  sso = ""
)
if response.isSome:
  let result = response.get()

Obter publicações do feed

Parâmetros

Name	Type	Required
tenantId	string	Sim
afterId	string	Não
limit	int	Não
tags	seq[string]	Não

Resposta

Retorna: Option[GetFeedPosts_200_response]

Exemplo

Exemplo de getFeedPosts

Copy

let (response, httpResponse) = client.getFeedPosts(tenantId = "my-tenant-123", afterId = "post_abc123", limit = 20, tags = @["news", "sports"])
if response.isSome:
  let feed = response.get()
  echo "Feed posts retrieved for tenant my-tenant-123"
else:
  echo "No feed posts returned, HTTP status: ", $httpResponse.status

Obter publicações do feed públicas

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
afterId	string	Não
limit	int	Não
tags	seq[string]	Não
sso	string	Não
isCrawler	bool	Não
includeUserInfo	bool	Não

Resposta

Retorna: Option[GetFeedPostsPublic_200_response]

Exemplo

Exemplo 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()
  echo feed

Obter estatísticas de publicações do feed

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postIds	seq[string]	Não
sso	string	Não

Resposta

Retorna: Option[GetFeedPostsStats_200_response]

Exemplo

Exemplo de getFeedPostsStats

Copy

let (response, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["news/article-2025-11-22", "opinion/market-trends-452"],
  sso = ""
)
if response.isSome:
  let stats = response.get()
  discard stats

Obter reações de usuário públicas

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postIds	seq[string]	Não
sso	string	Não

Resposta

Retorna: Option[GetUserReactsPublic_200_response]

Exemplo

Exemplo de getUserReactsPublic

Copy

let (response, httpResponse) = client.getUserReactsPublic(tenantId = "my-tenant-123", postIds = @[], sso = "")
if response.isSome:
  let reacts = response.get()
  discard reacts

Reagir à publicação do feed pública

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Não
reactBodyParams	ReactBodyParams	Não
isUndo	bool	Não
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[ReactFeedPostPublic_200_response]

Exemplo

Exemplo reactFeedPostPublic

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-title",
  reactBodyParams = ReactBodyParams(),
  isUndo = false,
  broadcastId = "broadcast-456",
  sso = ""
)
if response.isSome:
  let result = response.get()
  echo "Reaction result: ", result
else:
  echo "Reaction failed, HTTP response: ", httpResponse

Atualizar publicação do feed

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
feedPost	FeedPost	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateFeedPost

Copy

let feedPost = FeedPost(
  title: "Local Election Results",
  content: "Updated vote counts across precincts",
  tags: @["politics", "local"],
  authorId: "journalist-32",
  isPublished: true,
  views: 124
)
let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

Atualizar publicação do feed pública

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Não
updateFeedPostParams	UpdateFeedPostParams	Não
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: Option[CreateFeedPostPublic_200_response]

Exemplo

Exemplo de updateFeedPostPublic

Copy

var updateParams: UpdateFeedPostParams = UpdateFeedPostParams(
  title = "Breaking: Service Update",
  content = "We improved feed performance and UX for all users.",
  tags = @["performance", "release"],
  isPublic = true
)
let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  updateFeedPostParams = updateParams,
  broadcastId = "broadcast-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let post = response.get()
  echo "Updated post title: ", post.title
  echo "HTTP status: ", httpResponse.status

Denunciar comentário público

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
isFlagged	bool	Não
sso	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de flagCommentPublic

Copy

let (response, httpResponse) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  isFlagged = false,
  sso = ""
)
if response.isSome:
  let flagResult = response.get()
  discard flagResult

Adicionar hashtag

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createHashTagBody	CreateHashTagBody	Não

Resposta

Retorna: Option[AddHashTag_200_response]

Exemplo

Exemplo de addHashTag

Copy

let createBody = CreateHashTagBody(
  name = "sports",
  description = "Articles and discussions about sports",
  aliases = @["sport", "athletics"],
  isActive = true
)
let (response, httpResponse) = client.addHashTag(tenantId = "my-tenant-123", createHashTagBody = createBody)
if response.isSome:
  let added = response.get()
  echo "HashTag added successfully"
else:
  echo "Failed to add HashTag"

Adicionar hashtags em massa

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Não

Resposta

Retorna: Option[AddHashTagsBulk_200_response]

Exemplo

Exemplo de addHashTagsBulk

Copy

let bulkBody = BulkCreateHashTagsBody(
  tags = @["breaking", "world-news", "economy"],
  createdBy = "editor@dailynews.com",
  replaceExisting = false
)
let (response, httpResponse) = client.addHashTagsBulk(tenantId = "newsroom-tenant-42", bulkCreateHashTagsBody = bulkBody)
if response.isSome:
  let created = response.get()
  echo created
else:
  echo "AddHashTagsBulk failed:", httpResponse

Excluir hashtag

Parâmetros

Nome	Tipo	Obrigatório
tag	string	Não
tenantId	string	Sim
deleteHashTagRequest	DeleteHashTagRequest	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteHashTag

Copy

let (response, httpResponse) = client.deleteHashTag(tag = "breaking-news", tenantId = "my-tenant-123", deleteHashTagRequest = DeleteHashTagRequest())
if response.isSome:
  let result = response.get()
  discard result

Obter hashtags

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
page	float64	Não

Response

Retorna: Option[GetHashTags_200_response]

Exemplo

Exemplo de getHashTags

Copy

let (response, httpResponse) = client.getHashTags(tenantId = "my-tenant-123", page = 1.0)
if response.isSome:
  let tags = response.get()
  for t in tags:
    echo t
else:
  echo "no hashtags found"

Alterar hashtag

Parâmetros

Nome	Tipo	Obrigatório
tag	string	Não
tenantId	string	Sim
updateHashTagBody	UpdateHashTagBody	Não

Resposta

Retorna: Option[PatchHashTag_200_response]

Exemplo

Exemplo de patchHashTag

Copy

let (response, httpResponse) = client.patchHashTag(tag = "politics", tenantId = "my-tenant-123", updateHashTagBody = UpdateHashTagBody())
if response.isSome:
  let updated = response.get()
  echo "Hashtag updated successfully"
else:
  echo "Failed to update hashtag, status:", httpResponse.status

Criar moderador

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createModeratorBody	CreateModeratorBody	Não

Resposta

Retorna: Option[CreateModerator_200_response]

Exemplo

Exemplo de createModerator

Copy

let createBody = CreateModeratorBody(
  email = "moderator@news-site.com",
  displayName = "News Moderator",
  permissions = @["approve_comments", "delete_comments"],
  isSuperAdmin = false
)
let (response, httpResponse) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = createBody)
if response.isSome:
  let moderator = response.get()
  echo "Created moderator: ", $moderator

Excluir moderador

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
sendEmail	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteModerator

Copy

let (response, httpResponse) = client.deleteModerator(tenantId = "my-tenant-123", id = "moderator-456", sendEmail = "false")
if response.isSome:
  let flagResp = response.get()
  echo "Moderator deletion response: ", $flagResp
else:
  echo "No response body; HTTP status: ", $httpResponse.status

Obter moderador

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetModerator_200_response]

Exemplo

Exemplo de getModerator

Copy

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

Obter moderadores

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
skip	float64	Não

Resposta

Retorna: Option[GetModerators_200_response]

Exemplo

Exemplo de getModerators

Copy

let (response, httpResponse) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let moderators = response.get()
  echo "Moderators fetched successfully"
  echo moderators

Atualizar moderador

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateModeratorBody	UpdateModeratorBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateModerator

Copy

let updateBody = UpdateModeratorBody(
  name: "Alicia Gomez",
  email: "alicia.gomez@dailynews.com",
  active: true,
  roles: @["moderator"]
)
let (response, httpResponse) = client.updateModerator(tenantId = "my-tenant-123", id = "moderator-789", updateModeratorBody = updateBody)
if response.isSome:
  let updated = response.get()
  echo "Moderator updated:", updated

Excluir contagem de notificações

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteNotificationCount

Copy

let (response, httpResponse) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if response.isSome:
  let deleted = response.get()
  echo "Deleted notification count:", deleted
else:
  echo "No response body; HTTP response:", httpResponse

Obter contagem de notificações em cache

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetCachedNotificationCount_200_response]

Exemplo

Exemplo de getCachedNotificationCount

Copy

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

Obter contagem de notificações

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
urlId	string	Sim
fromCommentId	string	Não
viewed	bool	Não

Resposta

Retorna: Option[GetNotificationCount_200_response]

Exemplo

Exemplo de getNotificationCount

Copy

let (response, httpResponse) = client.getNotificationCount(
  tenantId = "acme-corp-tenant-12",
  userId = "user-84",
  urlId = "news/2026/market-update",
  fromCommentId = "cmt-20251234",
  viewed = false
)
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data"
else:
  echo "No notification data"

Obter notificações

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
urlId	string	Sim
fromCommentId	string	Não
viewed	bool	Não
skip	float64	Não

Resposta

Retorna: Option[GetNotifications_200_response]

Exemplo

Exemplo de getNotifications

Copy

let (response, httpResponse) = client.getNotifications(
  tenantId = "fastcomments-tenant-42",
  userId = "",
  urlId = "news/latest-tech-innovations",
  fromCommentId = "",
  viewed = false,
  skip = 0.0
)
if response.isSome:
  let notifications = response.get()
  echo "Received notifications: ", notifications
else:
  echo "No notifications, response: ", httpResponse

Atualizar notificação

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateNotificationBody	UpdateNotificationBody	Não
userId	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateNotification

Copy

let (response, httpResponse) = client.updateNotification(tenantId = "my-tenant-123",
  id = "notif-456",
  updateNotificationBody = UpdateNotificationBody(),
  userId = "user-789")
if response.isSome:
  let updated = response.get()
  echo "Updated notification id: ", $updated

Adicionar página

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createAPIPageData	CreateAPIPageData	Não

Resposta

Retorna: Option[AddPageAPIResponse]

Exemplo

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

Excluir página

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[DeletePageAPIResponse]

Exemplo

Exemplo 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

Obter página por URL/ID

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
urlId	string	Sim

Resposta

Retorna: Option[GetPageByURLIdAPIResponse]

Exemplo

Exemplo 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

Obter páginas

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim

Resposta

Retorna: Option[GetPagesAPIResponse]

Exemplo

Exemplo 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

Alterar página

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateAPIPageData	UpdateAPIPageData	Não

Resposta

Retorna: Option[PatchPageAPIResponse]

Exemplo

Exemplo 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

Excluir evento de webhook pendente

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deletePendingWebhookEvent

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "wh_evt_6f1e3b2a")
if response.isSome:
  let flagResp = response.get()
  discard flagResp

Obter contagem de eventos de webhook pendentes

Parâmetros

Name	Type	Required
tenantId	string	Sim
commentId	string	Sim
externalId	string	Não
eventType	string	Não
domain	string	Não
attemptCountGT	float64	Não

Resposta

Retorna: Option[GetPendingWebhookEventCount_200_response]

Exemplo

Exemplo de getPendingWebhookEventCount

Copy

let (response, httpResponse) = client.getPendingWebhookEventCount(
  tenantId = "my-tenant-123",
  commentId = "cmt-4567",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0
)
if response.isSome:
  let pending = response.get()
  echo "Received pending webhook event count response: ", $pending
else:
  echo "No pending webhook event count returned, HTTP response: ", $httpResponse

Obter eventos de webhook pendentes

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
externalId	string	Não
eventType	string	Não
domain	string	Não
attemptCountGT	float64	Não
skip	float64	Não

Resposta

Retorna: Option[GetPendingWebhookEvents_200_response]

Exemplo

Exemplo de getPendingWebhookEvents

Copy

let (response, httpResponse) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0,
  skip = 0.0
)
if response.isSome:
  let pending = response.get()
  discard pending
  echo "Received pending webhook events"
else:
  echo "No pending webhook events"

Criar configuração de pergunta

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createQuestionConfigBody	CreateQuestionConfigBody	Não

Resposta

Retorna: Option[CreateQuestionConfig_200_response]

Exemplo

Exemplo de createQuestionConfig

Copy

let body = CreateQuestionConfigBody(
  key = "recommendation",
  question = "Would you recommend this article to a friend?",
  required = false,
  inputType = "radio",
  options = @["Yes", "No", "Maybe"]
)
let (response, httpResponse) = client.createQuestionConfig(tenantId = "my-tenant-123", createQuestionConfigBody = body)
if response.isSome:
  let config = response.get()
  discard config

Excluir configuração de pergunta

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo deleteQuestionConfig

Copy

let (response, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-456")
if response.isSome:
  let respVal = response.get()
  echo "Delete succeeded for tenant my-tenant-123"
else:
  echo "Delete returned no data (status: ", $httpResponse.status, ")"

Obter configuração de pergunta

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetQuestionConfig_200_response]

Exemplo

Exemplo de getQuestionConfig

Copy

let (response, httpResponse) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-98765")
if response.isSome:
  let config = response.get()
  echo "Received question config for tenant:", " my-tenant-123"

Obter configurações de perguntas

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	float64	Não

Resposta

Retorna: Option[GetQuestionConfigs_200_response]

Exemplo

Exemplo de getQuestionConfigs

Copy

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

Atualizar configuração de pergunta

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
updateQuestionConfigBody	UpdateQuestionConfigBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateQuestionConfig

Copy

let (response, httpResponse) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "q-config-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if response.isSome:
  let updated = response.get()
  discard updated
  echo "Question config updated"
else:
  echo "Update did not return a result"

Criar resultado de pergunta

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createQuestionResultBody	CreateQuestionResultBody	Não

Resposta

Retorna: Option[CreateQuestionResult_200_response]

Exemplo

Exemplo de createQuestionResult

Copy

let (response, httpResponse) = client.createQuestionResult(tenantId = "my-tenant-123",
  createQuestionResultBody = CreateQuestionResultBody(questionId: "q-456",
    userId: "user-789",
    correct: true,
    score: 9,
    answers: @["B", "D"]))
if response.isSome:
  let result = response.get()
  echo result

Excluir resultado de pergunta

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteQuestionResult

Copy

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

Obter resultado de pergunta

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetQuestionResult_200_response]

Exemplo

Exemplo de getQuestionResult

Copy

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

Obter resultados de perguntas

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlId	string	Sim
userId	string	Não
startDate	string	Não
questionId	string	Não
questionIds	string	Não
skip	float64	Não

Resposta

Retorna: Option[GetQuestionResults_200_response]

Exemplo

Exemplo de getQuestionResults

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userId = "user-9876",
  startDate = "2024-01-01T00:00:00Z",
  questionId = "q-user-satisfaction",
  questionIds = "q-user-satisfaction,q-engagement",
  skip = 0.0
)
if response.isSome:
  let results = response.get()
  echo "Got question results: ", $results
else:
  echo "No results, HTTP status: ", httpResponse.status

Atualizar resultado de pergunta

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateQuestionResultBody	UpdateQuestionResultBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateQuestionResult

Copy

let (response, httpResponse) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody(
    result = "approved",
    reviewerId = "moderator-42",
    notes = "Valid question, no action required",
    isSpam = false
  )
)
if response.isSome:
  let flagResponse = response.get()
  discard flagResponse

Agregação de resultados de perguntas

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
questionId	string	Não
questionIds	seq[string]	Não
urlId	string	Sim
timeBucket	AggregateTimeBucket	Não
startDate	string	Não
forceRecalculate	bool	Não

Resposta

Retorna: Option[AggregateQuestionResults_200_response]

Exemplo

Exemplo de aggregateQuestionResults

Copy

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

Agregação em massa de resultados de perguntas

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Não
forceRecalculate	bool	Não

Resposta

Retorna: Option[BulkAggregateQuestionResults_200_response]

Exemplo

bulkAggregateQuestionResults Exemplo

Copy

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

Combinar comentários com resultados de perguntas

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
questionId	string	Não
questionIds	seq[string]	Não
urlId	string	Sim
startDate	string	Não
forceRecalculate	bool	Não
minValue	float64	Não
maxValue	float64	Não
limit	float64	Não

Resposta

Retorna: Option[CombineCommentsWithQuestionResults_200_response]

Exemplo

Exemplo de combineCommentsWithQuestionResults

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "q-9876",
  questionIds = @["q-9876", "q-9877"],
  urlId = "news/article-title",
  startDate = "2025-01-01T00:00:00Z",
  forceRecalculate = false,
  minValue = 1.0,
  maxValue = 5.0,
  limit = 100.0
)
if response.isSome:
  let combined = response.get()
  discard combined

Adicionar usuário SSO

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createAPISSOUserData	CreateAPISSOUserData	Não

Resposta

Retorna: Option[AddSSOUserAPIResponse]

Exemplo

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

Excluir usuário SSO

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
deleteComments	bool	Não
commentDeleteMode	string	Não

Resposta

Retorna: Option[DeleteSSOUserAPIResponse]

Exemplo

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

Obter usuário SSO por e-mail

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
email	string	Não

Resposta

Retorna: Option[GetSSOUserByEmailAPIResponse]

Exemplo

Exemplo 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

Obter usuário SSO por ID

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetSSOUserByIdAPIResponse]

Exemplo

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

Obter usuários SSO

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	int	Não

Resposta

Retorna: Option[GetSSOUsers_200_response]

Exemplo

Exemplo de getSSOUsers

Copy

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

Alterar usuário SSO

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateAPISSOUserData	UpdateAPISSOUserData	Não
updateComments	bool	Não

Resposta

Retorna: Option[PatchSSOUserAPIResponse]

Exemplo

Exemplo 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

Substituir usuário SSO

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateAPISSOUserData	UpdateAPISSOUserData	Não
updateComments	bool	Não

Resposta

Retorna: Option[PutSSOUserAPIResponse]

Exemplo

Exemplo 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

Criar assinatura

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Não

Resposta

Retorna: Option[CreateSubscriptionAPIResponse]

Exemplo

Exemplo 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

Excluir assinatura

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
userId	string	Não

Resposta

Retorna: Option[DeleteSubscriptionAPIResponse]

Exemplo

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

Obter assinaturas

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
userId	string	Não

Resposta

Retorna: Option[GetSubscriptionsAPIResponse]

Exemplo

Exemplo de getSubscriptions

Copy

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

Obter usos diários do locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
yearNumber	float64	Não
monthNumber	float64	Não
dayNumber	float64	Não
skip	float64	Não

Resposta

Retorna: Option[GetTenantDailyUsages_200_response]

Exemplo

Exemplo de getTenantDailyUsages

Copy

let (response, httpResponse) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  yearNumber = 2025.0,
  monthNumber = 6.0,
  dayNumber = 15.0,
  skip = 0.0
)
if response.isSome:
  let usages = response.get()
  echo usages
else:
  echo "No daily usages returned"

Criar pacote do locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createTenantPackageBody	CreateTenantPackageBody	Não

Resposta

Retorna: Option[CreateTenantPackage_200_response]

Exemplo

Exemplo de createTenantPackage

Copy

let packageBody = CreateTenantPackageBody(
  packageName = "premium-comments",
  description = "Premium moderation package for news site",
  planId = "plan-pro-2024",
  seats = 100,
  enabled = true,
  features = @["moderation", "analytics", "sentiment"]
)
let (response, httpResponse) = client.createTenantPackage(tenantId = "my-tenant-123", createTenantPackageBody = packageBody)
if response.isSome:
  let pkg = response.get()
  echo "Created package ID: ", pkg.packageId
  echo "Package name: ", pkg.packageName
else:
  echo "Failed to create package, HTTP status: ", httpResponse.status.code

Excluir pacote do locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteTenantPackage

Copy

let (response, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-789")
if response.isSome:
  let deleted = response.get()
  echo "Successfully deleted tenant package"

Obter pacote do locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetTenantPackage_200_response]

Exemplo

Exemplo de getTenantPackage

Copy

let (response, httpResponse) = client.getTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium-001")
if response.isSome:
  let pkg = response.get()
  echo pkg
else:
  echo "No package found for tenant"

Obter pacotes do locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	float64	Não

Resposta

Retorna: Option[GetTenantPackages_200_response]

Exemplo

Exemplo de getTenantPackages

Copy

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

Substituir pacote do locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
replaceTenantPackageBody	ReplaceTenantPackageBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de replaceTenantPackage

Copy

let replaceBody = ReplaceTenantPackageBody(
  packageName = "Community Pro",
  seats = 500,
  enableModeration = true,
  features = @["moderation", "analytics", "single-sign-on"]
)
let (response, httpResponse) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "community-pro",
  replaceTenantPackageBody = replaceBody
)
if response.isSome:
  let flagResp = response.get()
  echo "Package replaced for tenant: ", "my-tenant-123"
  discard flagResp

Atualizar pacote do locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateTenantPackageBody	UpdateTenantPackageBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateTenantPackage

Copy

let (response, httpResponse) = client.updateTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium", updateTenantPackageBody = UpdateTenantPackageBody())
if response.isSome:
  let updated = response.get()
  echo "Updated package received:", updated
else:
  echo "Update failed, HTTP status: ", httpResponse.status

Criar usuário do locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createTenantUserBody	CreateTenantUserBody	Não

Resposta

Retorna: Option[CreateTenantUser_200_response]

Exemplo

Exemplo de createTenantUser

Copy

let createBody = CreateTenantUserBody(
  email = "jane.doe@acmepub.com",
  displayName = "Jane Doe",
  password = "S3cur3P@ssw0rd",
  roles = @["moderator", "editor"],
  disabled = false
)
let (response, httpResponse) = client.createTenantUser(tenantId = "my-tenant-123", createTenantUserBody = createBody)
if response.isSome:
  let createdUser = response.get()
  echo createdUser

Excluir usuário do locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
deleteComments	string	Não
commentDeleteMode	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteTenantUser

Copy

let (response, httpResponse) = client.deleteTenantUser(tenantId = "my-tenant-123", id = "user-456", deleteComments = "", commentDeleteMode = "")
if response.isSome:
  let flagResp = response.get()
  echo flagResp

Obter usuário do locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetTenantUser_200_response]

Exemplo

Exemplo de getTenantUser

Copy

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

Obter usuários do locatário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
skip	float64	Não

Resposta

Retorna: Option[GetTenantUsers_200_response]

Exemplo

Exemplo de getTenantUsers

Copy

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

Substituir usuário do locatário

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
replaceTenantUserBody	ReplaceTenantUserBody	Não
updateComments	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de replaceTenantUser

Copy

let replaceBody = ReplaceTenantUserBody(name: "Jane Doe", email: "jane.doe@example.com", roles: @["moderator", "contributor"], banned: false)
let (response, httpResponse) = client.replaceTenantUser(tenantId = "my-tenant-123", id = "user-789", replaceTenantUserBody = replaceBody, updateComments = "true")
if response.isSome:
  let updated = response.get()
  echo updated
else:
  echo "No response returned"

Enviar link de login

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
redirectURL	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de sendLoginLink

Copy

let (response, httpResponse) = client.sendLoginLink(tenantId = "fastcomments-tenant-42", id = "user-9876", redirectURL = "https://news.example.com/articles/2026/fastcomments-login")
if response.isSome:
  let loginResp = response.get()
  echo "Login link sent successfully"
else:
  echo "Failed to send login link"

Atualizar usuário do locatário

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string	No

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateTenantUser

Copy

var body: UpdateTenantUserBody
body.email = "jane.doe@example.com"
body.displayName = "Jane Doe"
body.roles = @["moderator", "editor"]
body.isActive = true
let (response, httpResponse) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateTenantUserBody = body,
  updateComments = "Promoted user to moderator and editor roles"
)
if response.isSome:
  let flagResp = response.get()
  echo flagResp
else:
  echo "Update failed, status: ", httpResponse.status

Criar locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createTenantBody	CreateTenantBody	Não

Resposta

Retorna: Option[CreateTenant_200_response]

Exemplo

Exemplo de createTenant

Copy

let (response, httpResponse) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody(
  name: "My Tenant 123",
  domain: "mytenant.example.com",
  plan: "pro",
  isActive: true,
  allowedOrigins: @["https://www.example.com", "https://admin.example.com"]
))
if response.isSome:
  let tenantInfo = response.get()
  discard tenantInfo

Excluir locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
sure	string	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de deleteTenant

Copy

let (response, httpResponse) = client.deleteTenant(tenantId = "my-tenant-123", id = "", sure = "")
if response.isSome:
  let flagResp = response.get()
  echo "Tenant deletion response received for tenant: ", "my-tenant-123"
  discard flagResp
else:
  echo "No response body returned for tenant deletion"

Obter locatário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetTenant_200_response]

Exemplo

Exemplo de getTenant

Copy

let (response, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let tenant = response.get()
  echo "Tenant retrieved"
  discard tenant
else:
  echo "No tenant found"
  echo "HTTP status:", httpResponse.status

Obter locatários

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
meta	string	Não
skip	float64	Não

Resposta

Retorna: Option[GetTenants_200_response]

Exemplo

Exemplo de getTenants

Copy

let (response, httpResponse) = client.getTenants(tenantId = "my-tenant-123", meta = "include=details", skip = 0.0)
if response.isSome:
  let tenants = response.get()
  echo "Received tenants: ", repr(tenants)
else:
  echo "Failed to retrieve tenants"

Atualizar locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateTenantBody	UpdateTenantBody	Não

Resposta

Retorna: Option[FlagCommentPublic_200_response]

Exemplo

Exemplo de updateTenant

Copy

let (response, httpResponse) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = UpdateTenantBody()
)
if response.isSome:
  let flagResponse = response.get()
  echo flagResponse
else:
  echo "No body returned; HTTP status: ", httpResponse.status

Enviar imagem

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
file	string	Não
sizePreset	SizePreset	Não
urlId	string	Sim

Resposta

Retorna: Option[UploadImageResponse]

Exemplo

Exemplo de uploadImage

Copy

let (response, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "assets/images/comment-avatar.jpg",
  sizePreset = SizePreset.small,
  urlId = "news/article-2025-11-22"
)
if response.isSome:
  let upload = response.get()
  echo "Uploaded image id: ", upload.id
  echo "Uploaded image url: ", upload.url

Obter progresso de medalha do usuário por ID

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetUserBadgeProgressById_200_response]

Exemplo

Exemplo de getUserBadgeProgressById

Copy

let (response, httpResponse) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "editor-badge-42")
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress received:"
  echo badgeProgress
else:
  echo "No badge progress found for tenant 'my-tenant-123' and id 'editor-badge-42'"
  echo httpResponse

Obter progresso de medalha do usuário por ID do usuário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
userId	string	Não

Resposta

Retorna: Option[GetUserBadgeProgressById_200_response]

Exemplo

Exemplo de getUserBadgeProgressByUserId

Copy

let (response, httpResponse) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress retrieved for user-456"
else:
  echo "No badge progress found, HTTP status: ", $httpResponse.status

Obter lista de progresso de medalhas do usuário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
limit	float64	Não
skip	float64	Não

Resposta

Retorna: Option[GetUserBadgeProgressList_200_response]

Exemplo

Exemplo de getUserBadgeProgressList

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", userId = "user-9823", limit = 25.0, skip = 0.0)
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress received:", badgeProgress
else:
  echo "No badge progress. HTTP response:", httpResponse.status

Criar medalha do usuário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createUserBadgeParams	CreateUserBadgeParams	Não

Resposta

Retorna: Option[CreateUserBadge_200_response]

Exemplo

Exemplo de createUserBadge

Copy

let (response, httpResponse) = client.createUserBadge(tenantId = "my-tenant-123",
  createUserBadgeParams = CreateUserBadgeParams(userId = "user-987", badgeId = "top-commenter"))
if response.isSome:
  let createdBadge = response.get()
  echo "Created badge for user: ", createdBadge.userId
else:
  echo "Failed to create badge, status: ", $httpResponse.status

Excluir medalha do usuário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[UpdateUserBadge_200_response]

Exemplo

Exemplo de deleteUserBadge

Copy

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

Obter medalha do usuário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetUserBadge_200_response]

Exemplo

Exemplo getUserBadge

Copy

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

Obter medalhas do usuário

Parâmetros

Name	Type	Required
tenantId	string	Sim
userId	string	Não
badgeId	string	Não
displayedOnComments	bool	Não
limit	float64	Não
skip	float64	Não

Resposta

Retorna: Option[GetUserBadges_200_response]

Exemplo

Exemplo de getUserBadges

Copy

let (response, httpResponse) = client.getUserBadges(
  tenantId = "my-tenant-123",
  userId = "user-789",
  badgeId = "top-commenter",
  displayedOnComments = true,
  limit = 50.0,
  skip = 0.0
)
if response.isSome:
  let badges = response.get()
  echo "Retrieved badges: ", $badges

Atualizar medalha do usuário

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Não
updateUserBadgeParams	UpdateUserBadgeParams	Não

Resposta

Retorna: Option[UpdateUserBadge_200_response]

Exemplo

Exemplo de updateUserBadge

Copy

let updateParams = UpdateUserBadgeParams(
  name = "Top Contributor",
  description = "Awarded for consistent high-quality comments",
  active = true,
  tags = @["community", "milestone"]
)
let (response, httpResponse) = client.updateUserBadge(tenantId = "my-tenant-123", id = "badge-456", updateUserBadgeParams = updateParams)
if response.isSome:
  let updated = response.get()
  echo "Badge updated successfully"
else:
  echo "Failed to update badge, HTTP status: ", $httpResponse.status

Obter contagem de notificações do usuário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
sso	string	Não

Resposta

Retorna: Option[GetUserNotificationCount_200_response]

Exemplo

Exemplo getUserNotificationCount

Copy

let (response, httpResponse) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data: ", $notificationData
else:
  echo "No notification data returned. HTTP response: ", $httpResponse.status

Obter notificações do usuário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
pageSize	int	Não
afterId	string	Não
includeContext	bool	Não
afterCreatedAt	int64	Não
unreadOnly	bool	Não
dmOnly	bool	Não
noDm	bool	Não
includeTranslations	bool	Não
sso	string	Não

Resposta

Retorna: Option[GetUserNotifications_200_response]

Exemplo

Exemplo de getUserNotifications

Copy

let (response, httpResponse) = client.getUserNotifications(
  tenantId = "my-tenant-123",
  pageSize = 50,
  afterId = "notif_9a1b2c3d",
  includeContext = true,
  afterCreatedAt = int64(1699999999000),
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  includeTranslations = false,
  sso = ""
)
if response.isSome:
  let notifications = response.get()
  discard notifications
else:
  discard httpResponse

Redefinir contagem de notificações do usuário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
sso	string	Não

Resposta

Retorna: Option[ResetUserNotifications_200_response]

Exemplo

Exemplo de resetUserNotificationCount

Copy

let (response, httpResponse) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "sso-jwt-9a8b7c6d")
if response.isSome:
  let resetResult = response.get()
  echo resetResult
else:
  echo "Reset failed, status: ", httpResponse.status

Redefinir notificações do usuário

Parâmetros

Name	Type	Required
tenantId	string	Sim
afterId	string	Não
afterCreatedAt	int64	Não
unreadOnly	bool	Não
dmOnly	bool	Não
noDm	bool	Não
sso	string	Não

Resposta

Retorna: Option[ResetUserNotifications_200_response]

Exemplo

Exemplo de resetUserNotifications

Copy

let (response, httpResponse) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  afterId = "",
  afterCreatedAt = int64(0),
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  sso = ""
)
if response.isSome:
  let result = response.get()

Atualizar status de inscrição de notificação de comentário do usuário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
notificationId	string	Não
optedInOrOut	string	Não
commentId	string	Sim
sso	string	Não

Resposta

Retorna: Option[UpdateUserNotificationStatus_200_response]

Exemplo

Exemplo de updateUserNotificationCommentSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted_in",
  commentId = "cmt-789",
  sso = "sso-token-abc"
)
if response.isSome:
  let updatedStatus = response.get()
  discard updatedStatus
else:
  discard httpResponse

Atualizar status de inscrição de notificação de página do usuário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
url	string	Não
pageTitle	string	Não
subscribedOrUnsubscribed	string	Não
sso	string	Não

Resposta

Retorna: Option[UpdateUserNotificationStatus_200_response]

Exemplo

Exemplo de updateUserNotificationPageSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-2025-11-22",
  url = "https://example.com/news/article-2025-11-22",
  pageTitle = "Breaking News: Market Update",
  subscribedOrUnsubscribed = "subscribed",
  sso = "sso-token-abc123"
)
if response.isSome:
  let result = response.get()
  discard result

Atualizar status de notificação do usuário

Parâmetros

Name	Type	Required
tenantId	string	Sim
notificationId	string	Não
newStatus	string	Não
sso	string	Não

Resposta

Retorna: Option[UpdateUserNotificationStatus_200_response]

Exemplo

Exemplo de updateUserNotificationStatus

Copy

let (response, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = "sso-abc-789"
)
if response.isSome:
  let updateResp = response.get()
  discard updateResp

Obter status de presença dos usuários

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlIdWS	string	Não
userIds	string	Não

Resposta

Retorna: Option[GetUserPresenceStatuses_200_response]

Exemplo

Exemplo de getUserPresenceStatuses

Copy

let (response, httpResponse) = client.getUserPresenceStatuses(
  tenantId = "my-tenant-123",
  urlIdWS = "news/2025/technology/ai-ethics",
  userIds = "user-789,user-456"
)
if response.isSome:
  let presence = response.get()
  echo "Presence received: ", presence
else:
  echo "No presence information returned, HTTP status: ", httpResponse.status.code

Pesquisar usuários

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
usernameStartsWith	string	Não
mentionGroupIds	seq[string]	Não
sso	string	Não

Resposta

Retorna: Option[SearchUsers_200_response]

Exemplo

Exemplo de searchUsers

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  usernameStartsWith = "jo",
  mentionGroupIds = @["editors", "sports-team"],
  sso = "sso-abc-456"
)
if response.isSome:
  let users = response.get()
  echo "Users found: ", users
else:
  echo "No users found; HTTP status: ", httpResponse.status

Obter usuário

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Não

Resposta

Retorna: Option[GetUser_200_response]

Exemplo

Exemplo de getUser

Copy

let (response, httpResponse) = client.getUser(tenantId = "my-tenant-123", id = "user-9876")
if response.isSome:
  let user = response.get()
  echo "User:", user
else:
  echo "No user found. HTTP response:", httpResponse

Criar voto

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
direction	string	Não
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[VoteComment_200_response]

Exemplo

Exemplo de createVote

Copy

let (response, httpResponse) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  direction = "up",
  userId = "user-42",
  anonUserId = ""
)
if response.isSome:
  let vote = response.get()
  echo "Vote recorded: ", $vote
else:
  echo "Vote not created, HTTP response: ", $httpResponse

Excluir voto

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
editKey	string	Não

Resposta

Retorna: Option[DeleteCommentVote_200_response]

Exemplo

Exemplo de deleteVote

Copy

let (response, httpResponse) = client.deleteVote(tenantId = "my-tenant-123", id = "", editKey = "")
if response.isSome:
  let deleted = response.get()
  discard deleted

Obter votos

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
urlId	string	Sim

Resposta

Retorna: Option[GetVotes_200_response]

Exemplo

Exemplo de getVotes

Copy

let (response, httpResponse) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/2026/major-update")
if response.isSome:
  let votes = response.get()
  discard votes
else:
  discard httpResponse

Obter votos para usuário

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlId	string	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: Option[GetVotesForUser_200_response]

Exemplo

Exemplo de getVotesForUser

Copy

let (response, httpResponse) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/economy-update-2026",
  userId = "user-789",
  anonUserId = ""
)
if response.isSome:
  let votes = response.get()
  discard votes

Precisa de ajuda?

Se você encontrar algum problema ou tiver perguntas sobre o Nim SDK, por favor:

Contribuindo

Contribuições são bem-vindas! Por favor visite o repositório do GitHub para as diretrizes de contribuição.

Idioma 🇧🇷 Português (Brasil)

Documentação

Primeiros passos

Referência da API

Uso

Agregação

Logs de auditoria

Bloquear a partir do comentário

Verificar comentários bloqueados

Comentários

Configurações de domínio

Modelos de e-mail

Registro de eventos

Publicações do feed

Denunciar comentário

Hashtags

Moderadores

Contagem de notificações

Notificações

Páginas

Eventos de webhook pendentes

Configurações de perguntas

Resultados de perguntas

Agregação de resultados de perguntas

Usuários SSO

Assinaturas

Uso diário do locatário

Pacotes do locatário

Usuários do locatário

Locatários

Enviar imagem

Progresso de medalha do usuário

Medalhas do usuário

Notificações do usuário

Status de presença do usuário

Pesquisa de usuários

Usuários

Votos

FastComments Nim SDK

Repositório

Requisitos

Instalação

Usando Nimble

Compilando a partir do código-fonte

Conteúdo da Biblioteca

APIs Públicas vs APIs Seguras

Início rápido

Usando APIs autenticadas (DefaultAPI)

Usando APIs públicas (PublicAPI)

Problemas Comuns

Fazendo chamadas de API

Exemplo: Recuperando Comentários

Observações

IDs de Broadcast

SSO (Login Único)

Uso de SSO

SSO Simples

SSO Seguro

Documentação do fastcomments

Documentação para fastcomments

Documentação para Endpoints da API

Documentação para Modelos

Documentação para Autorização

api_key

Agregação

Parâmetros

Resposta

Exemplo

Obter logs de auditoria

Parâmetros

Resposta

Exemplo

Bloquear a partir de comentário público

Parâmetros

Resposta

Exemplo

Desbloquear comentário público

Parâmetros

Resposta

Exemplo