FastComments Nim SDK

Este é o SDK oficial em Nim para o FastComments.

SDK oficial em Nim para a API do FastComments

Repositório

Agentes de codificação IA

Forneça ao seu agente de codificação o contexto do FastComments que ele precisa - widgets, configuração, Secure SSO, a REST API e os SDKs:

npx skills add fastcomments/skills

Funciona com Claude Code, Codex, Cursor, Copilot, Gemini e todos os outros agentes que o skills CLI suporta.

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 utilitários SSO para facilitar o trabalho com a API.

API Client Library Docs

APIs Públicas vs Seguras

Para o cliente de API, existem três módulos de API, api_default, api_public e api_moderation. 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. O módulo api_moderation contém métodos para o painel de moderador.

O módulo api_moderation fornece um conjunto extenso de APIs de moderação em tempo real e rápidas. Cada método api_moderation aceita um parâmetro sso e pode autenticar via SSO ou um cookie de sessão do FastComments.com.

Início rápido

Usando APIs Autenticadas (DefaultAPI)

Importante: Endpoints autenticados requerem 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.
# Parâmetros obrigatórios (e o corpo da requisição) são posicionais; opcionais
# parâmetros são passados via o objeto de opções da operação.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

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.
# tenantId e urlId são obrigatórios (posicionais); todo o resto é opcional.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Usando APIs de Moderação (ModerationAPI)

Endpoints de moderação alimentam o painel do moderador e são autenticados com um token SSO para o moderador em atuação:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Listar comentários no painel de moderação.
# Esta operação não tem parâmetros obrigatórios, portanto tudo é opcional.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Problemas Comuns

Erro de autenticação 401: Certifique-se de definir o cabeçalho x-api-key no seu HttpClient antes de fazer requisições DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Classe de API incorreta: Use api_default para requisições autenticadas do lado do servidor, api_public para requisições do lado do cliente/públicas, e api_moderation para requisições do painel de moderador.

Fazendo chamadas de API

All API methods in this SDK return tuples of (Option[ResponseType], Response). O primeiro elemento contém a resposta analisada se for bem‑sucedida, e o segundo elemento é a resposta HTTP bruta.

Required parameters and the request body are passed positionally. Os parâmetros opcionais restantes são reunidos em um único objeto Api<Operation>Options, que é o último argumento. Operations with no optional parameters take no options object.

Exemplo: Obtendo 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",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Notas

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 para fastcomments

Documentation for API Endpoints

All URIs are relative to https://fastcomments.com

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
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	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
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	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
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	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
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	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
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	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
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	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
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	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
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	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
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}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

agregado

Agrega documentos agrupando‑os (se groupBy for fornecido) e aplicando várias operações. Diferentes operações (por exemplo, sum, countDistinct, avg, etc.) são suportadas.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
aggregationRequest	AggregationRequest	Não
options	AggregateOptions	Não

Resposta

Retorna: Option[AggregateResponse]

Exemplo

Exemplo de agregação

Copy

let (aggResp, httpResp) = client.aggregate(tenantId = "my-tenant-123", aggregationRequest = AggregationRequest(), options = AggregateOptions())
if aggResp.isSome:
  let response = aggResp.get()
  echo response
echo httpResp

obterLogsDeAuditoria

Parameters

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Yes
options	GetAuditLogsOptions	No

Response

Retorna: Option[GetAuditLogsResponse]

Exemplo

Exemplo getAuditLogs

Copy

let (auditOpt, httpResp) = client.getAuditLogs(tenantId = "my-tenant-123", options = GetAuditLogsOptions())
if auditOpt.isSome:
  let audit = auditOpt.get()
  echo audit

logoutPublic

Response

Returns: Option[APIEmptyResponse]

Example

Exemplo logoutPublic

Copy

let (responseOpt, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", userId = "user-456")
if responseOpt.isSome:
  let emptyResponse = responseOpt.get()

bloquearDoComentarioPublico

Parâmetros

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

Resposta

Retorna: Option[BlockSuccess]

Exemplo

Exemplo blockFromCommentPublic

Copy

let (blockOpt, httpResp) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if blockOpt.isSome:
  let block = blockOpt.get()

desbloquearComentarioPublico

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Resposta

Retorna: Option[UnblockSuccess]

Exemplo

Exemplo unBlockCommentPublic

Copy

let (unblockResult, httpResp) = client.unBlockCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if unblockResult.isSome:
  let result = unblockResult.get()

comentariosVerificadosParaBloqueio

Parâmetros

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

Resposta

Retorna: Option[CheckBlockedCommentsResponse]

Exemplo

Exemplo checkedCommentsForBlocked

Copy

let (maybeResponse, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "cmt-1,cmt-2",
  sso = ""
)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  discard response

bloquearUsuarioDoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

Resposta

Retorna: Option[BlockSuccess]

Exemplo

blockUserFromComment Exemplo

Copy

let params = BlockFromCommentParams()
let opts = BlockUserFromCommentOptions()
let (blockResult, httpResp) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  blockFromCommentParams = params,
  options = opts
)
if blockResult.isSome:
  let success = blockResult.get()
  discard success

criarComentarioPublico

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Resposta

Retorna: Option[SaveCommentsResponseWithPresence]

Exemplo

Exemplo createCommentPublic

Copy

let
  tenantId = "my-tenant-123"
  urlId = "news/article-title"
  broadcastId = "broadcast-456"
  commentData = CommentData()
  options = CreateCommentPublicOptions()
let (maybeResp, httpResp) = client.createCommentPublic(
  tenantId = tenantId,
  urlId = urlId,
  broadcastId = broadcastId,
  commentData = commentData,
  options = options)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

excluirComentario

Parâmetros

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

Resposta

Retorna: Option[DeleteCommentResult]

Exemplo

Exemplo deleteComment

Copy

let (delResult, httpResponse) = client.deleteComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  options = DeleteCommentOptions()
)
if delResult.isSome:
  let result = delResult.get()
  echo result

excluirComentarioPublico

Parâmetros

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

Resposta

Retorna: Option[PublicAPIDeleteCommentResponse]

Exemplo

deleteCommentPublic Exemplo

Copy

let (responseOpt, httpResp) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  options = DeleteCommentPublicOptions())
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

excluirVotoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
voteId	string	Não
urlId	string	Sim
broadcastId	string	Não
options	DeleteCommentVoteOptions	Não

Resposta

Retorna: Option[VoteDeleteResponse]

Exemplo

deleteCommentVote Exemplo

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  voteId = "vote-789",
  urlId = "news/article-title",
  broadcastId = "broadcast-001",
  options = DeleteCommentVoteOptions()
)
if response.isSome:
  let voteDelete = response.get()

denunciarComentario

Parâmetros

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

Resposta

Retorna: Option[FlagCommentResponse]

Exemplo

Exemplo de flagComment

Copy

let options = FlagCommentOptions(reason: "spam content", note: "Automated posting detected", isSpam: true, categories: @["spam"])
let (flagRes, httpRes) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-789", options = options)
if flagRes.isSome:
  let res = flagRes.get()
  discard res

obterComentario

Parâmetros

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

Resposta

Retorna: Option[APIGetCommentResponse]

Exemplo

Exemplo getComment

Copy

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

obterComentarios

Parâmetros

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

Resposta

Retorna: Option[APIGetCommentsResponse]

Exemplo

Exemplo getComments

Copy

let options = GetCommentsOptions(
  urlId = "news/article-title",
  page = 0,
  pageSize = 20,
  sort = "newest",
  includeDeleted = false,
  includeReplies = true,
  userIds = @[],
  tags = @[]
)
let (response, httpResponse) = client.getComments(tenantId = "my-tenant-123", options = options)
if response.isSome:
  let comments = response.get()
  discard comments

obterComentariosPublicos

req tenantId urlId

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
options	GetCommentsPublicOptions	Não

Resposta

Retorna: Option[GetCommentsResponseWithPresencePublicComment]

Exemplo

Exemplo getCommentsPublic

Copy

let (optResp, httpResp) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetCommentsPublicOptions(
    page = 0,
    pageSize = 10,
    includeDeleted = false,
    tags = @[]
  )
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

obterTextoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	GetCommentTextOptions	Não

Resposta

Retorna: Option[PublicAPIGetCommentTextResponse]

Exemplo

Exemplo getCommentText

Copy

let (maybeResponse, httpResponse) = client.getCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = GetCommentTextOptions()
)
if maybeResponse.isSome:
  let response = maybeResponse.get()

obterNomesUsuariosVotoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
dir	int	Não
sso	string = ""	Não

Resposta

Retorna: Option[GetCommentVoteUserNamesSuccessResponse]

Exemplo

Exemplo getCommentVoteUserNames

Copy

let (voteNamesOpt, httpRes) = client.getCommentVoteUserNames(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  dir = 0,
  sso = ""
)
if voteNamesOpt.isSome:
  let voteNames = voteNamesOpt.get()
  echo voteNames

trancarComentario

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo lockComment

Copy

let (lockResult, httpRes) = client.lockComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  broadcastId = "",
  sso = "")
if lockResult.isSome:
  let resp = lockResult.get()
  discard resp

fixarComentario

Parâmetros

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

Resposta

Retorna: Option[ChangeCommentPinStatusResponse]

Exemplo

Exemplo pinComment

Copy

let (pinResult, httpResp) = client.pinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = "",
)
if pinResult.isSome:
  let response = pinResult.get()
  echo response

salvarComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createCommentParams	CreateCommentParams	Não
options	SaveCommentOptions	Não

Resposta

Retorna: Option[APISaveCommentResponse]

Exemplo

Exemplo saveComment

Copy

let commentParams = CreateCommentParams(
  body: "Great read, thanks!",
  name: "Alice Smith",
  email: "alice@example.com",
  parentId: ""
)
let saveOpts = SaveCommentOptions(
  isPreview: false,
  isApproved: true,
  skipSpamCheck: false
)
let (apiResponse, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = commentParams,
  options = saveOpts
)
if apiResponse.isSome:
  let saved = apiResponse.get()
  echo saved

salvarComentariosEmLote

Parâmetros

Name	Type	Required
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo saveCommentsBulk

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  options = SaveCommentsBulkOptions(),
  id = "",
  fromName = ""
)
if response.isSome:
  let result = response.get()

definirTextoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

Resposta

Retorna: Option[PublicAPISetCommentTextResponse]

Exemplo

Exemplo setCommentText

Copy

let commentUpdate = CommentTextUpdateRequest(text: "Updated comment text")
let opts = SetCommentTextOptions()
let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  broadcastId = "broadcast-789",
  commentTextUpdateRequest = commentUpdate,
  options = opts)
if response.isSome:
  let result = response.get()

desbloquearUsuarioDoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
unBlockFromCommentParams	UnBlockFromCommentParams	Não
options	UnBlockUserFromCommentOptions	Não

Resposta

Retorna: Option[UnblockSuccess]

Exemplo

unBlockUserFromComment Exemplo

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  unBlockFromCommentParams = UnBlockFromCommentParams(userId = "user-789", commentId = "cmt-321"),
  options = UnBlockUserFromCommentOptions(),
)
if response.isSome:
  let unblockSuccess = response.get()

removerDenunciaComentario

Parâmetros

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

Resposta

Retorna: Option[FlagCommentResponse]

Exemplo

Exemplo de unFlagComment

Copy

let (flagRespOpt, httpResp) = client.unFlagComment(tenantId = "my-tenant-123", id = "comment-456", options = UnFlagCommentOptions())
if flagRespOpt.isSome:
  let flagResp = flagRespOpt.get()

destrancarComentario

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

unLockComment Exemplo

Copy

let (maybeEmpty, httpResp) = client.unLockComment(tenantId = "my-tenant-123", commentId = "comment-456", broadcastId = "", sso = "")
if maybeEmpty.isSome:
  let emptyResp = maybeEmpty.get()
  echo "Comment unlocked"
else:
  echo "Failed to unlock comment"

desfixarComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Resposta

Retorna: Option[ChangeCommentPinStatusResponse]

Exemplo

Exemplo unPinComment

Copy

let (responseOpt, httpResponse) = client.unPinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = ""
)
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

atualizarComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updatableCommentParams	UpdatableCommentParams	Não
options	UpdateCommentOptions	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo updateComment

Copy

let commentParams = UpdatableCommentParams(content: "Updated comment content")
let updateOpts = UpdateCommentOptions(force: false)
let (respOpt, httpResp) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = commentParams,
  options = updateOpts
)
if respOpt.isSome:
  let resp = respOpt.get()

votarComentario

Parâmetros

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

Resposta

Retorna: Option[VoteResponse]

Exemplo

Exemplo voteComment

Copy

let (voteRespOpt, httpResp) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  urlId = "blog/how-to-code",
  broadcastId = "",
  voteBodyParams = VoteBodyParams(),
  options = VoteCommentOptions()
)
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()

obterComentariosParaUsuario

Parâmetros

Nome	Tipo	Obrigatório	Descrição
options	GetCommentsForUserOptions	Não

Resposta

Retorna: Option[GetCommentsForUserResponse]

Exemplo

Exemplo getCommentsForUser

Copy

let (maybeResp, httpResp) = client.getCommentsForUser(options = GetCommentsForUserOptions(
  tenantId = "my-tenant-123",
  userId = "user-456",
  page = 0,
  pageSize = 20,
  includeDeleted = false,
  commentIds = @[]
))
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp

adicionarConfiguracaoDominio

Parâmetros

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

Resposta

Retorna: Option[AddDomainConfigResponse]

Exemplo

Exemplo addDomainConfig

Copy

let (respOpt, httpResp) = client.addDomainConfig(
  tenantId = "my-tenant-123",
  addDomainConfigParams = default(AddDomainConfigParams)
)
if respOpt.isSome:
  let cfg = respOpt.get()

excluirConfiguracaoDominio

Parâmetros

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

Resposta

Retorna: Option[DeleteDomainConfigResponse]

Exemplo

deleteDomainConfig Exemplo

Copy

let (optResp, httpResp) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

obterConfiguracaoDominio

Parâmetros

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

Resposta

Retorna: Option[GetDomainConfigResponse]

Exemplo

Exemplo getDomainConfig

Copy

let (configOpt, httpResp) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if configOpt.isSome:
  let cfg = configOpt.get()
  discard cfg

obterConfiguracoesDominio

Parâmetros

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

Resposta

Retorna: Option[GetDomainConfigsResponse]

Exemplo

Exemplo getDomainConfigs

Copy

let (domainConfigsOpt, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if domainConfigsOpt.isSome:
  let domainConfigs = domainConfigsOpt.get()
  echo domainConfigs

patchConfiguracaoDominio

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
domainToUpdate	string	Não
patchDomainConfigParams	PatchDomainConfigParams	Não

Resposta

Retorna: Option[PatchDomainConfigResponse]

Exemplo

Exemplo patchDomainConfig

Copy

let (optResp, httpResp) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news.mywebsite.com",
  patchDomainConfigParams = PatchDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

putConfiguracaoDominio

Parâmetros

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

Resposta

Retorna: Option[PutDomainConfigResponse]

Exemplo

Exemplo putDomainConfig

Copy

let (optResp, httpResp) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "example.com",
  updateDomainConfigParams = UpdateDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

criarModeloEmail

Parâmetros

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

Resposta

Retorna: Option[CreateEmailTemplateResponse]

Exemplo

createEmailTemplate Exemplo

Copy

let createBody = CreateEmailTemplateBody(
  name: "Welcome Email",
  subject: "Welcome to FastComments",
  htmlBody: "<p>Hello, thank you for joining us!</p>",
  isActive: true,
  tags: @[]
)
let (optResp, httpResp) = client.createEmailTemplate(
  tenantId = "my-tenant-123",
  createEmailTemplateBody = createBody
)
if optResp.isSome:
  let emailTemplate = optResp.get()

excluirModeloEmail

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de deleteEmailTemplate

Copy

let (respOpt, httpResp) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if respOpt.isSome:
  let emptyResp = respOpt.get()
  echo "Email template deleted"
else:
  echo "Failed to delete email template"

excluirErroRenderizacaoModeloEmail

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de deleteEmailTemplateRenderError

Copy

let (apiRes, httpRes) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  errorId = "render-err-456"
)
if apiRes.isSome:
  let empty = apiRes.get()

obterModeloEmail

Parâmetros

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

Resposta

Retorna: Option[GetEmailTemplateResponse]

Exemplo

Exemplo getEmailTemplate

Copy

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

obterDefinicoesModeloEmail

Parâmetros

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

Resposta

Retorna: Option[GetEmailTemplateDefinitionsResponse]

Exemplo

Exemplo getEmailTemplateDefinitions

Copy

let (responseOpt, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if responseOpt.isSome:
  let definitions = responseOpt.get()
  echo definitions

obterErrosRenderizacaoModeloEmail

Parâmetros

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

Resposta

Retorna: Option[GetEmailTemplateRenderErrorsResponse]

Exemplo

Exemplo getEmailTemplateRenderErrors

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # use resp conforme necessário
else:
  # trate a resposta ausente
  discard

obterModelosEmail

Parâmetros

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

Resposta

Retorna: Option[GetEmailTemplatesResponse]

Exemplo

Exemplo getEmailTemplates

Copy

let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if emailTemplatesOpt.isSome:
  let templates = emailTemplatesOpt.get()
  echo templates

renderizarModeloEmail

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Resposta

Retorna: Option[RenderEmailTemplateResponse]

Exemplo

Exemplo renderEmailTemplate

Copy

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

atualizarModeloEmail

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

updateEmailTemplate Exemplo

Copy

let updateBody = UpdateEmailTemplateBody(
  subject: "Welcome to FastComments",
  body: "Hello \{{user_name}}, thanks for joining!",
  enabled: true,
)
let (maybeResp, httpResp) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  updateEmailTemplateBody = updateBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()

obterLogEvento

req tenantId urlId userIdWS

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Resposta

Retorna: Option[GetEventLogResponse]

Exemplo

Exemplo getEventLog

Copy

let (eventLogOpt, httpResp) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

obterLogEventoGlobal

req tenantId urlId userIdWS

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[GetEventLogResponse]

Exemplo

Exemplo getGlobalEventLog

Copy

let (eventLogOpt, httpResp) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "user-456",
  startTime = 1700000000'i64,
  endTime = 1700003600'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

criarPostFeed

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createFeedPostParams	CreateFeedPostParams	Não
options	CreateFeedPostOptions	Não

Resposta

Retorna: Option[CreateFeedPostsResponse]

Exemplo

Exemplo createFeedPost

Copy

let (respOpt, httpResp) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(),
  options = CreateFeedPostOptions()
)
if respOpt.isSome:
  let feedPost = respOpt.get()

criarPostFeedPublico

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createFeedPostParams	CreateFeedPostParams	Não
options	CreateFeedPostPublicOptions	Não

Resposta

Retorna: Option[CreateFeedPostResponse]

Exemplo

createFeedPostPublic Exemplo

Copy

let params = CreateFeedPostParams(
  urlId: "news/big-event",
  title: "Big Event Happened",
  content: "Full article content goes here.",
  tags: @["news", "event"]
)
let opts = CreateFeedPostPublicOptions(
  sendNotifications: false,
  allowComments: true
)
let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = params,
  options = opts
)
if response.isSome:
  let post = response.get()
  echo post

excluirPostFeedPublico

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Não
options	DeleteFeedPostPublicOptions	Não

Resposta

Retorna: Option[DeleteFeedPostPublicResponse]

Exemplo

deleteFeedPostPublic Exemplo

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-42",
  options = DeleteFeedPostPublicOptions()
)
if response.isSome:
  let deleteResp = response.get()

obterPostsFeed

req tenantId afterId

Parâmetros

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

Resposta

Retorna: Option[GetFeedPostsResponse]

Exemplo

getFeedPosts Exemplo

Copy

let (feedResponseOpt, httpResp) = client.getFeedPosts(tenantId = "my-tenant-123", options = GetFeedPostsOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()
  echo feedResponse

obterPostsFeedPublicos

req
tenantId
afterId

Parâmetros

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

Resposta

Retorna: Option[PublicFeedPostsResponse]

Exemplo

Exemplo getFeedPostsPublic

Copy

  
let (feedResponseOpt, httpResponse) = client.getFeedPostsPublic(tenantId = "my-tenant-123", options = GetFeedPostsPublicOptions())  
if feedResponseOpt.isSome:  
  let feedResponse = feedResponseOpt.get()  

obterEstatisticasPostsFeed

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

Resposta

Retorna: Option[FeedPostsStatsResponse]

Exemplo

Exemplo getFeedPostsStats

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # usar stats conforme necessário

obterReacoesUsuarioPublicas

Parâmetros

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

Resposta

Retorna: Option[UserReactsResponse]

Exemplo

getUserReactsPublic Exemplo

Copy

let opts = GetUserReactsPublicOptions(
  limit = 20,
  offset = 0,
  includeDeleted = false
)
let (response, httpResponse) = client.getUserReactsPublic(
  tenantId = "my-tenant-123",
  options = opts
)
if response.isSome:
  let userReacts = response.get()

reagirPostFeedPublico

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Não
reactBodyParams	ReactBodyParams	Não
options	ReactFeedPostPublicOptions	Não

Resposta

Retorna: Option[ReactFeedPostResponse]

Exemplo

Exemplo reactFeedPostPublic

Copy

let reactParams = ReactBodyParams()
let (optResp, httpResp) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  reactBodyParams = reactParams,
  options = ReactFeedPostPublicOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

atualizarPostFeed

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de updateFeedPost

Copy

let feedPost = FeedPost(
  title: "Breaking News",
  content: "Updated story content",
  tags: @["news", "update"]
)
let (apiRes, httpRes) = client.updateFeedPost(
  tenantId = "my-tenant-123",
  id = "post-456",
  feedPost = feedPost
)
if apiRes.isSome:
  let res = apiRes.get()

atualizarPostFeedPublico

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Não
updateFeedPostParams	UpdateFeedPostParams	Não
options	UpdateFeedPostPublicOptions	Não

Resposta

Retorna: Option[CreateFeedPostResponse]

Exemplo

Exemplo updateFeedPostPublic

Copy

let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-789",
  updateFeedPostParams = UpdateFeedPostParams(),
  options = UpdateFeedPostPublicOptions()
)
if response.isSome:
  let post = response.get()

denunciarComentarioPublico

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de flagCommentPublic

Copy

let (optResp, httpResp) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  isFlagged = true,
  sso = ""
)
if optResp.isSome:
  let empty = optResp.get()
  discard empty

obterGifGrande

Parâmetros

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

Resposta

Retorna: Option[GifGetLargeResponse]

Exemplo

Exemplo getGifLarge

Copy

let (gifOpt, httpResp) = client.getGifLarge(
  tenantId = "my-tenant-123",
  largeInternalURLSanitized = "https://cdn.example.com/gifs/large123.gif")
if gifOpt.isSome:
  let gif = gifOpt.get()
  echo gif

buscarGifs

Parâmetros

Name	Type	Required
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

Resposta

Retorna: Option[GetGifsSearchResponse]

Exemplo

Exemplo getGifsSearch

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # use resp conforme necessário

obterGifsEmAlta

Parâmetros

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

Resposta

Retorna: Option[GetGifsTrendingResponse]

Exemplo

getGifsTrending Exemplo

Copy

let (maybeResponse, httpResponse) = client.getGifsTrending(
  tenantId = "my-tenant-123",
  options = GetGifsTrendingOptions()
)
if maybeResponse.isSome:
  let gifs = maybeResponse.get()
  echo gifs

adicionarHashtag

Parâmetros

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

Resposta

Retorna: Option[CreateHashTagResponse]

Exemplo

addHashTag Exemplo

Copy

let (hashTagOpt, httpResp) = client.addHashTag(
  tenantId = "my-tenant-123",
  createHashTagBody = CreateHashTagBody(),
)
if hashTagOpt.isSome:
  let tag = hashTagOpt.get()

adicionarHashtagsEmLote

Parâmetros

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

Resposta

Returns: Option[BulkCreateHashTagsResponse]

Exemplo

addHashTagsBulk Exemplo

Copy

let (optResp, httpResp) = client.addHashTagsBulk(
  tenantId = "my-tenant-123",
  bulkCreateHashTagsBody = BulkCreateHashTagsBody(
    hashTags = @["news", "technology"]
  )
)
if optResp.isSome:
  let resp = optResp.get()

excluirHashtag

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
tag	string	Não
deleteHashTagRequestBody	DeleteHashTagRequestBody	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteHashTag

Copy

let (apiResp, httpResp) = client.deleteHashTag(tenantId = "my-tenant-123", tag = "sports", deleteHashTagRequestBody = DeleteHashTagRequestBody())
if apiResp.isSome:
  let emptyResp = apiResp.get()

obterHashtags

Parâmetros

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

Resposta

Retorna: Option[GetHashTagsResponse]

Exemplo

Exemplo getHashTags

Copy

let (hashTagsOpt, httpResp) = client.getHashTags(tenantId = "my-tenant-123", page = 0.0)
if hashTagsOpt.isSome:
  let hashTags = hashTagsOpt.get()
  echo hashTags
else:
  echo "No hashtags found"

patchHashtag

Parâmetros

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

Resposta

Retorna: Option[UpdateHashTagResponse]

Exemplo

patchHashTag Exemplo

Copy

let updateBody = UpdateHashTagBody()
let (optResp, httpResp) = client.patchHashTag(
  tenantId = "my-tenant-123",
  tag = "news",
  updateHashTagBody = updateBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp
else:
  echo "No response"

excluirVotoModeração

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
voteId	string	Não
options	DeleteModerationVoteOptions	Não

Resposta

Retorna: Option[VoteDeleteResponse]

Exemplo

deleteModerationVote Exemplo

Copy

let (respOpt, httpResp) = client.deleteModerationVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  voteId = "vote-abc123",
  options = DeleteModerationVoteOptions()
)
if respOpt.isSome:
  let resp = respOpt.get()

obterComentariosApi

Parâmetros

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

Resposta

Retorna: Option[ModerationAPIGetCommentsResponse]

Exemplo

getApiComments Exemplo

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # further processing can be done with `resp`

obterStatusExportacaoApi

Parâmetros

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

Resposta

Retorna: Option[ModerationExportStatusResponse]

Exemplo

Exemplo getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # usar exportStatus conforme necessário

obterIdsApi

Parâmetros

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

Resposta

Retorna: Option[ModerationAPIGetCommentIdsResponse]

Exemplo

Exemplo getApiIds

Copy

let opts = GetApiIdsOptions()
let (maybeResponse, httpResponse) = client.getApiIds(tenantId = "my-tenant-123", options = opts)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  echo response

obterUsuariosBanidosDoComentario

Parâmetros

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

Resposta

Retorna: Option[GetBannedUsersFromCommentResponse]

Exemplo

Exemplo getBanUsersFromComment

Copy

let (response, httpResponse) = client.getBanUsersFromComment(tenantId = "my-tenant-001", commentId = "cmt-123456", sso = "")
if response.isSome:
  let banInfo = response.get()
  echo banInfo

obterStatusBanComentario

Parâmetros

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

Resposta

Retorna: Option[GetCommentBanStatusResponse]

Exemplo

getCommentBanStatus Exemplo

Copy

let (banStatusOpt, httpResp) = client.getCommentBanStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  sso = "")
if banStatusOpt.isSome:
  let banStatus = banStatusOpt.get()
  echo banStatus

obterFilhosComentario

Parâmetros

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

Resposta

Retorna: Option[ModerationAPIChildCommentsResponse]

Exemplo

Exemplo getCommentChildren

Copy

let (childRespOpt, httpResp) = client.getCommentChildren(tenantId = "my-tenant-123", commentId = "cmt-456789", sso = "")
if childRespOpt.isSome:
  let childResp = childRespOpt.get()
  echo childResp

obterContagem

Parâmetros

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

Resposta

Retorna: Option[ModerationAPICountCommentsResponse]

Exemplo

Exemplo getCount

Copy

let (countOpt, httpResponse) = client.getCount(tenantId = "my-tenant-123", options = GetCountOptions())
if countOpt.isSome:
  let count = countOpt.get()

obterContagens

Parâmetros

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

Resposta

Retorna: Option[GetBannedUsersCountResponse]

Exemplo

Exemplo getCounts

Copy

let (maybeCounts, httpRes) = client.getCounts(tenantId = "my-tenant-123", sso = "")
if maybeCounts.isSome:
  let counts = maybeCounts.get()
  echo counts
else:
  echo "No counts returned"

obterLogs

Parâmetros

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

Resposta

Retorna: Option[ModerationAPIGetLogsResponse]

Exemplo

Exemplo getLogs

Copy

let (logsOpt, httpRes) = client.getLogs(tenantId = "my-tenant-123", commentId = "cmt-789", sso = "")
if logsOpt.isSome:
  let logs = logsOpt.get()
  echo logs

obterInsigniasManuais

Parâmetros

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

Resposta

Retorna: Option[GetTenantManualBadgesResponse]

Exemplo

Exemplo getManualBadges

Copy

let (manualBadgesOpt, httpResponse) = client.getManualBadges(tenantId = "my-tenant-123", sso = "")
if manualBadgesOpt.isSome:
  let manualBadges = manualBadgesOpt.get()
  echo manualBadges

obterInsigniasManuaisParaUsuario

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

Resposta

Retorna: Option[GetUserManualBadgesResponse]

Exemplo

Exemplo getManualBadgesForUser

Copy

let (userBadgesOpt, httpResp) = client.getManualBadgesForUser(
  tenantId = "my-tenant-123",
  options = GetManualBadgesForUserOptions()
)
if userBadgesOpt.isSome:
  let badges = userBadgesOpt.get()
  echo badges

obterComentarioModeração

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
options	GetModerationCommentOptions	No

Resposta

Retorna: Option[ModerationAPICommentResponse]

Exemplo

Exemplo getModerationComment

Copy

let (maybeComment, httpResponse) = client.getModerationComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(GetModerationCommentOptions)
)
if maybeComment.isSome:
  let comment = maybeComment.get()
  echo comment

obterTextoComentarioModeração

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Resposta

Returns: Option[GetCommentTextResponse]

Exemplo

Exemplo getModerationCommentText

Copy

let (optResp, httpResp) = client.getModerationCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456abc",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

obterResumoPreBan

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	GetPreBanSummaryOptions	Não

Resposta

Retorna: Option[PreBanSummary]

Exemplo

Exemplo getPreBanSummary

Copy

let (preBanSummaryOpt, httpResponse) = client.getPreBanSummary(tenantId = "my-tenant-123", commentId = "cmt-456", options = GetPreBanSummaryOptions())
if preBanSummaryOpt.isSome:
  let summary = preBanSummaryOpt.get()

obterResumoBuscaComentarios

Parâmetros

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

Resposta

Retorna: Option[ModerationCommentSearchResponse]

Exemplo

getSearchCommentsSummary Exemplo

Copy

let (summaryOpt, httpResp) = client.getSearchCommentsSummary(
  tenantId = "my-tenant-123",
  options = GetSearchCommentsSummaryOptions()
)
if summaryOpt.isSome:
  let summary = summaryOpt.get()
  echo summary

obterPaginasBusca

Parâmetros

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

Resposta

Retorna: Option[ModerationPageSearchResponse]

Exemplo

Exemplo getSearchPages

Copy

let (searchResp, httpResp) = client.getSearchPages(
  tenantId = "my-tenant-123",
  options = GetSearchPagesOptions(
    page: 1,
    pageSize: 20,
    query: "spam"
  )
)
if searchResp.isSome:
  let resp = searchResp.get()

obterSitesBusca

Parâmetros

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

Resposta

Retorna: Option[ModerationSiteSearchResponse]

Exemplo

Exemplo getSearchSites

Copy

let (searchResult, httpResp) = client.getSearchSites(tenantId = "my-tenant-123", options = GetSearchSitesOptions())
if searchResult.isSome:
  let siteResp = searchResult.get()

obterSugestaoBusca

Parâmetros

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

Resposta

Retorna: Option[ModerationSuggestResponse]

Exemplo

Exemplo getSearchSuggest

Copy

let (suggestOpt, httpResp) = client.getSearchSuggest(
  tenantId = "my-tenant-123",
  options = GetSearchSuggestOptions(),
)
if suggestOpt.isSome:
  let suggest = suggestOpt.get()
  echo suggest

obterUsuariosBusca

Parâmetros

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

Resposta

Retorna: Option[ModerationUserSearchResponse]

Exemplo

Exemplo getSearchUsers

Copy

let (searchRes, httpRes) = client.getSearchUsers(tenantId = "my-tenant-123", options = default(GetSearchUsersOptions))
if searchRes.isSome:
  let data = searchRes.get()
  echo data

obterFatorConfianca

Parâmetros

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

Resposta

Retorna: Option[GetUserTrustFactorResponse]

Exemplo

Exemplo getTrustFactor

Copy

let (trustOpt, httpResp) = client.getTrustFactor(tenantId = "my-tenant-123", options = GetTrustFactorOptions())
if trustOpt.isSome:
  let trust = trustOpt.get()
  discard trust

obterPreferenciaBanUsuario

Parâmetros

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

Resposta

Retorna: Option[APIModerateGetUserBanPreferencesResponse]

Exemplo

Exemplo getUserBanPreference

Copy

let (maybePref, httpResp) = client.getUserBanPreference(tenantId = "my-tenant-123", sso = "")
if maybePref.isSome:
  let pref = maybePref.get()
  echo pref

obterPerfilInternoUsuario

Parâmetros

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

Resposta

Retorna: Option[GetUserInternalProfileResponse]

Exemplo

getUserInternalProfile Exemplo

Copy

let (profileOpt, httpResp) = client.getUserInternalProfile(
  tenantId = "my-tenant-123",
  options = GetUserInternalProfileOptions()
)
if profileOpt.isSome:
  let profile = profileOpt.get()

postAjustarVotosComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
adjustCommentVotesParams	AdjustCommentVotesParams	Não
options	PostAdjustCommentVotesOptions	Não

Resposta

Retorna: Option[AdjustVotesResponse]

Exemplo

postAdjustCommentVotes Exemplo

Copy

let (adjustRespOpt, httpResp) = client.postAdjustCommentVotes(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  adjustCommentVotesParams = AdjustCommentVotesParams(),
  options = PostAdjustCommentVotesOptions()
)
if adjustRespOpt.isSome:
  let adjustResp = adjustRespOpt.get()

postExportarApi

Parâmetros

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

Resposta

Retorna: Option[ModerationExportResponse]

Exemplo

Exemplo postApiExport

Copy

let (optExport, httpResp) = client.postApiExport(tenantId = "my-tenant-123", options = PostApiExportOptions())
if optExport.isSome:
  let export = optExport.get()
  echo export

postBanirUsuarioDoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	PostBanUserFromCommentOptions	Não

Resposta

Retorna: Option[BanUserFromCommentResult]

Exemplo

postBanUserFromComment Exemplo

Copy

let (banResult, httpResp) = client.postBanUserFromComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  options = PostBanUserFromCommentOptions()
)
if banResult.isSome:
  let result = banResult.get()
  echo result

postDesfazerBanUsuario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
banUserUndoParams	BanUserUndoParams	Não
sso	string = ""	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

postBanUserUndo Exemplo

Copy

let (apiResp, httpResp) = client.postBanUserUndo(
  tenantId = "my-tenant-123",
  banUserUndoParams = BanUserUndoParams(userId = "user-456"),
  sso = ""
)
if apiResp.isSome:
  let _ = apiResp.get()

postResumoPreBanEmLote

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
bulkPreBanParams	BulkPreBanParams	Não
options	PostBulkPreBanSummaryOptions	Não

Resposta

Retorna: Option[BulkPreBanSummary]

Exemplo

postBulkPreBanSummary Exemplo

Copy

let bulkParams = BulkPreBanParams(emailAddresses: @["spam@example.com"], ipAddresses: @["203.0.113.5"])
let opt = PostBulkPreBanSummaryOptions(dryRun: false, maxResults: 0)
let (summaryOpt, httpResp) = client.postBulkPreBanSummary(tenantId = "my-tenant-123", bulkPreBanParams = bulkParams, options = opt)
if summaryOpt.isSome:
  let _ = summaryOpt.get()

postComentariosPorIds

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentsByIdsParams	CommentsByIdsParams	No
sso	string = ""	No

Resposta

Retorna: Option[ModerationAPIChildCommentsResponse]

Exemplo

Exemplo postCommentsByIds

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # use resp conforme necessário

postDenunciarComentario

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	PostFlagCommentOptions	Não

Response

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo postFlagComment

Copy

let opts = PostFlagCommentOptions()
let (response, httpResponse) = client.postFlagComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = opts,
)
if response.isSome:
  let result = response.get()

postRemoverComentario

Parâmetros

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Resposta

Retorna: Option[PostRemoveCommentApiResponse]

Exemplo

postRemoveComment Exemplo

Copy

let (apiResponseOpt, httpResp) = client.postRemoveComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = PostRemoveCommentOptions()
)
if apiResponseOpt.isSome:
  let apiResponse = apiResponseOpt.get()

postRestaurarComentarioExcluido

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	PostRestoreDeletedCommentOptions	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo postRestoreDeletedComment

Copy

let (respOpt, httpResp) = client.postRestoreDeletedComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = default(PostRestoreDeletedCommentOptions)
)
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Comment restored"

postDefinirStatusAprovacaoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	PostSetCommentApprovalStatusOptions	Não

Resposta

Retorna: Option[SetCommentApprovedResponse]

Exemplo

Exemplo de postSetCommentApprovalStatus

Copy

let (approvedOpt, httpResp) = client.postSetCommentApprovalStatus(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  options = PostSetCommentApprovalStatusOptions()
)
if approvedOpt.isSome:
  let approved = approvedOpt.get()
  echo approved

postDefinirStatusRevisaoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentReviewStatusOptions	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

postSetCommentReviewStatus Exemplo

Copy

let (apiResp, httpResp) = client.postSetCommentReviewStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  options = PostSetCommentReviewStatusOptions()
)
if apiResp.isSome:
  let _ = apiResp.get()
  discard
else:
  discard

postDefinirStatusSpamComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	PostSetCommentSpamStatusOptions	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

postSetCommentSpamStatus Exemplo

Copy

let defaultOpts = PostSetCommentSpamStatusOptions()
let (maybeResp, httpResp) = client.postSetCommentSpamStatus(tenantId = "my-tenant-123", commentId = "cmt-456789", options = defaultOpts)
if maybeResp.isSome:
  let resp = maybeResp.get()

postDefinirTextoComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
setCommentTextParams	SetCommentTextParams	Não
options	PostSetCommentTextOptions	Não

Resposta

Retorna: Option[SetCommentTextResponse]

Exemplo

postSetCommentText Exemplo

Copy

let (responseOpt, httpResponse) = client.postSetCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  setCommentTextParams = SetCommentTextParams(),
  options = PostSetCommentTextOptions()
)
if responseOpt.isSome:
  let updatedComment = responseOpt.get()

postRemoverDenunciaComentario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
options	PostUnFlagCommentOptions	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

postUnFlagComment Exemplo

Copy

let (maybeResp, httpResp) = client.postUnFlagComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(PostUnFlagCommentOptions)
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

postVoto

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
options	PostVoteOptions	Não

Resposta

Retorna: Option[VoteResponse]

Exemplo

Exemplo postVote

Copy

let (voteOpt, httpResp) = client.postVote(
  tenantId = "my-tenant-123",
  commentId = "comment-789",
  options = default(PostVoteOptions)
)
if voteOpt.isSome:
  let vote = voteOpt.get()

putConcederInsignia

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
badgeId	string	Não
options	PutAwardBadgeOptions	Não

Resposta

Retorna: Option[AwardUserBadgeResponse]

Exemplo

putAwardBadge Exemplo

Copy

let (response, httpResponse) = client.putAwardBadge(
  tenantId = "my-tenant-123",
  badgeId = "gold-badge",
  options = PutAwardBadgeOptions()
)
if response.isSome:
  let award = response.get()

putFecharThread

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
sso	string = ""	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo putCloseThread

Copy

let (respOpt, httpResp) = client.putCloseThread(tenantId = "my-tenant-123", urlId = "news/fastcomments-integration", sso = "")
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Thread successfully closed"

putRemoverInsignia

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
badgeId	string	Não
options	PutRemoveBadgeOptions	Não

Resposta

Retorna: Option[RemoveUserBadgeResponse]

Exemplo

putRemoveBadge Exemplo

Copy

let (maybeResp, httpResp) = client.putRemoveBadge(
  tenantId = "my-tenant-123",
  badgeId = "badge-456",
  options = PutRemoveBadgeOptions()
)
if maybeResp.isSome:
  let badgeResp = maybeResp.get()

putReabrirThread

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
sso	string = ""	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

putReopenThread Exemplo

Copy

let (apiRespOpt, httpResp) = client.putReopenThread(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  sso = ""
)
if apiRespOpt.isSome:
  let emptyResp = apiRespOpt.get()
  discard

definirFatorConfianca

Parâmetros

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

Resposta

Retorna: Option[SetUserTrustFactorResponse]

Exemplo

Exemplo setTrustFactor

Copy

let opts = SetTrustFactorOptions(userId = "user-456", trustFactor = 5, reason = "spam detection")
let (trustResponse, httpResponse) = client.setTrustFactor(tenantId = "my-tenant-123", options = opts)
if trustResponse.isSome:
  let result = trustResponse.get()

criarModerador

Parâmetros

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

Resposta

Retorna: Option[CreateModeratorResponse]

Exemplo

createModerator Exemplo

Copy

let (moderatorRes, httpResp) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = CreateModeratorBody())
if moderatorRes.isSome:
  let moderator = moderatorRes.get()

excluirModerador

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteModerator

Copy

let (apiResp, httpResp) = client.deleteModerator(
  tenantId = "my-tenant-123",
  id = "mod-789",
  sendEmail = "admin@mydomain.com",
)
if apiResp.isSome:
  let empty = apiResp.get()
  echo "Moderator removed"

obterModerador

Parâmetros

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

Resposta

Retorna: Option[GetModeratorResponse]

Exemplo

Exemplo getModerator

Copy

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

obterModeradores

Parâmetros

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

Resposta

Retorna: Option[GetModeratorsResponse]

Exemplo

Exemplo getModerators

Copy

let (moderatorsOpt, httpResp) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if moderatorsOpt.isSome:
  let moderators = moderatorsOpt.get()
  echo moderators

atualizarModerador

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de updateModerator

Copy

let body = UpdateModeratorBody(name = "John Doe", email = "john@example.com", isActive = true)
let (apiResult, httpResp) = client.updateModerator(tenantId = "my-tenant-123", id = "mod-456", updateModeratorBody = body)
if apiResult.isSome:
  let result = apiResult.get()

excluirContagemNotificacao

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteNotificationCount

Copy

let (apiRespOpt, httpResp) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if apiRespOpt.isSome:
  let _ = apiRespOpt.get()

obterContagemNotificacaoCache

Parâmetros

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

Resposta

Retorna: Option[GetCachedNotificationCountResponse]

Exemplo

Exemplo getCachedNotificationCount

Copy

let (cachedCountOpt, httpResp) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "article-456")
if cachedCountOpt.isSome:
  let cachedCount = cachedCountOpt.get()
  echo cachedCount

obterContagemNotificacao

Parâmetros

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

Resposta

Retorna: Option[GetNotificationCountResponse]

Exemplo

Exemplo getNotificationCount

Copy

let (notifOpt, httpResp) = client.getNotificationCount(tenantId = "my-tenant-123", options = GetNotificationCountOptions())
if notifOpt.isSome:
  let notif = notifOpt.get()
  echo notif

obterNotificacoes

Parâmetros

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

Resposta

Retorna: Option[GetNotificationsResponse]

Exemplo

Exemplo getNotifications

Copy

let (notifOpt, httpResp) = client.getNotifications(tenantId = "my-tenant-123", options = GetNotificationsOptions())
if notifOpt.isSome:
  let notifications = notifOpt.get()

atualizarNotificacao

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de updateNotification

Copy

let body = UpdateNotificationBody(message: "Your comment was approved", isRead: false)
let (optResp, httpResp) = client.updateNotification(
  tenantId = "my-tenant-123",
  id = "notif-789",
  updateNotificationBody = body,
  userId = "user-42"
)
if optResp.isSome:
  let _ = optResp.get()

criarReacaoPaginaV1

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
title	string = ""	Não

Resposta

Retorna: Option[CreateV1PageReact]

Exemplo

Exemplo createV1PageReact

Copy

let (pageOpt, httpResp) = client.createV1PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  title = "Breaking News: Nim Takes Over"
)
if pageOpt.isSome:
  let page = pageOpt.get()
  discard page
  discard httpResp

criarReacaoPaginaV2

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
id	string	Não
title	string = ""	Não

Resposta

Retorna: Option[CreateV1PageReact]

Exemplo

Exemplo createV2PageReact

Copy

let (pageResult, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "page-456",
  title = "Breaking News",
)
if pageResult.isSome:
  let page = pageResult.get()
  # use `page` conforme necessário

excluirReacaoPaginaV1

Parâmetros

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

Resposta

Retorna: Option[CreateV1PageReact]

Exemplo

Exemplo deleteV1PageReact

Copy

let (reactOpt, httpResp) = client.deleteV1PageReact(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactOpt.isSome:
  let react = reactOpt.get()

excluirReacaoPaginaV2

Parâmetros

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

Resposta

Retorna: Option[CreateV1PageReact]

Exemplo

Exemplo deleteV2PageReact

Copy

let (maybeReact, httpResp) = client.deleteV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "react-456",
)
if maybeReact.isSome:
  let react = maybeReact.get()
  echo react

obterCurtidasPaginaV1

Parâmetros

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

Resposta

Retorna: Option[GetV1PageLikes]

Exemplo

Exemplo getV1PageLikes

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # usar pageLikes conforme necessário

obterReacoesPaginaV2

Parâmetros

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

Resposta

Retorna: Option[GetV2PageReacts]

Exemplo

Exemplo getV2PageReacts

Copy

let (reactsOpt, httpResp) = client.getV2PageReacts(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactsOpt.isSome:
  let reacts = reactsOpt.get()
  echo reacts

obterUsuariosReacaoPaginaV2

Parâmetros

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

Resposta

Retorna: Option[GetV2PageReactUsersResponse]

Exemplo

getV2PageReactUsers Exemplo

Copy

let (maybeResponse, httpResponse) = client.getV2PageReactUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "user-456"
)
if maybeResponse.isSome:
  let resp = maybeResponse.get()
  echo resp

adicionarPagina

Parâmetros

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

Resposta

Retorna: Option[AddPageAPIResponse]

Exemplo

Exemplo addPage

Copy

let pageData = CreateAPIPageData(
  urlId = "news/article-2024",
  title = "Breaking News: Nim Takes Over",
  description = "An in-depth article about Nim's rise.",
  tags = @["nim", "programming", "news"]
)
let (addPageResp, httpResp) = client.addPage(
  tenantId = "my-tenant-123",
  createAPIPageData = pageData
)
if addPageResp.isSome:
  let resp = addPageResp.get()
  echo resp

excluirPagina

Parâmetros

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

Resposta

Retorna: Option[DeletePageAPIResponse]

Exemplo

Exemplo deletePage

Copy

let (deleteRespOpt, httpResp) = client.deletePage(tenantId = "my-tenant-123", id = "news/article-title")
if deleteRespOpt.isSome:
  let deleteResp = deleteRespOpt.get()
  discard deleteResp
discard httpResp

obterUsuariosOffline

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
options	GetOfflineUsersOptions	Não

Response

Retorna: Option[PageUsersOfflineResponse]

Example

Exemplo getOfflineUsers

Copy

let (offlineResp, httpResponse) = client.getOfflineUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetOfflineUsersOptions()
)
if offlineResp.isSome:
  let offline = offlineResp.get()
  echo offline)

obterUsuariosOnline

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
options	GetOnlineUsersOptions	No

Response

Returns: Option[PageUsersOnlineResponse]

Example

Exemplo getOnlineUsers

Copy

  
let opts = GetOnlineUsersOptions()  
let (onlineUsersOpt, httpResp) = client.getOnlineUsers(tenantId = "my-tenant-123", urlId = "news/article-title", options = opts)  
if onlineUsersOpt.isSome:  
  let onlineUsers = onlineUsersOpt.get()  
  echo onlineUsers  

obterPaginaPorIdURL

Parâmetros

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

Resposta

Retorna: Option[GetPageByURLIdAPIResponse]

Exemplo

Exemplo getPageByURLId

Copy

let (pageOpt, httpRes) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if pageOpt.isSome:
  let page = pageOpt.get()
  echo page

obterPaginas

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes

Resposta

Retorna: Option[GetPagesAPIResponse]

Exemplo

Exemplo getPages

Copy

let (pagesOpt, httpResp) = client.getPages(tenantId = "my-tenant-123")
if pagesOpt.isSome:
  let pages = pagesOpt.get()
  echo pages
else:
  echo "No pages returned"
echo httpResp

obterPaginasPublicas

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requer que enableFChat seja true na configuração customizada resolvida para cada página.
Páginas que requerem SSO são filtradas de acordo com o acesso ao grupo do usuário solicitante.

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetPagesPublicOptions	No

Response

Retorna: Option[GetPublicPagesResponse]

Example

Exemplo getPagesPublic

Copy

let (response, httpResponse) = client.getPagesPublic(tenantId = "my-tenant-123", options = GetPagesPublicOptions())
if response.isSome:
  let pages = response.get()
  echo pages

obterInfoUsuario

Informações de usuário em lote para um tenant. Dado userIds, retorna informações de exibição de User / SSOUser.
Usado pelo widget de comentários para enriquecer usuários que acabaram de aparecer via um evento de presença.
Sem contexto de página: a privacidade é aplicada uniformemente (perfis privados são mascarados).

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

Retorna: Option[PageUsersInfoResponse]

Example

Exemplo getUsersInfo

Copy

let (usersInfoOpt, httpResp) = client.getUsersInfo(tenantId = "my-tenant-123", ids = "user42")
if usersInfoOpt.isSome:
  let usersInfo = usersInfoOpt.get()

patchPagina

Parâmetros

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

Resposta

Retorna: Option[PatchPageAPIResponse]

Exemplo

Exemplo patchPage

Copy

let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/article-456",
  updateAPIPageData = UpdateAPIPageData(title = "Updated article title", description = "Revised description")
)
if response.isSome:
  let resp = response.get()

excluirEventoWebhookPendente

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

deletePendingWebhookEvent Exemplo

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "event-456")
if response.isSome:
  let empty = response.get()

obterContagemEventosWebhookPendentes

Parâmetros

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

Resposta

Retorna: Option[GetPendingWebhookEventCountResponse]

Exemplo

getPendingWebhookEventCount Exemplo

Copy

let (pendingCountOpt, httpResponse) = client.getPendingWebhookEventCount(tenantId = "my-tenant-123", options = GetPendingWebhookEventCountOptions())
if pendingCountOpt.isSome:
  let pendingCount = pendingCountOpt.get()
  echo pendingCount

obterEventosWebhookPendentes

Parâmetros

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

Resposta

Retorna: Option[GetPendingWebhookEventsResponse]

Exemplo

getPendingWebhookEvents Exemplo

Copy

let (maybeResp, httpResp) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  options = GetPendingWebhookEventsOptions()
)
if maybeResp.isSome:
  let resp = maybeResp.get()

criarConfiguracaoPergunta

Parâmetros

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

Resposta

Retorna: Option[CreateQuestionConfigResponse]

Exemplo

Exemplo de createQuestionConfig

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # use resp conforme necessário

excluirConfiguracaoPergunta

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteQuestionConfig

Copy

let (apiResult, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "question-config-456")
if apiResult.isSome:
  let empty = apiResult.get()

obterConfiguracaoPergunta

Parâmetros

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

Resposta

Retorna: Option[GetQuestionConfigResponse]

Exemplo

Exemplo de getQuestionConfig

Copy

let (questionConfigOpt, httpResp) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "question-987")
if questionConfigOpt.isSome:
  let config = questionConfigOpt.get()
  echo config

obterConfiguracoesPergunta

Parameters

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

Response

Retorna: Option[GetQuestionConfigsResponse]

Example

Exemplo getQuestionConfigs

Copy

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

atualizarConfiguracaoPergunta

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

updateQuestionConfig Exemplo

Copy

let (apiResp, httpResp) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if apiResp.isSome:
  let resp = apiResp.get()

criarResultadoPergunta

Parâmetros

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

Resposta

Retorna: Option[CreateQuestionResultResponse]

Exemplo

createQuestionResult Exemplo

Copy

let tenantId = "my-tenant-123"
let body = CreateQuestionResultBody()
let (optResult, httpResp) = client.createQuestionResult(tenantId = tenantId, createQuestionResultBody = body)
if optResult.isSome:
  let result = optResult.get()
  echo result

excluirResultadoPergunta

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteQuestionResult

Copy

let (maybeResult, httpResp) = client.deleteQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if maybeResult.isSome:
  let result = maybeResult.get()

obterResultadoPergunta

Parâmetros

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

Resposta

Retorna: Option[GetQuestionResultResponse]

Exemplo

Exemplo getQuestionResult

Copy

let (optResult, httpResp) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if optResult.isSome:
  let result = optResult.get()
  discard result

obterResultadosPergunta

Parâmetros

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

Resposta

Retorna: Option[GetQuestionResultsResponse]

Exemplo

Exemplo getQuestionResults

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  options = GetQuestionResultsOptions()
)
if response.isSome:
  let results = response.get()
  echo results

atualizarResultadoPergunta

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de updateQuestionResult

Copy

let (optResp, httpResp) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody()
)
if optResp.isSome:
  let resp = optResp.get()

agregarResultadosPergunta

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Yes
options	AggregateQuestionResultsOptions	No

Resposta

Retorna: Option[AggregateQuestionResultsResponse]

Exemplo

aggregateQuestionResults Exemplo

Copy

let opts = AggregateQuestionResultsOptions()
let (aggResultOpt, httpResp) = client.aggregateQuestionResults(tenantId = "my-tenant-123", options = opts)
if aggResultOpt.isSome:
  let aggResult = aggResultOpt.get()

agregarResultadosPerguntaEmLote

Parâmetros

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

Resposta

Retorna: Option[BulkAggregateQuestionResultsResponse]

Exemplo

bulkAggregateQuestionResults Exemplo

Copy

let request = BulkAggregateQuestionResultsRequest()
let (maybeResult, httpResp) = client.bulkAggregateQuestionResults(
  tenantId = "my-tenant-123",
  bulkAggregateQuestionResultsRequest = request,
  forceRecalculate = false)
if maybeResult.isSome:
  let result = maybeResult.get()

combinarComentariosComResultadosPergunta

Parâmetros

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

Resposta

Retorna: Option[CombineQuestionResultsWithCommentsResponse]

Exemplo

combineCommentsWithQuestionResults Exemplo

Copy

let (combineOpt, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  options = default(CombineCommentsWithQuestionResultsOptions)
)
if combineOpt.isSome:
  let combineResult = combineOpt.get()

adicionarUsuarioSSO

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	No

Resposta

Retorna: Option[AddSSOUserAPIResponse]

Exemplo

Exemplo addSSOUser

Copy

let (optResp, httpResp) = client.addSSOUser(tenantId = "my-tenant-123", createAPISSOUserData = CreateAPISSOUserData())
if optResp.isSome:
  let userResp = optResp.get()

excluirUsuarioSSO

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Resposta

Retorna: Option[DeleteSSOUserAPIResponse]

Exemplo

Exemplo deleteSSOUser

Copy

let (apiRespOpt, httpResp) = client.deleteSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteSSOUserOptions()
)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()

obterUsuarioSSOPorEmail

Parâmetros

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

Resposta

Retorna: Option[GetSSOUserByEmailAPIResponse]

Exemplo

Exemplo getSSOUserByEmail

Copy

let (optResp, httpResp) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "john.doe@example.com")
if optResp.isSome:
  let user = optResp.get()
  discard user

obterUsuarioSSOPorId

Parâmetros

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

Resposta

Retorna: Option[GetSSOUserByIdAPIResponse]

Exemplo

Exemplo getSSOUserById

Copy

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

obterUsuariosSSO

Parâmetros

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

Resposta

Retorna: Option[GetSSOUsersResponse]

Exemplo

Exemplo getSSOUsers

Copy

let (maybeResponse, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if maybeResponse.isSome:
  let users = maybeResponse.get()
  echo users
else:
  echo "No SSO users found"
echo httpResponse.statusCode

patchUsuarioSSO

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

patchSSOUser Exemplo

Copy

let updateData = UpdateAPISSOUserData()
let (responseOpt, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = updateData,
  updateComments = true)
if responseOpt.isSome:
  let response = responseOpt.get()
  echo response
echo httpResponse.statusCode

putUsuarioSSO

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 (apiRespOpt, httpResp) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = default(UpdateAPISSOUserData),
  updateComments = false)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()
  echo apiResp

criarAssinatura

Parâmetros

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

Resposta

Retorna: Option[CreateSubscriptionAPIResponse]

Exemplo

Exemplo createSubscription

Copy

let (respOpt, httpResp) = client.createSubscription(
  tenantId = "my-tenant-123",
  createAPIUserSubscriptionData = default(CreateAPIUserSubscriptionData),
)
if respOpt.isSome:
  let resp = respOpt.get()

excluirAssinatura

Parâmetros

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

Resposta

Retorna: Option[DeleteSubscriptionAPIResponse]

Exemplo

Exemplo deleteSubscription

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # use apiResult conforme necessário

obterAssinaturas

Parâmetros

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

Resposta

Retorna: Option[GetSubscriptionsAPIResponse]

Exemplo

Exemplo getSubscriptions

Copy

let (subscriptionsOpt, httpResp) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "user-456")
if subscriptionsOpt.isSome:
  let subscriptions = subscriptionsOpt.get()
  echo subscriptions

atualizarAssinatura

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Não
userId	string = ""	Não

Resposta

Retorna: Option[UpdateSubscriptionAPIResponse]

Exemplo

Exemplo de updateSubscription

Copy

let subscriptionData = UpdateAPIUserSubscriptionData(
  planId = "premium-plan",
  isActive = true,
  expiresAt = "2025-01-01",
)
let (responseOpt, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = subscriptionData,
  userId = "user-789",
)
if responseOpt.isSome:
  let subscriptionResult = responseOpt.get()

obterUsosDiariosInquilino

Parâmetros

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

Resposta

Retorna: Option[GetTenantDailyUsagesResponse]

Exemplo

Exemplo getTenantDailyUsages

Copy

let (respOpt, httpResp) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  options = default(GetTenantDailyUsagesOptions),
)
if respOpt.isSome:
  let usage = respOpt.get()
  echo usage
  echo httpResp.statusCode

criarPacoteInquilino

Parâmetros

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

Resposta

Retorna: Option[CreateTenantPackageResponse]

Exemplo

createTenantPackage Exemplo

Copy

let (responseOpt, httpResponse) = client.createTenantPackage(
  tenantId = "my-tenant-123",
  createTenantPackageBody = CreateTenantPackageBody()
)
if responseOpt.isSome:
  let response = responseOpt.get()

excluirPacoteInquilino

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteTenantPackage

Copy

let (apiResponse, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-456def")
if apiResponse.isSome:
  let emptyResponse = apiResponse.get()

obterPacoteInquilino

Parâmetros

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

Resposta

Retorna: Option[GetTenantPackageResponse]

Exemplo

Exemplo getTenantPackage

Copy

let (pkgOpt, httpResp) = client.getTenantPackage(tenantId = "my-tenant-123", id = "premium-plan")
if pkgOpt.isSome:
  let pkg = pkgOpt.get()
  echo pkg

obterPacotesInquilino

Parâmetros

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

Resposta

Retorna: Option[GetTenantPackagesResponse]

Exemplo

getTenantPackages Exemplo

Copy

let (maybeResp, httpResp) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if maybeResp.isSome:
  let packages = maybeResp.get()
  echo packages
  echo httpResp.statusCode

substituirPacoteInquilino

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo replaceTenantPackage

Copy

let (optResp, httpResp) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-456",
  replaceTenantPackageBody = ReplaceTenantPackageBody()
)
if optResp.isSome:
  let resp = optResp.get()
  discard resp

atualizarPacoteInquilino

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de updateTenantPackage

Copy

let body = UpdateTenantPackageBody()
let (optResp, httpResp) = client.updateTenantPackage(
  tenantId = "my-tenant-123",
  id = "premium-plan",
  updateTenantPackageBody = body
)
if optResp.isSome:
  let empty = optResp.get()

criarUsuarioInquilino

Parâmetros

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

Resposta

Retorna: Option[CreateTenantUserResponse]

Exemplo

Exemplo createTenantUser

Copy

let tenantId = "my-tenant-123"
let userBody = CreateTenantUserBody(
  email: "john.doe@example.com",
  name: "John Doe",
  password: "s3cr3tP@ss",
  role: "admin"
)
let (optResp, httpResp) = client.createTenantUser(
  tenantId = tenantId,
  createTenantUserBody = userBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp.userId

excluirUsuarioInquilino

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteTenantUser

Copy

let (response, httpResponse) = client.deleteTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteTenantUserOptions(),
)
if response.isSome:
  let empty = response.get()
  echo "User successfully deleted"

obterUsuarioInquilino

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Response

Retorna: Option[GetTenantUserResponse]

Example

Exemplo getTenantUser

Copy

let (maybeUser, httpResp) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-456")
if maybeUser.isSome:
  let user = maybeUser.get()
  echo user

obterUsuariosInquilino

Parâmetros

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

Resposta

Retorna: Option[GetTenantUsersResponse]

Exemplo

Exemplo getTenantUsers

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let data = response.get()
  echo data

substituirUsuarioInquilino

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Não
replaceTenantUserBody	ReplaceTenantUserBody	Não
updateComments	string = ""	Não

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

replaceTenantUser Exemplo

Copy

let replaceBody = ReplaceTenantUserBody()
let (response, httpResponse) = client.replaceTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  replaceTenantUserBody = replaceBody,
  updateComments = "")
if response.isSome:
  let empty = response.get()

enviarLinkLogin

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	No
redirectURL	string = ""	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo sendLoginLink

Copy

let (maybeResp, httpResp) = client.sendLoginLink(
  tenantId = "my-tenant-123",
  id = "user-456",
  redirectURL = "https://myapp.example.com/login-success"
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

atualizarUsuarioInquilino

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo updateTenantUser

Copy

let updateBody = UpdateTenantUserBody()
let (optResp, httpResp) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateTenantUserBody = updateBody,
  updateComments = "Changed role to moderator",
)
if optResp.isSome:
  let _ = optResp.get()

criarInquilino

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Resposta

Retorna: Option[CreateTenantResponse]

Exemplo

Exemplo createTenant

Copy

let (maybeResp, httpResp) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody())
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp
discard httpResp

excluirInquilino

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo deleteTenant

Copy

let (respOpt, httpResp) = client.deleteTenant(tenantId = "my-tenant-123", id = "tenant-to-delete", sure = "yes")
if respOpt.isSome:
  let emptyResp = respOpt.get()

obterInquilino

Parâmetros

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

Resposta

Retorna: Option[GetTenantResponse]

Exemplo

Exemplo getTenant

Copy

let (tenantResponse, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "config-001")
if tenantResponse.isSome:
  let tenant = tenantResponse.get()
  echo tenant

obterInquilinos

Parâmetros

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

Resposta

Retorna: Option[GetTenantsResponse]

Exemplo

getTenants Exemplo

Copy

let (maybeResp, httpResp) = client.getTenants(tenantId = "my-tenant-123", options = GetTenantsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

atualizarInquilino

Parâmetros

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

Resposta

Retorna: Option[APIEmptyResponse]

Exemplo

Exemplo de updateTenant

Copy

let updateBody = UpdateTenantBody(
  name: "My Tenant",
  description: "Tenant for news site",
  isActive: true,
  allowedDomains: @["example.com", "news.com"]
)
let (apiResp, httpResp) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = updateBody
)
if apiResp.isSome:
  let emptyResp = apiResp.get()

alterarEstadoTicket

Parâmetros

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

Resposta

Retorna: Option[ChangeTicketStateResponse]

Exemplo

Exemplo changeTicketState

Copy

let (optResp, httpResp) = client.changeTicketState(
  tenantId = "my-tenant-001",
  userId = "user-42",
  id = "ticket-12345",
  changeTicketStateBody = ChangeTicketStateBody(state = "closed")
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

criarTicket

Parâmetros

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

Resposta

Retorna: Option[CreateTicketResponse]

Exemplo

Exemplo createTicket

Copy

let tenantId = "my-tenant-123"
let userId = "user-456"
let ticketBody = CreateTicketBody()
let (responseOpt, httpResponse) = client.createTicket(tenantId = tenantId, userId = userId, createTicketBody = ticketBody)
if responseOpt.isSome:
  let ticketResponse = responseOpt.get()

obterTicket

Parâmetros

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

Resposta

Retorna: Option[GetTicketResponse]

Exemplo

Exemplo getTicket

Copy

let (ticketOpt, httpResp) = client.getTicket(tenantId = "my-tenant-123", id = "ticket-456", userId = "")
if ticketOpt.isSome:
  let ticket = ticketOpt.get()
  discard ticket

obterTickets

Parâmetros

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

Resposta

Retorna: Option[GetTicketsResponse]

Exemplo

Exemplo getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # use tickets conforme necessário

obterTraducoes

Parameters

Name	Type	Required
namespace	string	No
component	string	No
options	GetTranslationsOptions	No

Response

Returns: Option[GetTranslationsResponse]

Example

Exemplo getTranslations

Copy

let opts = GetTranslationsOptions()
let (maybeResp, httpResp) = client.getTranslations(namespace = "my-tenant-123", component = "news/article-title", options = opts)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

enviarImagem

Carregar e redimensionar uma imagem

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
file	string	Não
options	UploadImageOptions	Não

Resposta

Retorna: Option[UploadImageResponse]

Exemplo

uploadImage Exemplo

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # use o resultado conforme necessário

obterProgressoInsigniaUsuarioPorId

Parâmetros

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

Resposta

Retorna: Option[APIGetUserBadgeProgressResponse]

Exemplo

Exemplo getUserBadgeProgressById

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "badge-456")
if badgeProgressOpt.isSome:
  let badgeProgress = badgeProgressOpt.get()
  echo badgeProgress

obterProgressoInsigniaUsuarioPorUsuarioId

Parâmetros

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

Resposta

Retorna: Option[APIGetUserBadgeProgressResponse]

Exemplo

Exemplo getUserBadgeProgressByUserId

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if badgeProgressOpt.isSome:
  let progress = badgeProgressOpt.get()
  echo progress

obterListaProgressoInsigniaUsuario

Parâmetros

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

Resposta

Retorna: Option[APIGetUserBadgeProgressListResponse]

Exemplo

Exemplo getUserBadgeProgressList

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", options = GetUserBadgeProgressListOptions())
if response.isSome:
  let badgeProgress = response.get()

criarInsigniaUsuario

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	No

Resposta

Retorna: Option[APICreateUserBadgeResponse]

Exemplo

Exemplo createUserBadge

Copy

let (badgeRespOpt, httpResp) = client.createUserBadge(tenantId = "my-tenant-123", createUserBadgeParams = default(CreateUserBadgeParams))
if badgeRespOpt.isSome:
  let badgeResp = badgeRespOpt.get()

excluirInsigniaUsuario

Parâmetros

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

Resposta

Retorna: Option[APIEmptySuccessResponse]

Exemplo

deleteUserBadge Exemplo

Copy

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

obterInsigniaUsuario

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Resposta

Retorna: Option[APIGetUserBadgeResponse]

Exemplo

Exemplo getUserBadge

Copy

let (badgeOpt, httpResp) = client.getUserBadge(tenantId = "my-tenant-123", id = "user-789")
if badgeOpt.isSome:
  let badge = badgeOpt.get()
  echo badge
else:
  echo "No badge found"
echo httpResp.statusCode

obterInsigniasUsuario

Parâmetros

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

Resposta

Retorna: Option[APIGetUserBadgesResponse]

Exemplo

Exemplo getUserBadges

Copy

let opts = GetUserBadgesOptions()
let (badgesOpt, httpResp) = client.getUserBadges(tenantId = "my-tenant-123", options = opts)
if badgesOpt.isSome:
  let badges = badgesOpt.get()

atualizarInsigniaUsuario

Parâmetros

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

Resposta

Retorna: Option[APIEmptySuccessResponse]

Exemplo

Exemplo updateUserBadge

Copy

let params = UpdateUserBadgeParams()
let (maybeResp, httpResp) = client.updateUserBadge(tenantId = "my-tenant-123", id = "user-456", updateUserBadgeParams = params)
if maybeResp.isSome:
  let success = maybeResp.get()

obterContagemNotificacaoUsuario

Parâmetros

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

Resposta

Retorna: Option[GetUserNotificationCountResponse]

Exemplo

Exemplo getUserNotificationCount

Copy

let (optResp, httpResp) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

obterNotificacoesUsuario

Parâmetros

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

Resposta

Retorna: Option[GetMyNotificationsResponse]

Exemplo

Exemplo getUserNotifications

Copy

let (maybeResponse, httpResponse) = client.getUserNotifications(tenantId = "my-tenant-123", options = GetUserNotificationsOptions())
if maybeResponse.isSome:
  let notifications = maybeResponse.get()

resetarContagemNotificacaoUsuario

Parâmetros

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

Resposta

Retorna: Option[ResetUserNotificationsResponse]

Exemplo

Exemplo resetUserNotificationCount

Copy

let (resetRespOpt, httpResp) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "user-456")
if resetRespOpt.isSome:
  let resetResp = resetRespOpt.get()
  echo resetResp
else:
  echo "Reset notification count response not available"

resetarNotificacoesUsuario

Parâmetros

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

Resposta

Retorna: Option[ResetUserNotificationsResponse]

Exemplo

resetUserNotifications Exemplo

Copy

let (maybeResp, httpResp) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  options = ResetUserNotificationsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()

atualizarStatusAssinaturaComentarioNotificacaoUsuario

Ativar ou desativar notificações para um comentário específico.

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[UpdateUserNotificationCommentSubscriptionStatusResponse]

Exemplo

updateUserNotificationCommentSubscriptionStatus Exemplo

Copy

let (optResp, httpResp) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted-in",
  commentId = "comment-789",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()

atualizarStatusAssinaturaPaginaNotificacaoUsuario

Habilite ou desabilite notificações para uma página. Quando os usuários estão inscritos em uma página, notificações são criadas
para novos comentários principais, e também

Parâmetros

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Resposta

Retorna: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Exemplo

updateUserNotificationPageSubscriptionStatus Exemplo

Copy

let (optResp, httpResp) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  url = "https://example.com/news/article-456",
  pageTitle = "Breaking News: Something Happened",
  subscribedOrUnsubscribed = "subscribed",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  # processamento adicional com resp

atualizarStatusNotificacaoUsuario

Parâmetros

Name	Type	Required
tenantId	string	Yes
notificationId	string	No
newStatus	string	No
sso	string = ""	No

Resposta

Retorna: Option[UpdateUserNotificationStatusResponse]

Exemplo

Exemplo de updateUserNotificationStatus

Copy

let (respOpt, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = ""
)
if respOpt.isSome:
  let status = respOpt.get()

obterStatusPresencaUsuario

Parâmetros

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

Resposta

Retorna: Option[GetUserPresenceStatusesResponse]

Exemplo

Exemplo getUserPresenceStatuses

Copy

let (presenceOpt, httpResp) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user42")
if presenceOpt.isSome:
  let presence = presenceOpt.get()

buscarUsuarios

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
options	SearchUsersOptions	Não

Resposta

Retorna: Option[SearchUsersResult]

Exemplo

Exemplo de searchUsers

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = SearchUsersOptions()
)
if response.isSome:
  let result = response.get()

obterUsuario

Parâmetros

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

Resposta

Retorna: Option[GetUserResponse]

Exemplo

Exemplo getUser

Copy

let (userOpt, httpResp) = client.getUser(tenantId = "my-tenant-123", id = "user-456")
if userOpt.isSome:
  let user = userOpt.get()
  echo user
else:
  echo "User not found"

criarVoto

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Resposta

Retorna: Option[VoteResponse]

Exemplo

createVote Exemplo

Copy

let (voteOpt, httpResp) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  direction = "up",
  options = CreateVoteOptions()
)
if voteOpt.isSome:
  let vote = voteOpt.get()
  echo vote

excluirVoto

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	No
editKey	string = ""	No

Resposta

Retorna: Option[VoteDeleteResponse]

Exemplo

Exemplo deleteVote

Copy

let (voteRespOpt, httpResp) = client.deleteVote(tenantId = "my-tenant-123", id = "comment-456", editKey = "")
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()
  discard voteResp
  discard httpResp

obterVotos

Parâmetros

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

Resposta

Retorna: Option[GetVotesResponse]

Exemplo

Exemplo getVotes

Copy

let (optVotes, httpResp) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/article-42")
if optVotes.isSome:
  let votes = optVotes.get()
  discard votes

obterVotosParaUsuario

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
options	GetVotesForUserOptions	Não

Resposta

Retorna: Option[GetVotesForUserResponse]

Exemplo

Exemplo getVotesForUser

Copy

let (optResp, httpResp) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetVotesForUserOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

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

Começando

Referência da API

Uso

Agregado

Logs de auditoria

Autenticação

Bloquear a partir do comentário

Verificar comentários bloqueados

Comentários

Comentários para usuário

Configurações de domínio

Modelos de email

Log de eventos

Publicações no feed

Denunciar comentário

GIFs

Hashtags

Moderação

Moderadores

Contagem de notificações

Notificações

Reações de página

Páginas

Eventos de webhook pendentes

Configurações de pergunta

Resultados de pergunta

Agregação de resultados de pergunta

Usuários SSO

Assinaturas

Uso diário do inquilino

Pacotes de inquilino

Usuários de inquilino

Inquilinos

Tickets

Traduções

Upload de imagem

Progresso de insignia do usuário

Insígnias de usuário

Notificações do usuário

Status de presença do usuário

Busca de usuários

Usuários

Votos

FastComments Nim SDK

Repositório

Agentes de codificação IA

Requisitos

Instalação

Usando Nimble

Compilando a partir do código-fonte

Conteúdo da Biblioteca

APIs Públicas vs Seguras

Início rápido

Usando APIs Autenticadas (DefaultAPI)

Usando APIs Públicas (PublicAPI)

Usando APIs de Moderação (ModerationAPI)

Problemas Comuns

Fazendo chamadas de API

Exemplo: Obtendo Comentários

Notas

IDs de Broadcast

SSO (Login Único)

Uso de SSO

SSO Simples

SSO Seguro

Documentação para fastcomments

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

agregado

Parâmetros

Resposta

Exemplo

obterLogsDeAuditoria

Parameters

Response

Exemplo