FastComments Nim SDK

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

Compilar desde el código fuente

nimble build

Contenido de la biblioteca

Esta biblioteca contiene el cliente de 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 API, hay dos módulos de API, api_default y api_public. El api_default contiene métodos que requieren tu clave de API, y api_public contiene llamadas de API

que se pueden realizar directamente desde un navegador/dispositivo móvil/etc sin autenticación.

Inicio rápido

Uso de APIs autenticadas (DefaultAPI)

Importante: Los endpoints autenticados requieren que su clave API se establezca como la cabecera 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 APIs 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 públicas a la API
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  page = 0,
  direction = SortDirections.DESC,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 0,
  limitChildren = 0,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = false,
  countAll = false,
  includei10n = false,
  locale = "",
  modules = "",
  isCrawler = false,
  includeNotificationCount = false,
  asTree = false,
  maxTreeDepth = 0,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "",
  hashTags = @[],
  userId = "",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)

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

Problemas comunes

401 authentication error: Asegúrese de establecer la cabecera x-api-key en su HttpClient antes de realizar solicitudes a DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Clase de API incorrecta: Utilice api_default para solicitudes autenticadas en el lado del servidor, api_public para solicitudes del lado del cliente/públicas.

Realizar llamadas a la 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 para fastcomments

Documentación para Endpoints de la API

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

Clase	Método	Solicitud HTTP	Descripción
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Agrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones. Se admiten diferentes operaciones (p. ej., 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	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	requiere tenantId afterId
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsPublic	GET /comments/{tenantId}	requiere tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	requiere tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	requiere tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	requiere tenantId urlId userIdWS
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	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 para Modelos

Documentación para Autorización

api_key

Tipo: API key
Nombre del parámetro de la clave API: x-api-key
Ubicación: Cabecera HTTP

Agregar

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
aggregationRequest	AggregationRequest	No
parentTenantId	string	No
includeStats	bool	No

Respuesta

Devuelve: Option[AggregationResponse]

Ejemplo

Ejemplo de aggregate

Copy

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

Obtener registros de auditoría

Parámetros

Name	Type	Obligatorio
tenantId	string	Sí
limit	float64	No
skip	float64	No
order	SORTDIR	No
after	float64	No
before	float64	No

Respuesta

Devuelve: Option[GetAuditLogs_200_response]

Ejemplo

Ejemplo de getAuditLogs

Copy

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

Bloquear desde comentario público

Parámetros

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

Respuesta

Devuelve: Option[BlockFromCommentPublic_200_response]

Ejemplo

Ejemplo de blockFromCommentPublic

Copy

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

Desbloquear comentario público

Parámetros

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

Respuesta

Devuelve: Option[UnBlockCommentPublic_200_response]

Ejemplo

Ejemplo de unBlockCommentPublic

Copy

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

Comprobar comentarios bloqueados

Parámetros

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

Respuesta

Devuelve: Option[CheckedCommentsForBlocked_200_response]

Ejemplo

Ejemplo de checkedCommentsForBlocked

Copy

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

Bloquear usuario desde comentario

Parámetros

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

Respuesta

Devuelve: Option[BlockFromCommentPublic_200_response]

Ejemplo

Ejemplo de blockUserFromComment

Copy

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

Crear comentario público

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
broadcastId	string	No
commentData	CommentData	No
sessionId	string	No
sso	string	No

Respuesta

Devuelve: Option[CreateCommentPublic_200_response]

Ejemplo

Ejemplo de createCommentPublic

Copy

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

Eliminar comentario

Parámetros

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

Respuesta

Devuelve: Option[DeleteComment_200_response]

Ejemplo

Ejemplo de deleteComment

Copy

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

Eliminar comentario público

Parámetros

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

Respuesta

Devuelve: Option[DeleteCommentPublic_200_response]

Ejemplo

Ejemplo de deleteCommentPublic

Copy

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

Eliminar voto de comentario

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

Ejemplo

Ejemplo de deleteCommentVote

Copy

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

Marcar comentario

Parámetros

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

Respuesta

Devuelve: Option[FlagComment_200_response]

Ejemplo

Ejemplo de flagComment

Copy

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

Obtener comentario

Parámetros

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

Respuesta

Devuelve: Option[GetComment_200_response]

Ejemplo

Ejemplo de getComment

Copy

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

Obtener comentarios

Parámetros

Nombre	Tipo	Requerido
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

Respuesta

Devuelve: Option[GetComments_200_response]

Ejemplo

Ejemplo de getComments

Copy

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

Obtener comentarios públicos

Parámetros

Nombre	Tipo	Obligatorio
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[GetCommentsPublic_200_response]

Ejemplo

Ejemplo de getCommentsPublic

Copy

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

Obtener texto del comentario

Parámetros

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

Respuesta

Devuelve: Option[GetCommentText_200_response]

Ejemplo

Ejemplo de getCommentText

Copy

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

Obtener nombres de usuarios que votaron el comentario

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
dir	int	No
sso	string	No

Respuesta

Devuelve: Option[GetCommentVoteUserNames_200_response]

Ejemplo

Ejemplo de getCommentVoteUserNames

Copy

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

Bloquear comentario

Parámetros

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

Respuesta

Devuelve: Option[LockComment_200_response]

Ejemplo

Ejemplo de lockComment

Copy

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

Fijar comentario

Parámetros

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

Respuesta

Devuelve: Option[PinComment_200_response]

Ejemplo

Ejemplo de pinComment

Copy

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

Guardar comentario

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

Ejemplo

Ejemplo de saveComment

Copy

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

Guardar comentarios en bloque

Parámetros

Name	Type	Requerido
tenantId	string	Sí
createCommentParams	seq[CreateCommentParams]	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	No
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[UnBlockCommentPublic_200_response]

Ejemplo

Ejemplo de saveCommentsBulk

Copy

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

Establecer texto del comentario

Parámetros

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

Respuesta

Devuelve: Option[SetCommentText_200_response]

Ejemplo

Ejemplo de setCommentText

Copy

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

Desbloquear usuario desde comentario

Parámetros

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

Respuesta

Devuelve: Option[UnBlockCommentPublic_200_response]

Ejemplo

Ejemplo de unBlockUserFromComment

Copy

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

Quitar marca de comentario

Parámetros

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

Respuesta

Devuelve: Option[FlagComment_200_response]

Ejemplo

Ejemplo de unFlagComment

Copy

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

Desbloquear comentario

Parámetros

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

Respuesta

Devuelve: Option[LockComment_200_response]

Ejemplo

Ejemplo de unLockComment

Copy

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

Desfijar comentario

Parámetros

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

Respuesta

Devuelve: Option[PinComment_200_response]

Ejemplo

Ejemplo de unPinComment

Copy

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

Actualizar comentario

Parámetros

Name	Type	Obligatorio
tenantId	string	Sí
id	string	No
updatableCommentParams	UpdatableCommentParams	No
contextUserId	string	No
doSpamCheck	bool	No
isLive	bool	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateComment

Copy

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

Votar comentario

Parámetros

Nombre	Tipo	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[VoteComment_200_response]

Ejemplo

Ejemplo de voteComment

Copy

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

Agregar configuración de dominio

Parámetros

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

Respuesta

Devuelve: Option[AddDomainConfig_200_response]

Ejemplo

Ejemplo de addDomainConfig

Copy

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

Eliminar configuración de dominio

Parámetros

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

Respuesta

Devuelve: Option[DeleteDomainConfig_200_response]

Ejemplo

Ejemplo de deleteDomainConfig

Copy

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

Obtener configuración de dominio

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
domain	string	No

Respuesta

Devuelve: Option[GetDomainConfig_200_response]

Ejemplo

Ejemplo de getDomainConfig

Copy

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

Obtener configuraciones de dominio

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: Option[GetDomainConfigs_200_response]

Ejemplo

Ejemplo de getDomainConfigs

Copy

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

Actualizar parcialmente configuración de dominio

Parámetros

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

Respuesta

Devuelve: Option[GetDomainConfig_200_response]

Ejemplo

Ejemplo de patchDomainConfig

Copy

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

Reemplazar configuración de dominio

Parámetros

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

Respuesta

Devuelve: Option[GetDomainConfig_200_response]

Ejemplo

Ejemplo de putDomainConfig

Copy

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

Crear plantilla de correo electrónico

Parámetros

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

Respuesta

Devuelve: Option[CreateEmailTemplate_200_response]

Ejemplo

Ejemplo de createEmailTemplate

Copy

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

Eliminar plantilla de correo electrónico

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteEmailTemplate

Copy

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

Eliminar error de renderizado de plantilla de correo electrónico

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteEmailTemplateRenderError

Copy

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

Obtener plantilla de correo electrónico

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetEmailTemplate_200_response]

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()
  echo "Template ID: ", template.id
  echo "Subject: ", template.subject
  echo "Body: ", template.body

Obtener definiciones de plantillas de correo electrónico

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: Option[GetEmailTemplateDefinitions_200_response]

Ejemplo

Ejemplo de getEmailTemplateDefinitions

Copy

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

Obtener errores de renderizado de plantillas de correo electrónico

Parámetros

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

Respuesta

Devuelve: Option[GetEmailTemplateRenderErrors_200_response]

Ejemplo

Ejemplo de getEmailTemplateRenderErrors

Copy

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

Obtener plantillas de correo electrónico

Parámetros

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

Respuesta

Devuelve: Option[GetEmailTemplates_200_response]

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

Renderizar plantilla de correo electrónico

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string	No

Respuesta

Devuelve: Option[RenderEmailTemplate_200_response]

Ejemplo

Ejemplo de renderEmailTemplate

Copy

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

Actualizar plantilla de correo electrónico

Parámetros

Name	Type	Obligatorio
tenantId	string	Sí
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateEmailTemplate

Copy

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

Obtener registro de eventos

Parámetros

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

Respuesta

Devuelve: Option[GetEventLog_200_response]

Ejemplo

Ejemplo de getEventLog

Copy

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

Obtener registro de eventos global

Parámetros

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

Respuesta

Devuelve: Option[GetEventLog_200_response]

Ejemplo

Ejemplo de getGlobalEventLog

Copy

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

Crear publicación del feed

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
isLive	bool	No
doSpamCheck	bool	No
skipDupCheck	bool	No

Respuesta

Devuelve: Option[CreateFeedPost_200_response]

Ejemplo

Ejemplo de createFeedPost

Copy

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

Crear publicación del feed pública

Parámetros

Name	Tipo	Requerido
tenantId	string	Sí
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[CreateFeedPostPublic_200_response]

Ejemplo

Ejemplo de createFeedPostPublic

Copy

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

Eliminar publicación del feed pública

Parámetros

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

Respuesta

Devuelve: Option[DeleteFeedPostPublic_200_response]

Ejemplo

Ejemplo de deleteFeedPostPublic

Copy

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

Obtener publicaciones del feed

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
afterId	string	No
limit	int	No
tags	seq[string]	No

Respuesta

Devuelve: Option[GetFeedPosts_200_response]

Ejemplo

Ejemplo de getFeedPosts

Copy

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

Obtener publicaciones del feed públicas

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

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

Obtener estadísticas de publicaciones del feed

Parámetros

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

Respuesta

Devuelve: Option[GetFeedPostsStats_200_response]

Ejemplo

Ejemplo de getFeedPostsStats

Copy

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

Obtener reacciones públicas de usuarios

Parámetros

Name	Type	Requerido
tenantId	string	Sí
postIds	seq[string]	No
sso	string	No

Respuesta

Devuelve: Option[GetUserReactsPublic_200_response]

Ejemplo

Ejemplo de getUserReactsPublic

Copy

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

Reaccionar a publicación del feed pública

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
postId	string	No
reactBodyParams	ReactBodyParams	No
isUndo	bool	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: Option[ReactFeedPostPublic_200_response]

Ejemplo

Ejemplo de reactFeedPostPublic

Copy

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

Actualizar publicación del feed

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateFeedPost

Copy

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

Actualizar publicación del feed pública

Parámetros

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

Respuesta

Devuelve: Option[CreateFeedPostPublic_200_response]

Ejemplo

Ejemplo de updateFeedPostPublic

Copy

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

Marcar comentario público

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de flagCommentPublic

Copy

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

Agregar hashtag

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createHashTagBody	CreateHashTagBody	No

Respuesta

Devuelve: Option[AddHashTag_200_response]

Ejemplo

Ejemplo de addHashTag

Copy

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

Agregar hashtags en bloque

Parámetros

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

Respuesta

Devuelve: Option[AddHashTagsBulk_200_response]

Ejemplo

Ejemplo de addHashTagsBulk

Copy

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

Eliminar hashtag

Parámetros

Nombre	Tipo	Requerido
tag	string	No
tenantId	string	Sí
deleteHashTagRequest	DeleteHashTagRequest	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteHashTag

Copy

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

Obtener hashtags

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
page	float64	No

Respuesta

Devuelve: Option[GetHashTags_200_response]

Ejemplo

Ejemplo de getHashTags

Copy

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

Actualizar parcialmente hashtag

Parámetros

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

Respuesta

Devuelve: Option[PatchHashTag_200_response]

Ejemplo

Ejemplo de patchHashTag

Copy

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

Crear moderador

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createModeratorBody	CreateModeratorBody	No

Respuesta

Devuelve: Option[CreateModerator_200_response]

Ejemplo

Ejemplo de createModerator

Copy

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

Eliminar moderador

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteModerator

Copy

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

Obtener moderador

Parámetros

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

Respuesta

Devuelve: Option[GetModerator_200_response]

Ejemplo

Ejemplo de getModerator

Copy

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

Obtener moderadores

Parámetros

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

Respuesta

Devuelve: Option[GetModerators_200_response]

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 "Moderators fetched successfully"
  echo moderators

Actualizar moderador

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateModerator

Copy

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

Eliminar contador de notificaciones

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteNotificationCount

Copy

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

Obtener contador de notificaciones en caché

Parámetros

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

Respuesta

Devuelve: Option[GetCachedNotificationCount_200_response]

Ejemplo

Ejemplo de getCachedNotificationCount

Copy

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

Obtener contador de notificaciones

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
userId	string	No
urlId	string	Sí
fromCommentId	string	No
viewed	bool	No

Respuesta

Devuelve: Option[GetNotificationCount_200_response]

Ejemplo

Ejemplo de getNotificationCount

Copy

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

Obtener notificaciones

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
urlId	string	Sí
fromCommentId	string	No
viewed	bool	No
skip	float64	No

Respuesta

Devuelve: Option[GetNotifications_200_response]

Ejemplo

Ejemplo de getNotifications

Copy

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

Actualizar notificación

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateNotification

Copy

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

Agregar página

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

Eliminar página

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

Obtener página por ID de URL

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

Obtener páginas

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

Actualizar parcialmente página

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

Eliminar evento de webhook pendiente

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deletePendingWebhookEvent

Copy

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

Obtener contador de eventos de webhook pendientes

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

Ejemplo

Ejemplo de getPendingWebhookEventCount

Copy

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

Obtener eventos de webhook pendientes

Parámetros

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

Respuesta

Devuelve: Option[GetPendingWebhookEvents_200_response]

Ejemplo

Ejemplo de getPendingWebhookEvents

Copy

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

Crear configuración de pregunta

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createQuestionConfigBody	CreateQuestionConfigBody	No

Respuesta

Devuelve: Option[CreateQuestionConfig_200_response]

Ejemplo

Ejemplo de createQuestionConfig

Copy

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

Eliminar configuración de pregunta

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteQuestionConfig

Copy

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

Obtener configuración de pregunta

Parámetros

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

Respuesta

Devuelve: Option[GetQuestionConfig_200_response]

Ejemplo

Ejemplo de getQuestionConfig

Copy

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

Obtener configuraciones de preguntas

Parámetros

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

Respuesta

Devuelve: Option[GetQuestionConfigs_200_response]

Ejemplo

Ejemplo de getQuestionConfigs

Copy

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

Actualizar configuración de pregunta

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateQuestionConfig

Copy

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

Crear resultado de pregunta

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createQuestionResultBody	CreateQuestionResultBody	No

Respuesta

Devuelve: Option[CreateQuestionResult_200_response]

Ejemplo

Ejemplo de createQuestionResult

Copy

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

Eliminar resultado de pregunta

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteQuestionResult

Copy

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

Obtener resultado de pregunta

Parámetros

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

Respuesta

Devuelve: Option[GetQuestionResult_200_response]

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 "Received question result:"
  echo result
else:
  echo "No question result returned"

Obtener resultados de preguntas

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	float64	No

Respuesta

Devuelve: Option[GetQuestionResults_200_response]

Ejemplo

Ejemplo de getQuestionResults

Copy

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

Actualizar resultado de pregunta

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateQuestionResult

Copy

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

Agregar resultados de preguntas

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

Ejemplo

Ejemplo de aggregateQuestionResults

Copy

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

Agregar resultados de preguntas en bloque

Parámetros

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

Response

Devuelve: Option[BulkAggregateQuestionResults_200_response]

Ejemplo

Ejemplo de bulkAggregateQuestionResults

Copy

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

Combinar comentarios con resultados de preguntas

Parámetros

Nombre	Tipo	Obligatorio
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[CombineCommentsWithQuestionResults_200_response]

Ejemplo

Ejemplo de combineCommentsWithQuestionResults

Copy

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

Agregar usuario SSO

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

Eliminar usuario SSO

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

Obtener usuario SSO por correo electrónico

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

Obtener usuario SSO por ID

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

Obtener usuarios SSO

Parámetros

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

Respuesta

Devuelve: Option[GetSSOUsers_200_response]

Ejemplo

Ejemplo de getSSOUsers

Copy

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

Actualizar parcialmente usuario SSO

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

Reemplazar usuario SSO

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

Crear suscripción

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

Eliminar suscripción

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"

Obtener suscripciones

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

Obtener usos diarios del tenant

Parámetros

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

Respuesta

Devuelve: Option[GetTenantDailyUsages_200_response]

Ejemplo

Ejemplo de getTenantDailyUsages

Copy

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

Crear paquete del tenant

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createTenantPackageBody	CreateTenantPackageBody	No

Respuesta

Devuelve: Option[CreateTenantPackage_200_response]

Ejemplo

Ejemplo de createTenantPackage

Copy

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

Eliminar paquete del tenant

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteTenantPackage

Copy

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

Obtener paquete del tenant

Parámetros

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

Respuesta

Devuelve: Option[GetTenantPackage_200_response]

Ejemplo

Ejemplo de getTenantPackage

Copy

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

Obtener paquetes del tenant

Parámetros

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

Respuesta

Devuelve: Option[GetTenantPackages_200_response]

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 packages for tenant:", " my-tenant-123"
  echo packages
else:
  echo "No packages found, status:", httpResponse.status

Reemplazar paquete del tenant

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de replaceTenantPackage

Copy

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

Actualizar paquete del tenant

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateTenantPackage

Copy

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

Crear usuario del tenant

Parámetros

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

Respuesta

Devuelve: Option[CreateTenantUser_200_response]

Ejemplo

Ejemplo de createTenantUser

Copy

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

Eliminar usuario del tenant

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteTenantUser

Copy

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

Obtener usuario del tenant

Parámetros

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

Respuesta

Devuelve: Option[GetTenantUser_200_response]

Ejemplo

Ejemplo de getTenantUser

Copy

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

Obtener usuarios del tenant

Parámetros

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

Respuesta

Devuelve: Option[GetTenantUsers_200_response]

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 "Fetched tenant users for my-tenant-123"
  discard tenantUsers
else:
  echo "No users returned"
  discard httpResponse

Reemplazar usuario del tenant

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de replaceTenantUser

Copy

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

Enviar enlace de inicio de sesión

Parameters

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

Response

Devuelve: Option[FlagCommentPublic_200_response]

Example

Ejemplo de sendLoginLink

Copy

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

Actualizar usuario del tenant

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateTenantUser

Copy

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

Crear tenant

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createTenantBody	CreateTenantBody	No

Respuesta

Devuelve: Option[CreateTenant_200_response]

Ejemplo

Ejemplo de createTenant

Copy

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

Eliminar tenant

Parámetros

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

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de deleteTenant

Copy

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

Obtener tenant

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
id	string	No

Respuesta

Devuelve: Option[GetTenant_200_response]

Ejemplo

Ejemplo de getTenant

Copy

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

Obtener tenants

Parámetros

Name	Type	Requerido
tenantId	string	Sí
meta	string	No
skip	float64	No

Respuesta

Devuelve: Option[GetTenants_200_response]

Ejemplo

Ejemplo de getTenants

Copy

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

Actualizar tenant

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateTenantBody	UpdateTenantBody	No

Respuesta

Devuelve: Option[FlagCommentPublic_200_response]

Ejemplo

Ejemplo de updateTenant

Copy

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

Subir imagen

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

Obtener progreso de insignia de usuario por ID

Parámetros

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

Respuesta

Devuelve: Option[GetUserBadgeProgressById_200_response]

Ejemplo

Ejemplo de getUserBadgeProgressById

Copy

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

Obtener progreso de insignia de usuario por ID de usuario

Parámetros

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

Respuesta

Devuelve: Option[GetUserBadgeProgressById_200_response]

Ejemplo

Ejemplo de getUserBadgeProgressByUserId

Copy

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

Obtener lista de progreso de insignias de usuario

Parámetros

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

Respuesta

Devuelve: Option[GetUserBadgeProgressList_200_response]

Ejemplo

Ejemplo de getUserBadgeProgressList

Copy

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

Crear insignia de usuario

Parámetros

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

Respuesta

Devuelve: Option[CreateUserBadge_200_response]

Ejemplo

Ejemplo de createUserBadge

Copy

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

Eliminar insignia de usuario

Parámetros

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

Respuesta

Devuelve: Option[UpdateUserBadge_200_response]

Ejemplo

deleteUserBadge Ejemplo

Copy

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

Obtener insignia de usuario

Parámetros

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

Respuesta

Devuelve: Option[GetUserBadge_200_response]

Ejemplo

Ejemplo de getUserBadge

Copy

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

Obtener insignias de usuario

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

Ejemplo

Ejemplo de getUserBadges

Copy

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

Actualizar insignia de usuario

Parámetros

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

Respuesta

Devuelve: Option[UpdateUserBadge_200_response]

Ejemplo

Ejemplo de updateUserBadge

Copy

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

Obtener contador de notificaciones de usuario

Parámetros

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

Respuesta

Devuelve: Option[GetUserNotificationCount_200_response]

Ejemplo

Ejemplo de getUserNotificationCount

Copy

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

Obtener notificaciones de usuario

Parámetros

Nombre	Tipo	Obligatorio
tenantId	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
sso	string	No

Respuesta

Devuelve: Option[GetUserNotifications_200_response]

Ejemplo

Ejemplo de getUserNotifications

Copy

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

Restablecer contador de notificaciones de usuario

Parámetros

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

Respuesta

Devuelve: Option[ResetUserNotifications_200_response]

Ejemplo

Ejemplo de resetUserNotificationCount

Copy

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

Restablecer notificaciones de usuario

Parámetros

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

Respuesta

Devuelve: Option[ResetUserNotifications_200_response]

Ejemplo

Ejemplo de resetUserNotifications

Copy

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

Actualizar estado de suscripción a notificaciones de comentarios del usuario

Parámetros

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

Respuesta

Devuelve: Option[UpdateUserNotificationStatus_200_response]

Ejemplo

Ejemplo de updateUserNotificationCommentSubscriptionStatus

Copy

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

Actualizar estado de suscripción a notificaciones de página del usuario

Parámetros

Name	Type	Requerido
tenantId	string	Sí
urlId	string	Sí
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string	No

Respuesta

Devuelve: Option[UpdateUserNotificationStatus_200_response]

Ejemplo

Ejemplo de updateUserNotificationPageSubscriptionStatus

Copy

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

Actualizar estado de notificación de usuario

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
notificationId	string	No
newStatus	string	No
sso	string	No

Respuesta

Devuelve: Option[UpdateUserNotificationStatus_200_response]

Ejemplo

Ejemplo de updateUserNotificationStatus

Copy

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

Obtener estados de presencia de usuarios

Parameters

Name	Type	Required
tenantId	string	Sí
urlIdWS	string	No
userIds	string	No

Respuesta

Devuelve: Option[GetUserPresenceStatuses_200_response]

Ejemplo

Ejemplo de getUserPresenceStatuses

Copy

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

Buscar usuarios

Parámetros

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

Respuesta

Devuelve: Option[SearchUsers_200_response]

Ejemplo

Ejemplo de searchUsers

Copy

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

Obtener usuario

Parámetros

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

Respuesta

Devuelve: Option[GetUser_200_response]

Ejemplo

Ejemplo de getUser

Copy

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

Crear voto

Parámetros

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

Respuesta

Devuelve: Option[VoteComment_200_response]

Ejemplo

Ejemplo de createVote

Copy

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

Eliminar voto

Parámetros

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

Respuesta

Devuelve: Option[DeleteCommentVote_200_response]

Ejemplo

Ejemplo de deleteVote

Copy

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

Obtener votos

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
urlId	string	Sí

Respuesta

Devuelve: Option[GetVotes_200_response]

Ejemplo

Ejemplo de getVotes

Copy

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

Obtener votos del usuario

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: Option[GetVotesForUser_200_response]

Ejemplo

Ejemplo de getVotesForUser

Copy

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

¿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 la API

Uso

Agregación

Registros de auditoría

Bloquear desde comentario

Comprobar comentarios bloqueados

Comentarios

Configuraciones de dominio

Plantillas de correo electrónico

Registro de eventos

Publicaciones del feed

Marcar comentario

Hashtags

Moderadores

Contador de notificaciones

Notificaciones

Páginas

Eventos de webhook pendientes

Configuración de preguntas

Resultados de preguntas

Agregación de resultados de preguntas

Usuarios SSO

Suscripciones

Uso diario del tenant

Paquetes del tenant

Usuarios del tenant

Tenants

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones de usuario

Estado de presencia de usuario

Búsqueda de usuarios

Usuarios

Votos

FastComments Nim SDK

Repositorio

Requisitos

Instalación

Uso de Nimble

Compilar desde el código fuente

Contenido de la biblioteca

APIs públicas vs protegidas

que se pueden realizar directamente desde un navegador/dispositivo móvil/etc sin autenticación.

Inicio rápido

Uso de APIs autenticadas (DefaultAPI)

Uso de APIs públicas (PublicAPI)

Problemas comunes

Realizar llamadas a la 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 para fastcomments

Documentación para Endpoints de la API

Documentación para Modelos

Documentación para Autorización

api_key

Agregar

Parámetros

Respuesta

Ejemplo

Obtener registros de auditoría

Parámetros

Respuesta

Ejemplo

Bloquear desde comentario público

Parámetros

Respuesta

Ejemplo

Desbloquear comentario público

Parámetros

Respuesta