SDK de FastComments para Nim

Este es el SDK oficial de Nim para FastComments.

SDK oficial de Nim para la API de FastComments

Repositorio

Requisitos

Nim >= 1.6.0
nimcrypto >= 0.5.4

Instalación

Uso de Nimble

nimble install fastcomments

Compilando desde el código fuente

nimble build

Contenido de la biblioteca

Esta biblioteca contiene el cliente de la API generado y las utilidades SSO para facilitar el trabajo con la API.

Documentación de la biblioteca del cliente API

APIs públicas vs protegidas

Para el cliente de la API, hay tres módulos de API, api_default, api_public y api_moderation. El api_default contiene métodos que requieren tu clave de API, y api_public contiene llamadas a la API que se pueden realizar directamente desde un navegador/dispositivo móvil/etc. sin autenticación. El módulo api_moderation contiene métodos para el panel de moderación.

Los métodos de `api_moderation` abarcan el listado, el conteo, la búsqueda y la exportación de comentarios y sus registros; acciones de moderación como eliminar/restaurar comentarios, marcar, establecer el estado de revisión/spam/aprobación, ajustar votos y reabrir/cerrar hilos; prohibiciones (prohibir a un usuario de un comentario, deshacer una prohibición, resúmenes previos a la prohibición, estado y preferencias de la prohibición, y recuentos de usuarios prohibidos); e insignias y confianza (otorgar/quitar una insignia, listar insignias manuales, obtener/establecer el factor de confianza de un usuario, y obtener el perfil interno de un usuario). Cada método de `api_moderation` acepta un parámetro `sso` para que la llamada esté autenticada como moderador SSO.

Inicio rápido

Uso de las API autenticadas (DefaultAPI)

Importante: Los endpoints autenticados requieren que tu clave de API esté establecida como el encabezado 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"

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

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

Uso de las API públicas (PublicAPI)

Los endpoints públicos no requieren autenticación:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

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

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

Uso de las API de moderación (ModerationAPI)

Los endpoints de moderación alimentan el panel de moderación y se autentican con un token SSO para el moderador que actúa:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Listar comentarios en el panel de moderación
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Problemas comunes

Error 401 de autenticación: Asegúrate de establecer el encabezado x-api-key en tu HttpClient antes de realizar solicitudes a DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Clase de API incorrecta: Usa api_default para solicitudes autenticadas del lado del servidor, api_public para solicitudes del lado del cliente/públicas, y api_moderation para solicitudes del panel de moderación.

Realizar llamadas API

Todos los métodos de la API en este SDK devuelven tuplas de (Option[ResponseType], Response). El primer elemento contiene la respuesta analizada si tiene éxito, y el segundo elemento es la respuesta HTTP sin procesar.

Ejemplo: Obtener comentarios

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

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

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

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

Notas

IDs de transmisión

Verás que debes pasar un broadcastId en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, para que sepas ignorar el evento si planeas aplicar cambios optimistamente en el cliente (lo cual probablemente querrás hacer ya que ofrece la mejor experiencia). Pasa un UUID aquí. El ID debe ser lo suficientemente único como para no ocurrir dos veces en una sesión del navegador.

SSO (Inicio de sesión único)

Para ejemplos de SSO, consulta más abajo.

Uso de SSO

SSO simple

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

Documentación de fastcomments

Documentación de Endpoints de la API

Todas las URIs son relativas a https://fastcomments.com

Clase	Método	Solicitud HTTP	Descripción
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	Agrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones. Se admiten diferentes operaciones (por ejemplo, sum, countDistinct, avg, etc.).
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/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/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	Comentarios anteriores en la página de usuarios que NO están actualmente en línea. Ordenados por displayName. Usa esto después de agotar /users/online para mostrar una sección de "Miembros". Paginación de cursor sobre commenterName: el servidor recorre el índice parcial {tenantId, urlId, commenterName} desde afterName hacia adelante usando $gt, sin coste de $skip.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Visitantes actualmente en línea de una página: personas cuya sesión de websocket está suscrita a la página en este momento. Devuelve anonCount + totalCount (suscriptores generales de la sala, incluyendo visitantes anónimos que no enumeramos).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Lista las páginas de un inquilino. Utilizado por el cliente de escritorio FChat para poblar su lista de salas. Requiere que `enableFChat` sea true en la configuración personalizada resuelta para cada página. Las páginas que requieren SSO se filtran según el acceso de grupo del usuario solicitante.
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	Información de usuario por lotes para un inquilino. Dados userIds, devuelve la información de visualización de User / SSOUser. Usado por el widget de comentarios para mostrar información enriquecida de usuarios que acaban de aparecer mediante un evento de presencia. Sin contexto de página: la privacidad se aplica de forma uniforme (los perfiles privados están enmascarados).
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}	Habilitar o deshabilitar las notificaciones para un comentario específico.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Habilitar o deshabilitar las notificaciones para una página. Cuando los usuarios están suscritos a una página, se crean notificaciones para nuevos comentarios raíz, y también
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Subir y redimensionar una imagen
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentación de Modelos

aggregate

Agrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones. Se admiten distintas operaciones (p. ej. sum, countDistinct, avg, etc.).

Parámetros

Name	Type	Required
tenantId	string	Sí
aggregationRequest	AggregationRequest	No
parentTenantId	string	No
includeStats	bool	No

Respuesta

Devuelve: Option[AggregateResponse]

Ejemplo

Ejemplo de aggregate

Copy

let (response, httpResponse) = client.aggregate(
  tenantId = "my-tenant-123",
  aggregationRequest = AggregationRequest(groupBy = @["articleId"], metrics = @["commentCount"], filters = @[], limit = 0),
  parentTenantId = "",
  includeStats = false
)
if response.isSome:
  let agg = response.get()
  discard agg

getAuditLogs

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
limit	float64	No
skip	float64	No
order	SORTDIR	No
after	float64	No
before	float64	No

Respuesta

Devuelve: Option[GetAuditLogsResponse]

Ejemplo

Ejemplo de getAuditLogs

Copy

let (response, httpResponse) = client.getAuditLogs(
  tenantId = "my-tenant-123",
  limit = 50.0,
  skip = 0.0,
  order = SORTDIR.DESC,
  after = 1622505600.0,
  before = 1625097600.0
)
if response.isSome:
  let logs = response.get()
  echo logs
else:
  echo "No audit logs returned"

logoutPublic

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de logoutPublic

Copy

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

blockFromCommentPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string	No

Respuesta

Devuelve: Option[BlockSuccess]

Ejemplo

Ejemplo de blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parámetros

Name	Type	Requerido
tenantId	string	Sí
commentId	string	Sí
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string	No

Respuesta

Devuelve: Option[UnblockSuccess]

Ejemplo

Ejemplo de unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentIds	string	No
sso	string	No

Respuesta

Devuelve: Option[CheckBlockedCommentsResponse]

Ejemplo

Ejemplo de checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[BlockSuccess]

Ejemplo

Ejemplo de blockUserFromComment

Copy

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

createCommentPublic

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
broadcastId	string	No
commentData	CommentData	No
sessionId	string	No
sso	string	No

Respuesta

Devuelve: Option[SaveCommentsResponseWithPresence]

Ejemplo

Ejemplo de createCommentPublic

Copy

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

deleteComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
contextUserId	string	No
isLive	bool	No

Respuesta

Devuelve: Option[DeleteCommentResult]

Ejemplo

Ejemplo de deleteComment

Copy

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

deleteCommentPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
editKey	string	No
sso	string	No

Respuesta

Devuelve: Option[PublicAPIDeleteCommentResponse]

Ejemplo

Ejemplo de deleteCommentPublic

Copy

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

deleteCommentVote

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
voteId	string	No
urlId	string	Sí
broadcastId	string	No
editKey	string	No
sso	string	No

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo de deleteCommentVote

Copy

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

flagComment

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[FlagCommentResponse]

Ejemplo

Ejemplo de flagComment

Copy

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

getComment

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIGetCommentResponse]

Ejemplo

Ejemplo de getComment

Copy

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

getComments

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
page	int	No
limit	int	No
skip	int	No
asTree	bool	No
skipChildren	int	No
limitChildren	int	No
maxTreeDepth	int	No
urlId	string	Sí
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No
fromDate	int64	No
toDate	int64	No

Respuesta

Devuelve: Option[APIGetCommentsResponse]

Ejemplo

Ejemplo de getComments

Copy

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

getCommentsPublic

req tenantId urlId

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
page	int	No
direction	SortDirections	No
sso	string	No
skip	int	No
skipChildren	int	No
limit	int	No
limitChildren	int	No
countChildren	bool	No
fetchPageForCommentId	string	No
includeConfig	bool	No
countAll	bool	No
includei10n	bool	No
locale	string	No
modules	string	No
isCrawler	bool	No
includeNotificationCount	bool	No
asTree	bool	No
maxTreeDepth	int	No
useFullTranslationIds	bool	No
parentId	string	No
searchText	string	No
hashTags	seq[string]	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

Respuesta

Devuelve: Option[GetCommentsResponseWithPresencePublicComment]

Ejemplo

Ejemplo de getCommentsPublic

Copy

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

getCommentText

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
editKey	string	No
sso	string	No

Respuesta

Devuelve: Option[PublicAPIGetCommentTextResponse]

Ejemplo

Ejemplo de getCommentText

Copy

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

getCommentVoteUserNames

Parámetros

Name	Type	Required
tenantId	string	Sí
commentId	string	Sí
dir	int	No
sso	string	No

Respuesta

Devuelve: Option[GetCommentVoteUserNamesSuccessResponse]

Ejemplo

Ejemplo de getCommentVoteUserNames

Copy

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

lockComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de lockComment

Copy

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

pinComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[ChangeCommentPinStatusResponse]

Ejemplo

Ejemplo de pinComment

Copy

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

saveComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
createCommentParams	CreateCommentParams	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool	No

Respuesta

Devuelve: Option[APISaveCommentResponse]

Ejemplo

Ejemplo de saveComment

Copy

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

saveCommentsBulk

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
createCommentParams	seq[CreateCommentParams]	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de saveCommentsBulk

Copy

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

setCommentText

Parámetros

Name	Type	Requerido
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
editKey	string	No
sso	string	No

Respuesta

Devuelve: Option[PublicAPISetCommentTextResponse]

Ejemplo

Ejemplo de setCommentText

Copy

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

unBlockUserFromComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[UnblockSuccess]

Ejemplo

Ejemplo de unBlockUserFromComment

Copy

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

unFlagComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[FlagCommentResponse]

Ejemplo

Ejemplo de unFlagComment

Copy

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

unLockComment

Parámetros

Name	Type	Required
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de unLockComment

Copy

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

unPinComment

Parámetros

Name	Type	Required
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[ChangeCommentPinStatusResponse]

Ejemplo

Ejemplo de unPinComment

Copy

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

updateComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
updatableCommentParams	UpdatableCommentParams	No
contextUserId	string	No
doSpamCheck	bool	No
isLive	bool	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateComment

Copy

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

voteComment

Parámetros

Name	Type	Obligatorio
tenantId	string	Sí
commentId	string	Sí
urlId	string	Sí
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
sessionId	string	No
sso	string	No

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

Ejemplo de voteComment

Copy

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

getCommentsForUser

Parámetros

Nombre	Tipo	Requerido
userId	string	No
direction	SortDirections	No
repliesToUserId	string	No
page	float64	No
includei10n	bool	No
locale	string	No
isCrawler	bool	No

Respuesta

Devuelve: Option[GetCommentsForUserResponse]

Ejemplo

Ejemplo de getCommentsForUser

Copy

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

addDomainConfig

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
addDomainConfigParams	AddDomainConfigParams	No

Respuesta

Devuelve: Option[AddDomainConfigResponse]

Ejemplo

Ejemplo de addDomainConfig

Copy

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

deleteDomainConfig

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
domain	string	No

Respuesta

Devuelve: Option[DeleteDomainConfigResponse]

Ejemplo

Ejemplo de deleteDomainConfig

Copy

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

getDomainConfig

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
domain	string	No

Respuesta

Devuelve: Option[GetDomainConfigResponse]

Ejemplo

Ejemplo de getDomainConfig

Copy

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

getDomainConfigs

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: Option[GetDomainConfigsResponse]

Ejemplo

Ejemplo de getDomainConfigs

Copy

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

patchDomainConfig

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Respuesta

Devuelve: Option[PatchDomainConfigResponse]

Ejemplo

Ejemplo de patchDomainConfig

Copy

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

putDomainConfig

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Respuesta

Devuelve: Option[PutDomainConfigResponse]

Ejemplo

Ejemplo de putDomainConfig

Copy

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

createEmailTemplate

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createEmailTemplateBody	CreateEmailTemplateBody	No

Respuesta

Devuelve: Option[CreateEmailTemplateResponse]

Ejemplo

Ejemplo de createEmailTemplate

Copy

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

deleteEmailTemplate

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
errorId	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetEmailTemplateResponse]

Ejemplo

Ejemplo de getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: Option[GetEmailTemplateDefinitionsResponse]

Ejemplo

Ejemplo de getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
skip	float64	No

Respuesta

Devuelve: Option[GetEmailTemplateRenderErrorsResponse]

Ejemplo

Ejemplo de getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
skip	float64	No

Respuesta

Devuelve: Option[GetEmailTemplatesResponse]

Ejemplo

Ejemplo de getEmailTemplates

Copy

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

renderEmailTemplate

Parámetros

Name	Type	Required
tenantId	string	Sí
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string	No

Respuesta

Devuelve: Option[RenderEmailTemplateResponse]

Ejemplo

Ejemplo de renderEmailTemplate

Copy

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

updateEmailTemplate

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Respuesta

Devuelve: Option[GetEventLogResponse]

Ejemplo

Ejemplo de getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Respuesta

Devuelve: Option[GetEventLogResponse]

Ejemplo

Ejemplo de getGlobalEventLog

Copy

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

createFeedPost

Parámetros

Name	Type	Required
tenantId	string	Sí
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
isLive	bool	No
doSpamCheck	bool	No
skipDupCheck	bool	No

Respuesta

Devuelve: Option[CreateFeedPostsResponse]

Ejemplo

Ejemplo de createFeedPost

Copy

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

createFeedPostPublic

Parámetros

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[CreateFeedPostResponse]

Ejemplo

Ejemplo de createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
postId	string	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[DeleteFeedPostPublicResponse]

Ejemplo

Ejemplo de deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parámetros

Name	Type	Required
tenantId	string	Sí
afterId	string	No
limit	int	No
tags	seq[string]	No

Respuesta

Devuelve: Option[GetFeedPostsResponse]

Ejemplo

Ejemplo de getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
afterId	string	No
limit	int	No
tags	seq[string]	No
sso	string	No
isCrawler	bool	No
includeUserInfo	bool	No

Respuesta

Devuelve: Option[PublicFeedPostsResponse]

Ejemplo

Ejemplo de getFeedPostsPublic

Copy

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

getFeedPostsStats

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
postIds	seq[string]	No
sso	string	No

Respuesta

Devuelve: Option[FeedPostsStatsResponse]

Ejemplo

Ejemplo de getFeedPostsStats

Copy

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

getUserReactsPublic

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
postIds	seq[string]	No
sso	string	No

Respuesta

Devuelve: Option[UserReactsResponse]

Ejemplo

Ejemplo de getUserReactsPublic

Copy

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

reactFeedPostPublic

Parámetros

Name	Type	Obligatorio
tenantId	string	Sí
postId	string	No
reactBodyParams	ReactBodyParams	No
isUndo	bool	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[ReactFeedPostResponse]

Ejemplo

Ejemplo de reactFeedPostPublic

Copy

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

updateFeedPost

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
feedPost	FeedPost	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateFeedPost

Copy

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

updateFeedPostPublic

Parámetros

Name	Type	Required
tenantId	string	Sí
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[CreateFeedPostResponse]

Ejemplo

Ejemplo de updateFeedPostPublic

Copy

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

flagCommentPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
isFlagged	bool	No
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de flagCommentPublic

Copy

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

getGifLarge

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
largeInternalURLSanitized	string	No

Respuesta

Devuelve: Option[GifGetLargeResponse]

Ejemplo

Ejemplo de getGifLarge

Copy

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

getGifsSearch

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
search	string	No
locale	string	No
rating	string	No
page	float64	No

Respuesta

Devuelve: Option[GetGifsSearchResponse]

Ejemplo

Ejemplo de getGifsSearch

Copy

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

getGifsTrending

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
locale	string	No
rating	string	No
page	float64	No

Respuesta

Devuelve: Option[GetGifsTrendingResponse]

Ejemplo

Ejemplo de getGifsTrending

Copy

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

addHashTag

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createHashTagBody	CreateHashTagBody	No

Respuesta

Devuelve: Option[CreateHashTagResponse]

Ejemplo

Ejemplo de addHashTag

Copy

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

addHashTagsBulk

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Respuesta

Devuelve: Option[BulkCreateHashTagsResponse]

Ejemplo

Ejemplo de addHashTagsBulk

Copy

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

deleteHashTag

Parámetros

Name	Type	Obligatorio
tag	string	No
tenantId	string	Sí
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteHashTag

Copy

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

getHashTags

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
page	float64	No

Respuesta

Devuelve: Option[GetHashTagsResponse]

Ejemplo

Ejemplo de getHashTags

Copy

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

patchHashTag

Parámetros

Nombre	Tipo	Requerido
tag	string	No
tenantId	string	Sí
updateHashTagBody	UpdateHashTagBody	No

Respuesta

Devuelve: Option[UpdateHashTagResponse]

Ejemplo

Ejemplo de patchHashTag

Copy

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

deleteModerationVote

Parámetros

Nombre	Tipo	Obligatorio
commentId	string	Sí
voteId	string	No
sso	string	No

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo de deleteModerationVote

Copy

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

getApiComments

Parámetros

Nombre	Tipo	Obligatorio
page	float64	No
count	float64	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	bool	No
sso	string	No

Respuesta

Devuelve: Option[ModerationAPIGetCommentsResponse]

Ejemplo

Ejemplo de getApiComments

Copy

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

getApiExportStatus

Parámetros

Name	Type	Required	Description
batchJobId	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationExportStatusResponse]

Ejemplo

Ejemplo de getApiExportStatus

Copy

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

getApiIds

Parámetros

Name	Tipo	Requerido
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	bool	No
sso	string	No

Respuesta

Devuelve: Option[ModerationAPIGetCommentIdsResponse]

Ejemplo

Ejemplo de getApiIds

Copy

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

getBanUsersFromComment

Parámetros

Nombre	Tipo	Obligatorio	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[GetBannedUsersFromCommentResponse]

Ejemplo

Ejemplo de getBanUsersFromComment

Copy

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

getCommentBanStatus

Parámetros

Name	Type	Required	Description
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[GetCommentBanStatusResponse]

Ejemplo

Ejemplo de getCommentBanStatus

Copy

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

getCommentChildren

Parámetros

Nombre	Tipo	Requerido	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[ModerationAPIChildCommentsResponse]

Ejemplo

Ejemplo de getCommentChildren

Copy

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

getCount

Parámetros

Nombre	Tipo	Requerido
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	bool	No
sso	string	No

Respuesta

Devuelve: Option[ModerationAPICountCommentsResponse]

Ejemplo

Ejemplo de getCount

Copy

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

getCounts

Parámetros

Nombre	Tipo	Obligatorio	Descripción
sso	string	No

Respuesta

Devuelve: Option[GetBannedUsersCountResponse]

Ejemplo

Ejemplo de getCounts

Copy

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

getLogs

Parámetros

Nombre	Tipo	Requerido	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[ModerationAPIGetLogsResponse]

Ejemplo

Ejemplo de getLogs

Copy

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

getManualBadges

Parámetros

Nombre	Tipo	Requerido	Descripción
sso	string	No

Respuesta

Devuelve: Option[GetTenantManualBadgesResponse]

Ejemplo

Ejemplo de getManualBadges

Copy

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

getManualBadgesForUser

Parámetros

Nombre	Tipo	Obligatorio
badgesUserId	string	No
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[GetUserManualBadgesResponse]

Ejemplo

Ejemplo de getManualBadgesForUser

Copy

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

getModerationComment

Parámetros

Nombre	Tipo	Obligatorio
commentId	string	Sí
includeEmail	bool	No
includeIP	bool	No
sso	string	No

Respuesta

Devuelve: Option[ModerationAPICommentResponse]

Ejemplo

Ejemplo de getModerationComment

Copy

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

getModerationCommentText

Parámetros

Name	Type	Requerido	Description
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[GetCommentTextResponse]

Ejemplo

Ejemplo de getModerationCommentText

Copy

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

getPreBanSummary

Parámetros

Nombre	Tipo	Obligatorio
commentId	string	Sí
includeByUserIdAndEmail	bool	No
includeByIP	bool	No
includeByEmailDomain	bool	No
sso	string	No

Respuesta

Devuelve: Option[PreBanSummary]

Ejemplo

Ejemplo de getPreBanSummary

Copy

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

getSearchCommentsSummary

Parámetros

Nombre	Tipo	Requerido
value	string	No
filters	string	No
searchFilters	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationCommentSearchResponse]

Ejemplo

Ejemplo de getSearchCommentsSummary

Copy

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

getSearchPages

Parámetros

Nombre	Tipo	Obligatorio	Descripción
value	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationPageSearchResponse]

Ejemplo

Ejemplo de getSearchPages

Copy

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

getSearchSites

Parámetros

Nombre	Tipo	Requerido	Descripción
value	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationSiteSearchResponse]

Ejemplo

Ejemplo de getSearchSites

Copy

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

getSearchSuggest

Parámetros

Nombre	Tipo	Requerido	Descripción
textSearch	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationSuggestResponse]

Ejemplo

Ejemplo de getSearchSuggest

Copy

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

getSearchUsers

Parámetros

Nombre	Tipo	Obligatorio	Descripción
value	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationUserSearchResponse]

Ejemplo

Ejemplo de getSearchUsers

Copy

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

getTrustFactor

Parámetros

Nombre	Tipo	Obligatorio	Descripción
userId	string	No
sso	string	No

Respuesta

Devuelve: Option[GetUserTrustFactorResponse]

Ejemplo

Ejemplo de getTrustFactor

Copy

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

getUserBanPreference

Parámetros

Nombre	Tipo	Requerido	Descripción
sso	string	No

Respuesta

Devuelve: Option[APIModerateGetUserBanPreferencesResponse]

Ejemplo

Ejemplo de getUserBanPreference

Copy

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

getUserInternalProfile

Parámetros

Name	Type	Requerido	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[GetUserInternalProfileResponse]

Ejemplo

Ejemplo de getUserInternalProfile

Copy

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

postAdjustCommentVotes

Parámetros

Nombre	Tipo	Obligatorio
commentId	string	Sí
adjustCommentVotesParams	AdjustCommentVotesParams	No
sso	string	No

Respuesta

Devuelve: Option[AdjustVotesResponse]

Ejemplo

Ejemplo de postAdjustCommentVotes

Copy

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

postApiExport

Parámetros

Nombre	Tipo	Obligatorio
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
sso	string	No

Respuesta

Devuelve: Option[ModerationExportResponse]

Ejemplo

Ejemplo de postApiExport

Copy

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

postBanUserFromComment

Parámetros

Name	Type	Required
commentId	string	Sí
banEmail	bool	No
banEmailDomain	bool	No
banIP	bool	No
deleteAllUsersComments	bool	No
bannedUntil	string	No
isShadowBan	bool	No
updateId	string	No
banReason	string	No
sso	string	No

Respuesta

Devuelve: Option[BanUserFromCommentResult]

Ejemplo

Ejemplo de postBanUserFromComment

Copy

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

postBanUserUndo

Parámetros

Nombre	Tipo	Requerido	Descripción
banUserUndoParams	BanUserUndoParams	No
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postBanUserUndo

Copy

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

postBulkPreBanSummary

Parámetros

Nombre	Tipo	Obligatorio
bulkPreBanParams	BulkPreBanParams	No
includeByUserIdAndEmail	bool	No
includeByIP	bool	No
includeByEmailDomain	bool	No
sso	string	No

Respuesta

Devuelve: Option[BulkPreBanSummary]

Ejemplo

Ejemplo de postBulkPreBanSummary

Copy

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

postCommentsByIds

Parámetros

Nombre	Tipo	Obligatorio	Descripción
commentsByIdsParams	CommentsByIdsParams	No
sso	string	No

Respuesta

Devuelve: Option[ModerationAPIChildCommentsResponse]

Ejemplo

Ejemplo de postCommentsByIds

Copy

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

postFlagComment

Parámetros

Nombre	Tipo	Requerido	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postFlagComment

Copy

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

postRemoveComment

Parámetros

Nombre	Tipo	Requerido	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[PostRemoveCommentResponse]

Ejemplo

Ejemplo de postRemoveComment

Copy

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

postRestoreDeletedComment

Parámetros

Name	Type	Required	Description
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postRestoreDeletedComment

Copy

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

postSetCommentApprovalStatus

Parameters

Nombre	Tipo	Requerido
commentId	string	Sí
approved	bool	No
sso	string	No

Response

Devuelve: Option[SetCommentApprovedResponse]

Ejemplo

Ejemplo de postSetCommentApprovalStatus

Copy

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

postSetCommentReviewStatus

Parámetros

Name	Type	Required
commentId	string	Sí
reviewed	bool	No
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postSetCommentReviewStatus

Copy

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

postSetCommentSpamStatus

Parámetros

Name	Type	Required
commentId	string	Sí
spam	bool	No
permNotSpam	bool	No
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postSetCommentSpamStatus

Copy

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

postSetCommentText

Parámetros

Nombre	Tipo	Requerido
commentId	string	Sí
setCommentTextParams	SetCommentTextParams	No
sso	string	No

Respuesta

Devuelve: Option[SetCommentTextResponse]

Ejemplo

Ejemplo de postSetCommentText

Copy

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

postUnFlagComment

Parámetros

Nombre	Tipo	Requerido	Descripción
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postUnFlagComment

Copy

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

postVote

Parámetros

Nombre	Tipo	Obligatorio
commentId	string	Sí
direction	string	No
sso	string	No

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

Ejemplo de postVote

Copy

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

putAwardBadge

Parámetros

Nombre	Tipo	Obligatorio
badgeId	string	No
userId	string	No
commentId	string	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[AwardUserBadgeResponse]

Ejemplo

Ejemplo de putAwardBadge

Copy

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

putCloseThread

Parámetros

Nombre	Tipo	Requerido	Descripción
urlId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de putCloseThread

Copy

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

putRemoveBadge

Parámetros

Nombre	Tipo	Obligatorio
badgeId	string	No
userId	string	No
commentId	string	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[RemoveUserBadgeResponse]

Ejemplo

Ejemplo de putRemoveBadge

Copy

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

putReopenThread

Parámetros

Nombre	Tipo	Obligatorio	Descripción
urlId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de putReopenThread

Copy

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

setTrustFactor

Parámetros

Nombre	Tipo	Requerido
userId	string	No
trustFactor	string	No
sso	string	No

Respuesta

Devuelve: Option[SetUserTrustFactorResponse]

Ejemplo

Ejemplo de setTrustFactor

Copy

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

createModerator

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createModeratorBody	CreateModeratorBody	No

Respuesta

Devuelve: Option[CreateModeratorResponse]

Ejemplo

Ejemplo de createModerator

Copy

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

deleteModerator

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
sendEmail	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteModerator

Copy

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

getModerator

Parámetros

Name	Type	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetModeratorResponse]

Ejemplo

Ejemplo de getModerator

Copy

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

getModerators

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
skip	float64	No

Respuesta

Devuelve: Option[GetModeratorsResponse]

Ejemplo

Ejemplo de getModerators

Copy

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

updateModerator

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateModerator

Copy

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

deleteNotificationCount

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteNotificationCount

Copy

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

getCachedNotificationCount

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetCachedNotificationCountResponse]

Ejemplo

Ejemplo de getCachedNotificationCount

Copy

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

getNotificationCount

Parámetros

Name	Type	Requerido
tenantId	string	Sí
userId	string	No
urlId	string	Sí
fromCommentId	string	No
viewed	bool	No

Respuesta

Devuelve: Option[GetNotificationCountResponse]

Ejemplo

Ejemplo de getNotificationCount

Copy

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

getNotifications

Parámetros

Name	Type	Required
tenantId	string	Sí
userId	string	No
urlId	string	Sí
fromCommentId	string	No
viewed	bool	No
skip	float64	No

Respuesta

Devuelve: Option[GetNotificationsResponse]

Ejemplo

Ejemplo de getNotifications

Copy

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

updateNotification

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateNotification

Copy

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

createV1PageReact

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
title	string	No

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

Ejemplo de createV1PageReact

Copy

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

createV2PageReact

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
id	string	No
title	string	No

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

Ejemplo de createV2PageReact

Copy

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

deleteV1PageReact

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
urlId	string	Sí

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

Ejemplo de deleteV1PageReact

Copy

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

deleteV2PageReact

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
id	string	No

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

Ejemplo de deleteV2PageReact

Copy

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

getV1PageLikes

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
urlId	string	Sí

Respuesta

Devuelve: Option[GetV1PageLikes]

Ejemplo

Ejemplo getV1PageLikes

Copy

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

getV2PageReacts

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
urlId	string	Sí

Respuesta

Devuelve: Option[GetV2PageReacts]

Ejemplo

Ejemplo de getV2PageReacts

Copy

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

getV2PageReactUsers

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetV2PageReactUsersResponse]

Ejemplo

Ejemplo de getV2PageReactUsers

Copy

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

addPage

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createAPIPageData	CreateAPIPageData	No

Respuesta

Devuelve: Option[AddPageAPIResponse]

Ejemplo

Ejemplo de addPage

Copy

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

deletePage

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[DeletePageAPIResponse]

Ejemplo

Ejemplo de deletePage

Copy

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

getOfflineUsers

Comentaristas anteriores en la página que NO están actualmente en línea. Ordenados por displayName. Úselo después de agotar /users/online para mostrar una sección "Miembros". Paginación por cursor basada en commenterName: el servidor recorre la entrada parcial {tenantId, urlId, commenterName} index desde afterName hacia adelante vía $gt, sin coste de $skip.

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
afterName	string	No
afterUserId	string	No

Respuesta

Devuelve: Option[PageUsersOfflineResponse]

Ejemplo

Ejemplo de getOfflineUsers

Copy

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

getOnlineUsers

Actualmente en línea espectadores de una página: personas cuya sesión websocket está suscrita a la página en este momento. Devuelve anonCount + totalCount (suscriptores de toda la sala, incluidos los espectadores anónimos que no enumeramos).

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
afterName	string	No
afterUserId	string	No

Respuesta

Devuelve: Option[PageUsersOnlineResponse]

Ejemplo

Ejemplo de getOnlineUsers

Copy

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

getPageByURLId

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
urlId	string	Sí

Respuesta

Devuelve: Option[GetPageByURLIdAPIResponse]

Ejemplo

Ejemplo de getPageByURLId

Copy

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

getPages

Parámetros

Name	Type	Required	Description
tenantId	string	Sí

Respuesta

Devuelve: Option[GetPagesAPIResponse]

Ejemplo

Ejemplo de getPages

Copy

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

getPagesPublic

Lista páginas para un tenant. Usado por el cliente de escritorio FChat para poblar su lista de salas. Requiere enableFChat sea true en la configuración personalizada resuelta para cada página. Las páginas que requieren SSO se filtran según el acceso de grupo del usuario solicitante.

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
cursor	string	No
limit	int	No
q	string	No
sortBy	PagesSortBy	No
hasComments	bool	No

Respuesta

Devuelve: Option[GetPublicPagesResponse]

Ejemplo

Ejemplo de getPagesPublic

Copy

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

getUsersInfo

Información masiva de usuarios para un tenant. Dado userIds, devuelve la información de visualización de User / SSOUser. Utilizado por el widget de comentarios para enriquecer a los usuarios que acaban de aparecer mediante un evento de presencia. Sin contexto de página: la privacidad se aplica de forma uniforme (los perfiles privados están enmascarados).

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
ids	string	No

Respuesta

Devuelve: Option[PageUsersInfoResponse]

Ejemplo

Ejemplo de getUsersInfo

Copy

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

patchPage

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Respuesta

Devuelve: Option[PatchPageAPIResponse]

Ejemplo

Ejemplo de patchPage

Copy

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

deletePendingWebhookEvent

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deletePendingWebhookEvent

Copy

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

getPendingWebhookEventCount

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No

Respuesta

Devuelve: Option[GetPendingWebhookEventCountResponse]

Ejemplo

Ejemplo de getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parámetros

Name	Type	Required
tenantId	string	Sí
commentId	string	Sí
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No
skip	float64	No

Respuesta

Devuelve: Option[GetPendingWebhookEventsResponse]

Ejemplo

Ejemplo de getPendingWebhookEvents

Copy

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

createQuestionConfig

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createQuestionConfigBody	CreateQuestionConfigBody	No

Respuesta

Devuelve: Option[CreateQuestionConfigResponse]

Ejemplo

Ejemplo de createQuestionConfig

Copy

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

deleteQuestionConfig

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteQuestionConfig

Copy

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

getQuestionConfig

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetQuestionConfigResponse]

Ejemplo

Ejemplo de getQuestionConfig

Copy

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

getQuestionConfigs

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
skip	float64	No

Respuesta

Devuelve: Option[GetQuestionConfigsResponse]

Ejemplo

Ejemplo de getQuestionConfigs

Copy

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

updateQuestionConfig

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateQuestionConfig

Copy

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

createQuestionResult

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createQuestionResultBody	CreateQuestionResultBody	No

Respuesta

Devuelve: Option[CreateQuestionResultResponse]

Ejemplo

Ejemplo de createQuestionResult

Copy

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

deleteQuestionResult

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteQuestionResult

Copy

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

getQuestionResult

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetQuestionResultResponse]

Ejemplo

Ejemplo de getQuestionResult

Copy

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

getQuestionResults

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	float64	No

Respuesta

Devuelve: Option[GetQuestionResultsResponse]

Ejemplo

Ejemplo de getQuestionResults

Copy

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

updateQuestionResult

Parámetros

Name	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateQuestionResult

Copy

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

aggregateQuestionResults

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
questionId	string	No
questionIds	seq[string]	No
urlId	string	Sí
timeBucket	AggregateTimeBucket	No
startDate	string	No
forceRecalculate	bool	No

Respuesta

Devuelve: Option[AggregateQuestionResultsResponse]

Ejemplo

Ejemplo de aggregateQuestionResults

Copy

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

bulkAggregateQuestionResults

Parámetros

Name	Type	Required
tenantId	string	Sí
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Respuesta

Devuelve: Option[BulkAggregateQuestionResultsResponse]

Ejemplo

bulkAggregateQuestionResults Ejemplo

Copy

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

combineCommentsWithQuestionResults

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
questionId	string	No
questionIds	seq[string]	No
urlId	string	Sí
startDate	string	No
forceRecalculate	bool	No
minValue	float64	No
maxValue	float64	No
limit	float64	No

Respuesta

Devuelve: Option[CombineQuestionResultsWithCommentsResponse]

Ejemplo

Ejemplo de combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createAPISSOUserData	CreateAPISSOUserData	No

Respuesta

Devuelve: Option[AddSSOUserAPIResponse]

Ejemplo

Ejemplo de addSSOUser

Copy

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

deleteSSOUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
deleteComments	bool	No
commentDeleteMode	string	No

Respuesta

Devuelve: Option[DeleteSSOUserAPIResponse]

Ejemplo

Ejemplo de deleteSSOUser

Copy

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

getSSOUserByEmail

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
email	string	No

Respuesta

Devuelve: Option[GetSSOUserByEmailAPIResponse]

Ejemplo

Ejemplo de getSSOUserByEmail

Copy

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

getSSOUserById

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetSSOUserByIdAPIResponse]

Ejemplo

Ejemplo de getSSOUserById

Copy

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

getSSOUsers

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
skip	int	No

Respuesta

Devuelve: Option[GetSSOUsersResponse]

Ejemplo

Ejemplo de getSSOUsers

Copy

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

patchSSOUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Respuesta

Devuelve: Option[PatchSSOUserAPIResponse]

Ejemplo

Ejemplo de patchSSOUser

Copy

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

putSSOUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Respuesta

Devuelve: Option[PutSSOUserAPIResponse]

Ejemplo

Ejemplo de putSSOUser

Copy

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

createSubscription

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Respuesta

Devuelve: Option[CreateSubscriptionAPIResponse]

Ejemplo

Ejemplo de createSubscription

Copy

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

deleteSubscription

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
userId	string	No

Respuesta

Devuelve: Option[DeleteSubscriptionAPIResponse]

Ejemplo

Ejemplo de deleteSubscription

Copy

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

getSubscriptions

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
userId	string	No

Respuesta

Devuelve: Option[GetSubscriptionsAPIResponse]

Ejemplo

Ejemplo de getSubscriptions

Copy

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

updateSubscription

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string	No

Respuesta

Devuelve: Option[UpdateSubscriptionAPIResponse]

Ejemplo

Ejemplo de updateSubscription

Copy

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

getTenantDailyUsages

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
yearNumber	float64	No
monthNumber	float64	No
dayNumber	float64	No
skip	float64	No

Respuesta

Devuelve: Option[GetTenantDailyUsagesResponse]

Ejemplo

Ejemplo de getTenantDailyUsages

Copy

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

createTenantPackage

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createTenantPackageBody	CreateTenantPackageBody	No

Respuesta

Devuelve: Option[CreateTenantPackageResponse]

Ejemplo

Ejemplo de createTenantPackage

Copy

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

deleteTenantPackage

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteTenantPackage

Copy

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

getTenantPackage

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetTenantPackageResponse]

Ejemplo

Ejemplo de getTenantPackage

Copy

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

getTenantPackages

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
skip	float64	No

Respuesta

Devuelve: Option[GetTenantPackagesResponse]

Ejemplo

Ejemplo de getTenantPackages

Copy

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

replaceTenantPackage

Parámetros

Name	Type	Requerido
tenantId	string	Sí
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de replaceTenantPackage

Copy

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

updateTenantPackage

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateTenantPackage

Copy

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

createTenantUser

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createTenantUserBody	CreateTenantUserBody	No

Respuesta

Devuelve: Option[CreateTenantUserResponse]

Ejemplo

Ejemplo de createTenantUser

Copy

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

deleteTenantUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
deleteComments	string	No
commentDeleteMode	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteTenantUser

Copy

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

getTenantUser

Parámetros

Name	Type	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetTenantUserResponse]

Ejemplo

Ejemplo de getTenantUser

Copy

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

getTenantUsers

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
skip	float64	No

Respuesta

Devuelve: Option[GetTenantUsersResponse]

Ejemplo

Ejemplo de getTenantUsers

Copy

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

replaceTenantUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de replaceTenantUser

Copy

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

sendLoginLink

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
redirectURL	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de sendLoginLink

Copy

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

updateTenantUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateTenantUser

Copy

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

createTenant

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createTenantBody	CreateTenantBody	No

Respuesta

Devuelve: Option[CreateTenantResponse]

Ejemplo

Ejemplo de createTenant

Copy

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

deleteTenant

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
sure	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteTenant

Copy

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

getTenant

Parámetros

Name	Type	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetTenantResponse]

Ejemplo

Ejemplo de getTenant

Copy

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

getTenants

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
meta	string	No
skip	float64	No

Respuesta

Devuelve: Option[GetTenantsResponse]

Ejemplo

Ejemplo de getTenants

Copy

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

updateTenant

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
updateTenantBody	UpdateTenantBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateTenant

Copy

let (response, httpResponse) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "settings",
  updateTenantBody = UpdateTenantBody(
    name = "My Tenant 123",
    enableModeration = true,
    allowedDomains = @["news.example.com", "blog.example.org"],
    maxCommentLength = 1000
  )
)
if response.isSome:
  let apiResp = response.get()
  echo "Tenant updated successfully: ", apiResp
else:
  echo "Failed to update tenant, HTTP status: ", httpResponse.status

changeTicketState

Parámetros

Name	Type	Required
tenantId	string	Sí
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

Respuesta

Devuelve: Option[ChangeTicketStateResponse]

Ejemplo

Ejemplo de changeTicketState

Copy

let body = ChangeTicketStateBody()
let (response, httpResponse) = client.changeTicketState(tenantId = "my-tenant-123", userId = "user-456", id = "ticket-789", changeTicketStateBody = body)
if response.isSome:
  let ticketResp = response.get()
  echo "Ticket state changed:", ticketResp

createTicket

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
createTicketBody	CreateTicketBody	No

Respuesta

Devuelve: Option[CreateTicketResponse]

Ejemplo

Ejemplo de createTicket

Copy

let body = CreateTicketBody(
  subject = "Comment moderation issue",
  message = "Several abusive comments reported on article, please review and moderate.",
  tags = @["moderation", "abuse", "urgent"],
  url = "https://news.example.com/world/2026-election",
  priority = "high"
)
let (response, httpResponse) = client.createTicket(tenantId = "my-tenant-123", userId = "user-789", createTicketBody = body)
if response.isSome:
  let ticket = response.get()
  echo "Created ticket ID: ", ticket.id

getTicket

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
userId	string	No

Respuesta

Devuelve: Option[GetTicketResponse]

Ejemplo

Ejemplo de getTicket

Copy

let (response, httpResponse) = client.getTicket(tenantId = "my-tenant-123", id = "ticket-456", userId = "user-789")
if response.isSome:
  let ticket = response.get()
  echo "Got ticket:", ticket
else:
  echo "No ticket returned; HTTP response:", httpResponse

getTickets

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
state	float64	No
skip	float64	No
limit	float64	No

Respuesta

Devuelve: Option[GetTicketsResponse]

Ejemplo

Ejemplo de getTickets

Copy

let (response, httpResponse) = client.getTickets(tenantId = "my-tenant-123", userId = "user-789", state = 1.0, skip = 0.0, limit = 50.0)
if response.isSome:
  let tickets = response.get()
  echo tickets

getTranslations

Parámetros

Nombre	Tipo	Obligatorio
namespace	string	No
component	string	No
locale	string	No
useFullTranslationIds	bool	No

Respuesta

Devuelve: Option[GetTranslationsResponse]

Ejemplo

Ejemplo de getTranslations

Copy

let (response, httpResponse) = client.getTranslations(
  namespace = "news-site",
  component = "article-comments",
  locale = "en-US",
  useFullTranslationIds = false
)
if response.isSome:
  let translations = response.get()
  discard translations
else:
  echo "No translations available"

uploadImage

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
file	string	No
sizePreset	SizePreset	No
urlId	string	Sí

Respuesta

Devuelve: Option[UploadImageResponse]

Ejemplo

Ejemplo de uploadImage

Copy

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

getUserBadgeProgressById

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIGetUserBadgeProgressResponse]

Ejemplo

Ejemplo de getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
userId	string	No

Respuesta

Devuelve: Option[APIGetUserBadgeProgressResponse]

Ejemplo

Ejemplo de getUserBadgeProgressByUserId

Copy

let tenantId = "my-tenant-123"
let userId = "user-456"
let (response, httpResponse) = client.getUserBadgeProgressByUserId(tenantId = tenantId, userId = userId)
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress retrieved for ", userId
  discard badgeProgress

getUserBadgeProgressList

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
limit	float64	No
skip	float64	No

Respuesta

Devuelve: Option[APIGetUserBadgeProgressListResponse]

Ejemplo

Ejemplo de getUserBadgeProgressList

Copy

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

createUserBadge

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createUserBadgeParams	CreateUserBadgeParams	No

Respuesta

Devuelve: Option[APICreateUserBadgeResponse]

Ejemplo

Ejemplo de createUserBadge

Copy

let (response, httpResponse) = client.createUserBadge(
  tenantId = "my-tenant-123",
  createUserBadgeParams = CreateUserBadgeParams(
    userId = "user-456",
    badgeId = "top-commenter",
    reason = "Top commenter for June 2026",
    awardedBy = "mod-team",
    metadata = @["news","engagement"]
  )
)
if response.isSome:
  let badgeResp = response.get()
  discard badgeResp

deleteUserBadge

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIEmptySuccessResponse]

Ejemplo

Ejemplo de deleteUserBadge

Copy

let tenantId = "my-tenant-123"
let badgeId = "badge-456"
let (response, httpResponse) = client.deleteUserBadge(tenantId = tenantId, id = badgeId)
if response.isSome:
  let success = response.get()
  echo "Badge deleted successfully for tenant: ", tenantId, " id: ", badgeId
else:
  echo "Failed to delete badge. HTTP status: ", $httpResponse.status

getUserBadge

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[APIGetUserBadgeResponse]

Ejemplo

Ejemplo de getUserBadge

Copy

let (response, httpResponse) = client.getUserBadge(tenantId = "my-tenant-123", id = "badge-9876")
if response.isSome:
  let badge = response.get()
  echo "Fetched badge:"
  echo badge
else:
  echo "No badge found"
  echo httpResponse

getUserBadges

Parámetros

Name	Type	Required
tenantId	string	Sí
userId	string	No
badgeId	string	No
displayedOnComments	bool	No
limit	float64	No
skip	float64	No

Respuesta

Devuelve: Option[APIGetUserBadgesResponse]

Ejemplo

Ejemplo de getUserBadges

Copy

let (response, httpResponse) = client.getUserBadges(
  tenantId = "my-tenant-123",
  userId = "user-9876",
  badgeId = "top-commenter",
  displayedOnComments = true,
  limit = 20.0,
  skip = 0.0
)
if response.isSome:
  let badges = response.get()
  echo "Badges response:", badges
else:
  echo "No badges found (HTTP status: ", httpResponse.status, ")"

updateUserBadge

Parámetros

Name	Type	Requerido
tenantId	string	Sí
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Respuesta

Devuelve: Option[APIEmptySuccessResponse]

Ejemplo

Ejemplo de updateUserBadge

Copy

let (response, httpResponse) = client.updateUserBadge(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateUserBadgeParams = UpdateUserBadgeParams()
)
if response.isSome:
  let success = response.get()
  echo "Badge updated successfully"
else:
  echo "Badge update failed"

getUserNotificationCount

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[GetUserNotificationCountResponse]

Ejemplo

Ejemplo de getUserNotificationCount

Copy

let (response, httpResponse) = client.getUserNotificationCount(tenantId = "news-tenant-123", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLTI0NyIsImlhdCI6MTYw945600fQ.sflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
if response.isSome:
  let countResp = response.get()
  echo "Received user notification count response: ", countResp
else:
  echo "No notification count returned"

getUserNotifications

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
pageSize	int	No
afterId	string	No
includeContext	bool	No
afterCreatedAt	int64	No
unreadOnly	bool	No
dmOnly	bool	No
noDm	bool	No
includeTranslations	bool	No
includeTenantNotifications	bool	No
sso	string	No

Respuesta

Devuelve: Option[GetMyNotificationsResponse]

Ejemplo

Ejemplo de getUserNotifications

Copy

let (response, httpResponse) = client.getUserNotifications(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  pageSize = 0,
  afterId = "",
  includeContext = false,
  afterCreatedAt = 0,
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  includeTranslations = false,
  includeTenantNotifications = false,
  sso = ""
)
if response.isSome:
  let notifications = response.get()
  echo notifications

resetUserNotificationCount

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[ResetUserNotificationsResponse]

Ejemplo

Ejemplo de resetUserNotificationCount

Copy

let (response, httpResponse) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "user-sso-token-456")
if response.isSome:
  let result = response.get()
  echo "ResetUserNotificationsResponse:", result
else:
  echo "Reset failed, HTTP response:", httpResponse

resetUserNotifications

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
afterId	string	No
afterCreatedAt	int64	No
unreadOnly	bool	No
dmOnly	bool	No
noDm	bool	No
sso	string	No

Respuesta

Devuelve: Option[ResetUserNotificationsResponse]

Ejemplo

Ejemplo de resetUserNotifications

Copy

let (response, httpResponse) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  afterId = "",
  afterCreatedAt = 0'i64,
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  sso = ""
)
if response.isSome:
  let resetResp = response.get()
  echo "ResetUserNotificationsResponse received"
else:
  echo "No ResetUserNotificationsResponse"

updateUserNotificationCommentSubscriptionStatus

Habilitar o deshabilitar las notificaciones para un comentario específico.

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
notificationId	string	No
optedInOrOut	string	No
commentId	string	Sí
sso	string	No

Respuesta

Devuelve: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Ejemplo

Ejemplo de updateUserNotificationCommentSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "",
  optedInOrOut = "",
  commentId = "cmt-789",
  sso = ""
)
if response.isSome:
  let updateResp = response.get()
  echo "Subscription update response: ", updateResp

updateUserNotificationPageSubscriptionStatus

Habilita o deshabilita las notificaciones para una página. Cuando los usuarios están suscritos a una página, se crean notificaciones para nuevos comentarios raíz, y también

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string	No

Respuesta

Devuelve: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Ejemplo

Ejemplo de updateUserNotificationPageSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/economy/market-rally-2026-06-19",
  url = "",
  pageTitle = "",
  subscribedOrUnsubscribed = "",
  sso = ""
)
if response.isSome:
  let updateResp = response.get()
  echo "Subscription update received: ", updateResp
else:
  echo "No subscription update returned."

updateUserNotificationStatus

Parámetros

Name	Type	Required
tenantId	string	Sí
notificationId	string	No
newStatus	string	No
sso	string	No

Respuesta

Devuelve: Option[UpdateUserNotificationStatusResponse]

Ejemplo

Ejemplo de updateUserNotificationStatus

Copy

let (response, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = "sso-token-abc123"
)
if response.isSome:
  let updated = response.get()
  echo "Notification status updated successfully"
else:
  echo "No update response received"

getUserPresenceStatuses

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlIdWS	string	No
userIds	string	No

Respuesta

Devuelve: Option[GetUserPresenceStatusesResponse]

Ejemplo

getUserPresenceStatuses Ejemplo

Copy

let (response, httpResponse) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user-123,user-456")
if response.isSome:
  let presenceStatuses = response.get()
  echo presenceStatuses
else:
  echo "No presence data"

searchUsers

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
usernameStartsWith	string	No
mentionGroupIds	seq[string]	No
sso	string	No
searchSection	string	No

Respuesta

Devuelve: Option[SearchUsersResult]

Ejemplo

Ejemplo de searchUsers

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/top-story",
  usernameStartsWith = "",
  mentionGroupIds = @[],
  sso = "",
  searchSection = ""
)
if response.isSome:
  let searchResult = response.get()
  echo "SearchUsersResult:", searchResult
else:
  echo "No result or error. HTTP response:", httpResponse

getUser

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetUserResponse]

Ejemplo

Ejemplo de getUser

Copy

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

createVote

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
direction	string	No
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

Ejemplo de createVote

Copy

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

deleteVote

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
editKey	string	No

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo de deleteVote

Copy

let (response, httpResponse) = client.deleteVote(tenantId = "my-tenant-123", id = "vote-7f3b2a", editKey = "")
if response.isSome:
  let voteDelete = response.get()
  echo "Vote deleted successfully"
else:
  echo "Failed to delete vote"

getVotes

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
urlId	string	Sí

Respuesta

Devuelve: Option[GetVotesResponse]

Ejemplo

Ejemplo de getVotes

Copy

let (response, httpResponse) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/breaking-article-456")
if response.isSome:
  let votesResp = response.get()
  echo "Received votes response:", $votesResp
else:
  echo "No votes returned, HTTP response:", $httpResponse

getVotesForUser

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[GetVotesForUserResponse]

Ejemplo

Ejemplo de getVotesForUser

Copy

let (response, httpResponse) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userId = "user-789",
  anonUserId = ""
)
if response.isSome:
  let votes = response.get()
  echo "User votes retrieved"
else:
  echo "No votes found"

¿Necesitas ayuda?

Si encuentras algún problema o tienes preguntas sobre el Nim SDK, por favor:

Contribuciones

¡Las contribuciones son bienvenidas! Por favor visita el repositorio de GitHub para las directrices de contribución.

Idioma 🇪🇸 Español

Documentación

Primeros pasos

Referencia de API

Uso

Agregación

Registros de auditoría

Autenticación

Bloquear por comentario

Comprobar comentarios bloqueados

Comentarios

Comentarios del usuario

Configuraciones de dominio

Plantillas de correo

Registro de eventos

Publicaciones del feed

Marcar comentario

Gifs

Hashtags

Moderación

Moderadores

Recuento de notificaciones

Notificaciones

Reacciones de página

Páginas

Eventos webhook pendientes

Configuraciones de preguntas

Resultados de preguntas

Agregación de resultados de preguntas

Usuarios SSO

Suscripciones

Uso diario del inquilino

Paquetes del inquilino

Usuarios del inquilino

Inquilinos

Tickets

Traducciones

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones del usuario

Estado de presencia del usuario

Búsqueda de usuarios

Usuarios

Votos

SDK de FastComments para Nim

Repositorio

Requisitos

Instalación

Uso de Nimble

Compilando desde el código fuente

Contenido de la biblioteca

APIs públicas vs protegidas

Inicio rápido

Uso de las API autenticadas (DefaultAPI)

Uso de las API públicas (PublicAPI)

Uso de las API de moderación (ModerationAPI)

Problemas comunes

Realizar llamadas API

Ejemplo: Obtener comentarios

Notas

IDs de transmisión

SSO (Inicio de sesión único)

Uso de SSO

SSO simple

SSO seguro

Documentación de fastcomments

Documentación de Endpoints de la API

Documentación de Modelos

aggregate

Parámetros

Respuesta

Ejemplo

getAuditLogs

Parámetros

Respuesta

Ejemplo

logoutPublic

Respuesta

Ejemplo