SDK de FastComments para Nim

Este es el SDK oficial de Nim para FastComments.

SDK oficial de Nim para la API de FastComments

Repositorio

Requisitos

Nim >= 1.6.0
nimcrypto >= 0.5.4

Instalación

Usando Nimble

nimble install fastcomments

Compilando desde el código fuente

nimble build

Contenido de la biblioteca

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

API Client Library Docs

APIs públicas vs seguras

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

El módulo api_moderation ofrece una amplia suite de APIs de moderación en tiempo real y rápidas. Cada método api_moderation acepta un parámetro sso y puede autenticarse mediante SSO o una cookie de sesión de FastComments.com.

Inicio rápido

Uso de APIs autenticadas (DefaultAPI)

Importante: Los puntos finales autenticados requieren que tu clave API se establezca en el encabezado x-api-key.

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

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

# Realizar llamadas a la API autenticada.
# Los parámetros requeridos (y el cuerpo de la solicitud) son posicionales; los opcionales
# los parámetros se pasan mediante el objeto de opciones de la operación.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Uso de APIs públicas (PublicAPI)

Los puntos finales públicos no requieren autenticación:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Realizar llamadas a la API pública.
# tenantId y urlId son requeridos (posicionales); todo lo demás es opcional.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Uso de APIs de moderación (ModerationAPI)

Los puntos finales de moderación impulsan el panel de moderador y se autentican con un token SSO para el moderador activo:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Listar comentarios en el panel de moderación.
# Esta operación no tiene parámetros requeridos, por lo que todo es opcional.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Problemas comunes

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

Realizar llamadas API

Todos los métodos 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 cruda.

Los parámetros obligatorios y el cuerpo de la solicitud se pasan posicionalmente. Los parámetros opcionales restantes se recopilan en un único objeto Api<Operation>Options, que es el último argumento. Las operaciones sin parámetros opcionales no usan objeto de opciones.

Ejemplo: Obtención de 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",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Notas

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

Documentation for API Endpoints

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

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

Documentation for Models

Documentation for Authorization

api_key

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

aggregate

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

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Respuesta

Devuelve: Option[AggregateResponse]

Ejemplo

Ejemplo de agregación

Copy

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

getAuditLogs

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetAuditLogsOptions	No

Respuesta

Devuelve: Option[GetAuditLogsResponse]

Ejemplo

Ejemplo getAuditLogs

Copy

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

logoutPublic

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

logoutPublic Ejemplo

Copy

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

blockFromCommentPublic

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Respuesta

Devuelve: Option[BlockSuccess]

Ejemplo

Ejemplo blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parámetros

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

Respuesta

Devuelve: Option[UnblockSuccess]

Ejemplo

unBlockCommentPublic Ejemplo

Copy

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

checkedCommentsForBlocked

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

Respuesta

Devuelve: Option[CheckBlockedCommentsResponse]

Ejemplo

Ejemplo de checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

Respuesta

Devuelve: Option[BlockSuccess]

Ejemplo

Ejemplo blockUserFromComment

Copy

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

createCommentPublic

Parameters

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Response

Devuelve: Option[SaveCommentsResponseWithPresence]

Ejemplo

Ejemplo createCommentPublic

Copy

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

deleteComment

Parámetros

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

Respuesta

Devuelve: Option[DeleteCommentResult]

Ejemplo

Ejemplo deleteComment

Copy

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

deleteCommentPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Respuesta

Devuelve: Option[PublicAPIDeleteCommentResponse]

Ejemplo

deleteCommentPublic Ejemplo

Copy

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

deleteCommentVote

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
options	DeleteCommentVoteOptions	No

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo de deleteCommentVote

Copy

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

flagComment

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
options	FlagCommentOptions	No

Respuesta

Devuelve: Option[FlagCommentResponse]

Ejemplo

Ejemplo de flagComment

Copy

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

getComment

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
id	string	No

Respuesta

Devuelve: Option[APIGetCommentResponse]

Ejemplo

Ejemplo getComment

Copy

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

getComments

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetCommentsOptions	No

Respuesta

Devuelve: Option[APIGetCommentsResponse]

Ejemplo

Ejemplo getComments

Copy

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

getCommentsPublic

req tenantId urlId

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
options	GetCommentsPublicOptions	No

Respuesta

Devuelve: Option[GetCommentsResponseWithPresencePublicComment]

Ejemplo

Ejemplo getCommentsPublic

Copy

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

getCommentText

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
options	GetCommentTextOptions	No

Respuesta

Devuelve: Option[PublicAPIGetCommentTextResponse]

Ejemplo

Ejemplo de getCommentText

Copy

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

getCommentVoteUserNames

Parámetros

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

Respuesta

Devuelve: Option[GetCommentVoteUserNamesSuccessResponse]

Ejemplo

Ejemplo de getCommentVoteUserNames

Copy

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

lockComment

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo lockComment

Copy

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

pinComment

Parámetros

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

Respuesta

Devuelve: Option[ChangeCommentPinStatusResponse]

Ejemplo

Ejemplo de pinComment

Copy

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

saveComment

Parameters

Nombre	Tipo	Obligatorio
tenantId	string	Yes
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

Response

Devuelve: Option[APISaveCommentResponse]

Example

Ejemplo saveComment

Copy

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

saveCommentsBulk

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo saveCommentsBulk

Copy

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

setCommentText

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

Respuesta

Returns: Option[PublicAPISetCommentTextResponse]

Ejemplo

Ejemplo setCommentText

Copy

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

unBlockUserFromComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

Respuesta

Devuelve: Option[UnblockSuccess]

Ejemplo

Ejemplo de unBlockUserFromComment

Copy

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

unFlagComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
options	UnFlagCommentOptions	No

Respuesta

Devuelve: Option[FlagCommentResponse]

Ejemplo

Ejemplo de unFlagComment

Copy

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

unLockComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Respuesta

Returns: Option[APIEmptyResponse]

Ejemplo

Ejemplo de unLockComment

Copy

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

unPinComment

Parámetros

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

Respuesta

Devuelve: Option[ChangeCommentPinStatusResponse]

Ejemplo

Ejemplo de unPinComment

Copy

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

updateComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateComment

Copy

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

voteComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
urlId	string	Sí
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

Ejemplo voteComment

Copy

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

getCommentsForUser

Parámetros

Nombre	Tipo	Obligatorio	Descripción
options	GetCommentsForUserOptions	No

Respuesta

Devuelve: Option[GetCommentsForUserResponse]

Ejemplo

Ejemplo getCommentsForUser

Copy

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

addDomainConfig

Parámetros

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

Respuesta

Devuelve: Option[AddDomainConfigResponse]

Ejemplo

Ejemplo addDomainConfig

Copy

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

deleteDomainConfig

Parámetros

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

Respuesta

Devuelve: Option[DeleteDomainConfigResponse]

Ejemplo

deleteDomainConfig Ejemplo

Copy

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

getDomainConfig

Parámetros

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

Respuesta

Devuelve: Option[GetDomainConfigResponse]

Ejemplo

Ejemplo getDomainConfig

Copy

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

getDomainConfigs

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: Option[GetDomainConfigsResponse]

Ejemplo

Ejemplo getDomainConfigs

Copy

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

patchDomainConfig

Parámetros

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

Respuesta

Devuelve: Option[PatchDomainConfigResponse]

Ejemplo

Ejemplo de patchDomainConfig

Copy

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

putDomainConfig

Parámetros

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

Respuesta

Devuelve: Option[PutDomainConfigResponse]

Ejemplo

Ejemplo putDomainConfig

Copy

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

createEmailTemplate

Parámetros

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

Respuesta

Devuelve: Option[CreateEmailTemplateResponse]

Ejemplo

Ejemplo de createEmailTemplate

Copy

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

deleteEmailTemplate

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

deleteEmailTemplate Ejemplo

Copy

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

deleteEmailTemplateRenderError

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

deleteEmailTemplateRenderError Ejemplo

Copy

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

getEmailTemplate

Parámetros

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

Respuesta

Devuelve: Option[GetEmailTemplateResponse]

Ejemplo

getEmailTemplate Ejemplo

Copy

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

getEmailTemplateDefinitions

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: Option[GetEmailTemplateDefinitionsResponse]

Ejemplo

Ejemplo de getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	No
skip	float64	No

Respuesta

Devuelve: Option[GetEmailTemplateRenderErrorsResponse]

Ejemplo

Ejemplo getEmailTemplateRenderErrors

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # usar la respuesta según sea necesario
else:
  # manejar respuesta faltante
  discard

getEmailTemplates

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
skip	float64	No

Respuesta

Devuelve: Option[GetEmailTemplatesResponse]

Ejemplo

getEmailTemplates Ejemplo

Copy

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

renderEmailTemplate

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Respuesta

Devuelve: Option[RenderEmailTemplateResponse]

Ejemplo

Ejemplo de renderEmailTemplate

Copy

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

updateEmailTemplate

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

updateEmailTemplate Ejemplo

Copy

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

getEventLog

req tenantId urlId userIdWS

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Respuesta

Devuelve: Option[GetEventLogResponse]

Ejemplo

Ejemplo de getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parámetros

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

Respuesta

Devuelve: Option[GetEventLogResponse]

Ejemplo

getGlobalEventLog Ejemplo

Copy

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

createFeedPost

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Respuesta

Devuelve: Option[CreateFeedPostsResponse]

Ejemplo

Ejemplo createFeedPost

Copy

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

createFeedPostPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

Respuesta

Devuelve: Option[CreateFeedPostResponse]

Ejemplo

Ejemplo createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
postId	string	No
options	DeleteFeedPostPublicOptions	No

Respuesta

Devuelve: Option[DeleteFeedPostPublicResponse]

Ejemplo

Ejemplo deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetFeedPostsOptions	No

Respuesta

Devuelve: Option[GetFeedPostsResponse]

Ejemplo

Ejemplo de getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetFeedPostsPublicOptions	No

Respuesta

Devuelve: Option[PublicFeedPostsResponse]

Ejemplo

getFeedPostsPublic Ejemplo

Copy

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

getFeedPostsStats

Parámetros

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

Respuesta

Devuelve: Option[FeedPostsStatsResponse]

Ejemplo

Ejemplo getFeedPostsStats

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # usar stats según sea necesario

getUserReactsPublic

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetUserReactsPublicOptions	No

Respuesta

Devuelve: Option[UserReactsResponse]

Ejemplo

getUserReactsPublic Ejemplo

Copy

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

reactFeedPostPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Respuesta

Devuelve: Option[ReactFeedPostResponse]

Ejemplo

Ejemplo reactFeedPostPublic

Copy

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

updateFeedPost

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
feedPost	FeedPost	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateFeedPost

Copy

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

updateFeedPostPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Respuesta

Devuelve: Option[CreateFeedPostResponse]

Ejemplo

Ejemplo de updateFeedPostPublic

Copy

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

flagCommentPublic

Parámetros

Name	Type	Required
tenantId	string	Sí
commentId	string	Sí
isFlagged	bool	No
sso	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo flagCommentPublic

Copy

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

getGifLarge

Parámetros

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

Respuesta

Devuelve: Option[GifGetLargeResponse]

Ejemplo

Ejemplo getGifLarge

Copy

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

getGifsSearch

Parámetros

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

Respuesta

Devuelve: Option[GetGifsSearchResponse]

Ejemplo

Ejemplo getGifsSearch

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # usar resp según sea necesario

getGifsTrending

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetGifsTrendingOptions	No

Respuesta

Devuelve: Option[GetGifsTrendingResponse]

Ejemplo

Ejemplo getGifsTrending

Copy

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

addHashTag

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Respuesta

Devuelve: Option[CreateHashTagResponse]

Ejemplo

Ejemplo de addHashTag

Copy

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

addHashTagsBulk

Parámetros

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

Respuesta

Devuelve: Option[BulkCreateHashTagsResponse]

Ejemplo

Ejemplo addHashTagsBulk

Copy

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

deleteHashTag

Parámetros

Name	Type	Required
tenantId	string	Yes
tag	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Respuesta

Retorna: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteHashTag

Copy

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

getHashTags

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
page	float64	No

Respuesta

Devuelve: Option[GetHashTagsResponse]

Ejemplo

Ejemplo de getHashTags

Copy

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

patchHashTag

Parámetros

Name	Type	Required
tenantId	string	Sí
tag	string	No
updateHashTagBody	UpdateHashTagBody	No

Respuesta

Devuelve: Option[UpdateHashTagResponse]

Ejemplo

Ejemplo patchHashTag

Copy

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

deleteModerationVote

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
voteId	string	No
options	DeleteModerationVoteOptions	No

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo deleteModerationVote

Copy

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

getApiComments

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetApiCommentsOptions	No

Respuesta

Devuelve: Option[ModerationAPIGetCommentsResponse]

Ejemplo

Ejemplo getApiComments

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # se puede hacer un procesamiento adicional con `resp`

getApiExportStatus

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetApiExportStatusOptions	No

Respuesta

Devuelve: Option[ModerationExportStatusResponse]

Ejemplo

Ejemplo getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # usar exportStatus según sea necesario

getApiIds

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetApiIdsOptions	No

Respuesta

Devuelve: Option[ModerationAPIGetCommentIdsResponse]

Ejemplo

Ejemplo getApiIds

Copy

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

getBanUsersFromComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[GetBannedUsersFromCommentResponse]

Ejemplo

getBanUsersFromComment Ejemplo

Copy

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

getCommentBanStatus

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[GetCommentBanStatusResponse]

Ejemplo

getCommentBanStatus Ejemplo

Copy

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

getCommentChildren

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[ModerationAPIChildCommentsResponse]

Ejemplo

Ejemplo getCommentChildren

Copy

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

getCount

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetCountOptions	No

Respuesta

Devuelve: Option[ModerationAPICountCommentsResponse]

Ejemplo

Ejemplo de getCount

Copy

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

getCounts

Parámetros

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

Respuesta

Devuelve: Option[GetBannedUsersCountResponse]

Ejemplo

Ejemplo getCounts

Copy

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

getLogs

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[ModerationAPIGetLogsResponse]

Ejemplo

Ejemplo getLogs

Copy

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

getManualBadges

Parámetros

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

Respuesta

Devuelve: Option[GetTenantManualBadgesResponse]

Ejemplo

Ejemplo getManualBadges

Copy

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

getManualBadgesForUser

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetManualBadgesForUserOptions	No

Respuesta

Devuelve: Option[GetUserManualBadgesResponse]

Ejemplo

getManualBadgesForUser Ejemplo

Copy

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

getModerationComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
options	GetModerationCommentOptions	No

Respuesta

Devuelve: Option[ModerationAPICommentResponse]

Ejemplo

Ejemplo getModerationComment

Copy

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

getModerationCommentText

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Respuesta

Devuelve: Option[GetCommentTextResponse]

Ejemplo

Ejemplo getModerationCommentText

Copy

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

getPreBanSummary

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
options	GetPreBanSummaryOptions	No

Respuesta

Devuelve: Option[PreBanSummary]

Ejemplo

Ejemplo getPreBanSummary

Copy

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

getSearchCommentsSummary

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetSearchCommentsSummaryOptions	No

Respuesta

Devuelve: Option[ModerationCommentSearchResponse]

Ejemplo

Ejemplo getSearchCommentsSummary

Copy

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

getSearchPages

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetSearchPagesOptions	No

Respuesta

Devuelve: Option[ModerationPageSearchResponse]

Ejemplo

Ejemplo getSearchPages

Copy

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

getSearchSites

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
options	GetSearchSitesOptions	No

Respuesta

Devuelve: Option[ModerationSiteSearchResponse]

Ejemplo

Ejemplo getSearchSites

Copy

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

getSearchSuggest

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetSearchSuggestOptions	No

Respuesta

Devuelve: Option[ModerationSuggestResponse]

Ejemplo

Ejemplo de getSearchSuggest

Copy

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

getSearchUsers

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetSearchUsersOptions	No

Respuesta

Devuelve: Option[ModerationUserSearchResponse]

Ejemplo

Ejemplo getSearchUsers

Copy

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

getTrustFactor

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetTrustFactorOptions	No

Respuesta

Devuelve: Option[GetUserTrustFactorResponse]

Ejemplo

Ejemplo getTrustFactor

Copy

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

getUserBanPreference

Parámetros

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

Respuesta

Devuelve: Option[APIModerateGetUserBanPreferencesResponse]

Ejemplo

Ejemplo de getUserBanPreference

Copy

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

getUserInternalProfile

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetUserInternalProfileOptions	No

Respuesta

Devuelve: Option[GetUserInternalProfileResponse]

Ejemplo

Ejemplo getUserInternalProfile

Copy

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

postAdjustCommentVotes

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

Respuesta

Devuelve: Option[AdjustVotesResponse]

Ejemplo

postAdjustCommentVotes Ejemplo

Copy

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

postApiExport

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
options	PostApiExportOptions	No

Respuesta

Returns: Option[ModerationExportResponse]

Ejemplo

Ejemplo de postApiExport

Copy

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

postBanUserFromComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
options	PostBanUserFromCommentOptions	No

Respuesta

Devuelve: Option[BanUserFromCommentResult]

Ejemplo

Ejemplo postBanUserFromComment

Copy

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

postBanUserUndo

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
banUserUndoParams	BanUserUndoParams	No
sso	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo postBanUserUndo

Copy

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

postBulkPreBanSummary

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Respuesta

Devuelve: Option[BulkPreBanSummary]

Ejemplo

Ejemplo postBulkPreBanSummary

Copy

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

postCommentsByIds

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentsByIdsParams	CommentsByIdsParams	No
sso	string = ""	No

Respuesta

Devuelve: Option[ModerationAPIChildCommentsResponse]

Ejemplo

Ejemplo postCommentsByIds

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # usa resp según sea necesario

postFlagComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
options	PostFlagCommentOptions	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

postFlagComment Ejemplo

Copy

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

postRemoveComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Respuesta

Devuelve: Option[PostRemoveCommentApiResponse]

Ejemplo

Ejemplo postRemoveComment

Copy

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

postRestoreDeletedComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
options	PostRestoreDeletedCommentOptions	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postRestoreDeletedComment

Copy

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

postSetCommentApprovalStatus

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
options	PostSetCommentApprovalStatusOptions	No

Respuesta

Devuelve: Option[SetCommentApprovedResponse]

Ejemplo

postSetCommentApprovalStatus Ejemplo

Copy

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

postSetCommentReviewStatus

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
options	PostSetCommentReviewStatusOptions	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postSetCommentReviewStatus

Copy

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

postSetCommentSpamStatus

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
options	PostSetCommentSpamStatusOptions	No

Respuesta

Returns: Option[APIEmptyResponse]

Ejemplo

Ejemplo postSetCommentSpamStatus

Copy

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

postSetCommentText

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

Respuesta

Returns: Option[SetCommentTextResponse]

Ejemplo

postSetCommentText Ejemplo

Copy

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

postUnFlagComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
options	PostUnFlagCommentOptions	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de postUnFlagComment

Copy

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

postVote

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
options	PostVoteOptions	No

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

postVote Ejemplo

Copy

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

putAwardBadge

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
badgeId	string	No
options	PutAwardBadgeOptions	No

Respuesta

Devuelve: Option[AwardUserBadgeResponse]

Ejemplo

putAwardBadge Ejemplo

Copy

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

putCloseThread

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

putCloseThread Ejemplo

Copy

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

putRemoveBadge

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
badgeId	string	No
options	PutRemoveBadgeOptions	No

Respuesta

Devuelve: Option[RemoveUserBadgeResponse]

Ejemplo

putRemoveBadge Ejemplo

Copy

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

putReopenThread

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

putReopenThread Ejemplo

Copy

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

setTrustFactor

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	SetTrustFactorOptions	No

Respuesta

Devuelve: Option[SetUserTrustFactorResponse]

Ejemplo

Ejemplo setTrustFactor

Copy

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

createModerator

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	No

Respuesta

Devuelve: Option[CreateModeratorResponse]

Ejemplo

Ejemplo createModerator

Copy

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

deleteModerator

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
sendEmail	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteModerator

Copy

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

getModerator

Parámetros

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

Respuesta

Devuelve: Option[GetModeratorResponse]

Ejemplo

Ejemplo getModerator

Copy

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

getModerators

Parámetros

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

Respuesta

Devuelve: Option[GetModeratorsResponse]

Ejemplo

getModerators Ejemplo

Copy

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

updateModerator

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateModerator

Copy

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

deleteNotificationCount

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo deleteNotificationCount

Copy

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

getCachedNotificationCount

Parámetros

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

Respuesta

Devuelve: Option[GetCachedNotificationCountResponse]

Ejemplo

Ejemplo getCachedNotificationCount

Copy

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

getNotificationCount

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetNotificationCountOptions	No

Respuesta

Devuelve: Option[GetNotificationCountResponse]

Ejemplo

Ejemplo getNotificationCount

Copy

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

getNotifications

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetNotificationsOptions	No

Respuesta

Devuelve: Option[GetNotificationsResponse]

Ejemplo

Ejemplo de getNotifications

Copy

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

updateNotification

Parámetros

Name	Type	Required
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

updateNotification Ejemplo

Copy

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

createV1PageReact

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
title	string = ""	No

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

Ejemplo createV1PageReact

Copy

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

createV2PageReact

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
urlId	string	Yes
id	string	No
title	string = ""	No

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

createV2PageReact Ejemplo

Copy

let (pageResult, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "page-456",
  title = "Breaking News",
)
if pageResult.isSome:
  let page = pageResult.get()
  # usar `page` según sea necesario

deleteV1PageReact

Parámetros

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

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

Ejemplo de deleteV1PageReact

Copy

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

deleteV2PageReact

Parámetros

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

Respuesta

Devuelve: Option[CreateV1PageReact]

Ejemplo

deleteV2PageReact Ejemplo

Copy

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

getV1PageLikes

Parámetros

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

Respuesta

Devuelve: Option[GetV1PageLikes]

Ejemplo

Ejemplo de getV1PageLikes

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # usar pageLikes según sea necesario

getV2PageReacts

Parámetros

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

Respuesta

Devuelve: Option[GetV2PageReacts]

Ejemplo

Ejemplo getV2PageReacts

Copy

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

getV2PageReactUsers

Parámetros

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

Respuesta

Devuelve: Option[GetV2PageReactUsersResponse]

Ejemplo

Ejemplo getV2PageReactUsers

Copy

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

addPage

Parámetros

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

Respuesta

Devuelve: Option[AddPageAPIResponse]

Ejemplo

Ejemplo addPage

Copy

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

deletePage

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Respuesta

Devuelve: Option[DeletePageAPIResponse]

Ejemplo

Ejemplo deletePage

Copy

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

getOfflineUsers

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

Parámetros

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

Respuesta

Returns: Option[PageUsersOfflineResponse]

Ejemplo

Ejemplo getOfflineUsers

Copy

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

getOnlineUsers

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

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
options	GetOnlineUsersOptions	No

Respuesta

Devuelve: Option[PageUsersOnlineResponse]

Ejemplo

Ejemplo getOnlineUsers

Copy

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

getPageByURLId

Parámetros

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

Respuesta

Devuelve: Option[GetPageByURLIdAPIResponse]

Ejemplo

Ejemplo getPageByURLId

Copy

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

getPages

Parámetros

Name	Type	Required	Description
tenantId	string	Yes

Respuesta

Devuelve: Option[GetPagesAPIResponse]

Ejemplo

Ejemplo de getPages

Copy

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

getPagesPublic

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

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetPagesPublicOptions	No

Respuesta

Devuelve: Option[GetPublicPagesResponse]

Ejemplo

Ejemplo getPagesPublic

Copy

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

getUsersInfo

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

Returns: Option[PageUsersInfoResponse]

Example

Ejemplo getUsersInfo

Copy

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

patchPage

Parameters

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Response

Devuelve: Option[PatchPageAPIResponse]

Ejemplo

Ejemplo de patchPage

Copy

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

deletePendingWebhookEvent

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

deletePendingWebhookEvent Ejemplo

Copy

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

getPendingWebhookEventCount

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
options	GetPendingWebhookEventCountOptions	No

Respuesta

Devuelve: Option[GetPendingWebhookEventCountResponse]

Ejemplo

Ejemplo getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetPendingWebhookEventsOptions	No

Respuesta

Devuelve: Option[GetPendingWebhookEventsResponse]

Ejemplo

getPendingWebhookEvents Ejemplo

Copy

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

createQuestionConfig

Parámetros

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

Respuesta

Devuelve: Option[CreateQuestionConfigResponse]

Ejemplo

Ejemplo createQuestionConfig

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # usar resp según sea necesario

deleteQuestionConfig

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo deleteQuestionConfig

Copy

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

getQuestionConfig

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Respuesta

Devuelve: Option[GetQuestionConfigResponse]

Ejemplo

getQuestionConfig Ejemplo

Copy

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

getQuestionConfigs

Parámetros

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

Respuesta

Devuelve: Option[GetQuestionConfigsResponse]

Ejemplo

Ejemplo de getQuestionConfigs

Copy

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

updateQuestionConfig

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateQuestionConfig

Copy

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

createQuestionResult

Parámetros

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

Respuesta

Devuelve: Option[CreateQuestionResultResponse]

Ejemplo

createQuestionResult Ejemplo

Copy

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

deleteQuestionResult

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
id	string	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de deleteQuestionResult

Copy

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

getQuestionResult

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
id	string	No

Respuesta

Devuelve: Option[GetQuestionResultResponse]

Ejemplo

Ejemplo de getQuestionResult

Copy

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

getQuestionResults

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
options	GetQuestionResultsOptions	No

Respuesta

Devuelve: Option[GetQuestionResultsResponse]

Ejemplo

Ejemplo getQuestionResults

Copy

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

updateQuestionResult

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateQuestionResult

Copy

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

aggregateQuestionResults

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	AggregateQuestionResultsOptions	No

Respuesta

Devuelve: Option[AggregateQuestionResultsResponse]

Ejemplo

aggregateQuestionResults Ejemplo

Copy

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

bulkAggregateQuestionResults

Parameters

Nombre	Tipo	Obligatorio
tenantId	string	Sí
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Response

Devuelve: Option[BulkAggregateQuestionResultsResponse]

Ejemplo

Ejemplo de bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

Respuesta

Devuelve: Option[CombineQuestionResultsWithCommentsResponse]

Ejemplo

combineCommentsWithQuestionResults Ejemplo

Copy

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

addSSOUser

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createAPISSOUserData	CreateAPISSOUserData	No

Respuesta

Devuelve: Option[AddSSOUserAPIResponse]

Ejemplo

Ejemplo addSSOUser

Copy

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

deleteSSOUser

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
options	DeleteSSOUserOptions	No

Respuesta

Devuelve: Option[DeleteSSOUserAPIResponse]

Ejemplo

Ejemplo deleteSSOUser

Copy

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

getSSOUserByEmail

Parámetros

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

Respuesta

Devuelve: Option[GetSSOUserByEmailAPIResponse]

Ejemplo

Ejemplo getSSOUserByEmail

Copy

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

getSSOUserById

Parámetros

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

Respuesta

Devuelve: Option[GetSSOUserByIdAPIResponse]

Ejemplo

getSSOUserById Ejemplo

Copy

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

getSSOUsers

Parámetros

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

Respuesta

Devuelve: Option[GetSSOUsersResponse]

Ejemplo

Ejemplo getSSOUsers

Copy

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

patchSSOUser

Parameters

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

Response

Devuelve: Option[PatchSSOUserAPIResponse]

Example

Ejemplo de patchSSOUser

Copy

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

putSSOUser

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Respuesta

Devuelve: Option[PutSSOUserAPIResponse]

Ejemplo

putSSOUser Ejemplo

Copy

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

createSubscription

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Respuesta

Devuelve: Option[CreateSubscriptionAPIResponse]

Ejemplo

Ejemplo createSubscription

Copy

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

deleteSubscription

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	No
userId	string = ""	No

Respuesta

Devuelve: Option[DeleteSubscriptionAPIResponse]

Ejemplo

Ejemplo de deleteSubscription

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # usar apiResult según sea necesario

getSubscriptions

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
userId	string = ""	No

Respuesta

Devuelve: Option[GetSubscriptionsAPIResponse]

Ejemplo

Ejemplo de getSubscriptions

Copy

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

updateSubscription

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

Respuesta

Devuelve: Option[UpdateSubscriptionAPIResponse]

Ejemplo

Ejemplo de updateSubscription

Copy

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

getTenantDailyUsages

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetTenantDailyUsagesOptions	No

Respuesta

Devuelve: Option[GetTenantDailyUsagesResponse]

Ejemplo

Ejemplo de getTenantDailyUsages

Copy

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

createTenantPackage

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createTenantPackageBody	CreateTenantPackageBody	No

Respuesta

Devuelve: Option[CreateTenantPackageResponse]

Ejemplo

Ejemplo createTenantPackage

Copy

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

deleteTenantPackage

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

deleteTenantPackage Ejemplo

Copy

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

getTenantPackage

Parámetros

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

Respuesta

Devuelve: Option[GetTenantPackageResponse]

Ejemplo

getTenantPackage Ejemplo

Copy

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

getTenantPackages

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
skip	float64	No

Respuesta

Devuelve: Option[GetTenantPackagesResponse]

Ejemplo

getTenantPackages Ejemplo

Copy

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

replaceTenantPackage

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo replaceTenantPackage

Copy

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

updateTenantPackage

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo updateTenantPackage

Copy

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

createTenantUser

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createTenantUserBody	CreateTenantUserBody	No

Respuesta

Returns: Option[CreateTenantUserResponse]

Ejemplo

Ejemplo createTenantUser

Copy

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

deleteTenantUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	No
options	DeleteTenantUserOptions	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo deleteTenantUser

Copy

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

getTenantUser

Parámetros

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

Respuesta

Devuelve: Option[GetTenantUserResponse]

Ejemplo

Ejemplo de getTenantUser

Copy

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

getTenantUsers

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
skip	float64	No

Respuesta

Devuelve: Option[GetTenantUsersResponse]

Ejemplo

getTenantUsers Ejemplo

Copy

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

replaceTenantUser

Parameters

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Response

Devuelve: Option[APIEmptyResponse]

Example

replaceTenantUser Ejemplo

Copy

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

sendLoginLink

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	No
redirectURL	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de sendLoginLink

Copy

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

updateTenantUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo updateTenantUser

Copy

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

createTenant

Parámetros

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

Respuesta

Devuelve: Option[CreateTenantResponse]

Ejemplo

Ejemplo de createTenant

Copy

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

deleteTenant

Parámetros

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

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo deleteTenant

Copy

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

getTenant

Parámetros

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

Respuesta

Devuelve: Option[GetTenantResponse]

Ejemplo

Ejemplo getTenant

Copy

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

getTenants

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
options	GetTenantsOptions	No

Respuesta

Devuelve: Option[GetTenantsResponse]

Ejemplo

Ejemplo getTenants

Copy

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

updateTenant

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

Respuesta

Devuelve: Option[APIEmptyResponse]

Ejemplo

Ejemplo de updateTenant

Copy

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

changeTicketState

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

Respuesta

Devuelve: Option[ChangeTicketStateResponse]

Ejemplo

Ejemplo de changeTicketState

Copy

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

createTicket

Parámetros

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

Respuesta

Devuelve: Option[CreateTicketResponse]

Ejemplo

Ejemplo createTicket

Copy

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

getTicket

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
userId	string = ""	No

Respuesta

Devuelve: Option[GetTicketResponse]

Ejemplo

Ejemplo getTicket

Copy

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

getTickets

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
options	GetTicketsOptions	No

Respuesta

Devuelve: Option[GetTicketsResponse]

Ejemplo

Ejemplo de getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # usar tickets según sea necesario

getTranslations

Parámetros

Nombre	Tipo	Requerido
namespace	string	No
component	string	No
options	GetTranslationsOptions	No

Respuesta

Devuelve: Option[GetTranslationsResponse]

Ejemplo

Ejemplo de getTranslations

Copy

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

uploadImage

Subir y redimensionar una imagen

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Respuesta

Devuelve: Option[UploadImageResponse]

Ejemplo

Ejemplo de uploadImage

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # usar el resultado según sea necesario

getUserBadgeProgressById

Parámetros

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

Respuesta

Devuelve: Option[APIGetUserBadgeProgressResponse]

Ejemplo

Ejemplo getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parámetros

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

Respuesta

Devuelve: Option[APIGetUserBadgeProgressResponse]

Ejemplo

Ejemplo de getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetUserBadgeProgressListOptions	No

Respuesta

Devuelve: Option[APIGetUserBadgeProgressListResponse]

Ejemplo

Ejemplo getUserBadgeProgressList

Copy

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

createUserBadge

Parámetros

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

Respuesta

Devuelve: Option[APICreateUserBadgeResponse]

Ejemplo

Ejemplo createUserBadge

Copy

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

deleteUserBadge

Parámetros

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

Respuesta

Devuelve: Option[APIEmptySuccessResponse]

Ejemplo

Ejemplo deleteUserBadge

Copy

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

getUserBadge

Parámetros

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

Respuesta

Devuelve: Option[APIGetUserBadgeResponse]

Ejemplo

Ejemplo getUserBadge

Copy

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

getUserBadges

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
options	GetUserBadgesOptions	No

Respuesta

Devuelve: Option[APIGetUserBadgesResponse]

Ejemplo

Ejemplo getUserBadges

Copy

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

updateUserBadge

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Respuesta

Devuelve: Option[APIEmptySuccessResponse]

Ejemplo

Ejemplo updateUserBadge

Copy

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

getUserNotificationCount

Parámetros

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

Respuesta

Devuelve: Option[GetUserNotificationCountResponse]

Ejemplo

Ejemplo de getUserNotificationCount

Copy

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

getUserNotifications

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
options	GetUserNotificationsOptions	No

Respuesta

Devuelve: Option[GetMyNotificationsResponse]

Ejemplo

Ejemplo getUserNotifications

Copy

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

resetUserNotificationCount

Parámetros

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

Respuesta

Devuelve: Option[ResetUserNotificationsResponse]

Ejemplo

resetUserNotificationCount Ejemplo

Copy

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

resetUserNotifications

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
options	ResetUserNotificationsOptions	No

Respuesta

Devuelve: Option[ResetUserNotificationsResponse]

Ejemplo

Ejemplo de resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Enable o desactivar notificaciones para un comentario específico.

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
notificationId	string	No
optedInOrOut	string	No
commentId	string	Sí
sso	string = ""	No

Respuesta

Devuelve: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Ejemplo

Ejemplo de updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

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

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Respuesta

Returns: Option[UpdateUserNotificationPageResponse]

Ejemplo

Ejemplo de updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
notificationId	string	No
newStatus	string	No
sso	string = ""	No

Respuesta

Devuelve: Option[UpdateUserNotificationStatusResponse]

Ejemplo

Ejemplo de updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parámetros

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

Respuesta

Devuelve: Option[GetUserPresenceStatusesResponse]

Ejemplo

Ejemplo getUserPresenceStatuses

Copy

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

searchUsers

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
options	SearchUsersOptions	No

Respuesta

Devuelve: Option[SearchUsersResult]

Ejemplo

searchUsers Ejemplo

Copy

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

getUser

Parámetros

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

Respuesta

Devuelve: Option[GetUserResponse]

Ejemplo

Ejemplo getUser

Copy

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

createVote

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Respuesta

Devuelve: Option[VoteResponse]

Ejemplo

Ejemplo createVote

Copy

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

deleteVote

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	No
editKey	string = ""	No

Respuesta

Devuelve: Option[VoteDeleteResponse]

Ejemplo

Ejemplo de deleteVote

Copy

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

getVotes

Parámetros

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

Respuesta

Devuelve: Option[GetVotesResponse]

Ejemplo

Ejemplo de getVotes

Copy

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

getVotesForUser

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
options	GetVotesForUserOptions	No

Respuesta

Devuelve: Option[GetVotesForUserResponse]

Ejemplo

Ejemplo getVotesForUser

Copy

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

¿Necesitas ayuda?

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

Contribuciones

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

Idioma 🇪🇸 Español

Documentación

Primeros pasos

Referencia de API

Uso

Agregación

Registros de auditoría

Autenticación

Bloquear por comentario

Comprobar comentarios bloqueados

Comentarios

Comentarios del usuario

Configuraciones de dominio

Plantillas de correo

Registro de eventos

Publicaciones del feed

Marcar comentario

Gifs

Hashtags

Moderación

Moderadores

Recuento de notificaciones

Notificaciones

Reacciones de página

Páginas

Eventos webhook pendientes

Configuraciones de preguntas

Resultados de preguntas

Agregación de resultados de preguntas

Usuarios SSO

Suscripciones

Uso diario del inquilino

Paquetes del inquilino

Usuarios del inquilino

Inquilinos

Tickets

Traducciones

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones del usuario

Estado de presencia del usuario

Búsqueda de usuarios

Usuarios

Votos

SDK de FastComments para Nim

Repositorio

Requisitos

Instalación

Usando Nimble

Compilando desde el código fuente

Contenido de la biblioteca

APIs públicas vs seguras

Inicio rápido

Uso de APIs autenticadas (DefaultAPI)

Uso de APIs públicas (PublicAPI)

Uso de APIs de moderación (ModerationAPI)

Problemas comunes

Realizar llamadas API

Ejemplo: Obtención de Comentarios

Notas

IDs de transmisión

SSO (Inicio de sesión único)

Uso de SSO

SSO simple

SSO seguro

Documentación de fastcomments

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

Parámetros

Respuesta

Ejemplo

getAuditLogs

Parámetros

Respuesta

Ejemplo

logoutPublic