FastComments JavaScript/TypeScript SDK

Este es el SDK oficial de JavaScript/TypeScript para FastComments.

SDK oficial de JavaScript/TypeScript para la API de FastComments

Repositorio

Instalación

npm install fastcomments-sdk

Documentación de la API

Referencia completa de la API: docs/api/README.md

Compatibilidad Navegador vs Servidor

Este SDK utiliza puntos de entrada duales para garantizar la compatibilidad óptima y prevenir errores en tiempo de ejecución:

fastcomments-sdk/browser - Versión segura para el navegador con fetch nativo
fastcomments-sdk/server - Versión completa para Node.js con soporte SSO
fastcomments-sdk (predeterminado) - Solo tipos, seguro de importar en cualquier lugar

Uso

Este SDK proporciona puntos de entrada separados para entornos de navegador y servidor para garantizar la compatibilidad y seguridad óptimas:

Browser Usage (Client-Side)

Para aplicaciones de navegador/frontend, use la exportación segura para navegadores que excluye dependencias de Node.js:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server Usage (Node.js)

Para aplicaciones de servidor/backend, use el SDK completo con SSO y características de autenticación:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Types Only Import

Si solo necesita tipos de TypeScript (sin código en tiempo de ejecución), use la importación por defecto:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Using Individual API Classes

Browser Environment

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

Server Environment

import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key',
  basePath: 'https://fastcomments.com'
});

const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);

APIs públicas vs seguras

El SDK proporciona tres clases principales de API:

DefaultApi - Endpoints seguros que requieren su clave de API para la autenticación. Úselos para operaciones del lado del servidor.
PublicApi - Endpoints públicos a los que se puede acceder sin una clave de API. Pueden llamarse directamente desde navegadores, dispositivos móviles, etc.
HiddenApi - Endpoints internos/administrativos para casos de uso avanzados.

Ejemplo: Uso de la API pública (segura para navegadores)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Obtener comentarios de una página (no se requiere clave de API)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Ejemplo: Uso de Default API (solo del lado del servidor)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // ¡Mantén esto en secreto!
});
const defaultApi = new DefaultApi(config);

// Obtener comentarios con acceso administrativo completo
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Integración SSO (Inicio de sesión único)

FastComments admite SSO para integrarse con su sistema de autenticación de usuarios existente. La funcionalidad SSO solo está disponible en la exportación del servidor ya que requiere funciones criptográficas de Node.js.

SSO simple (solo en el servidor)

El SSO simple debe generarse en el servidor y enviarse al cliente:

// Código del lado del servidor (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crear SSO simple usando el auxiliar integrado  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// Envíe ssoToken a su código del lado del cliente
// El código del lado del cliente puede entonces usar este token con el SDK para navegador

SSO seguro (lado del servidor, recomendado)

El SSO seguro debe implementarse en el servidor y ofrece mayor seguridad:

// Código del lado del servidor (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crear SSO seguro usando el auxiliar integrado
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// Usar con llamadas a la API en el servidor
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// O enviar ssoConfig al cliente para uso en el navegador

Uso de SSO desde el navegador (con token generado por el servidor)

// Código del lado del cliente (navegador)
import { PublicApi } from 'fastcomments-sdk/browser';

// Obtener el token SSO desde su endpoint en el servidor
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Usar el token SSO generado por el servidor
});

SSO con creación de comentarios

// Lado del servidor: crear SSO y comentario
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Casos de uso comunes

Obtener comentarios para una página

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Crear un comentario

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Votar en un comentario

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 para voto a favor, -1 para voto en contra
  }
});

Gestión de usuarios (requiere clave de API)

// Buscar usuarios (requiere DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Eventos en vivo (Actualizaciones en tiempo real)

Suscríbete a eventos en vivo para recibir actualizaciones en tiempo real sobre comentarios, votos y otras actividades.

Eventos a nivel de página

Escucha eventos en vivo en una página específica (comentarios, votos, etc.):

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Suscribirse a eventos en vivo para una página
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (obtén esto de la respuesta de getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Actualiza tu UI con el nuevo comentario
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Actualiza los contadores de votos en tu UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Devuelve true si el evento fue procesado
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Cierra la suscripción cuando hayas terminado
subscription.close();

Suscribirse a eventos de usuario

Escucha eventos específicos del usuario (notificaciones, menciones, etc.):

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Obtén esto de la respuesta de getComments
};

// Suscribirse al feed personal del usuario
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Muestra la notificación en tu UI
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }

    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Cierra cuando hayas terminado
userSubscription.close();

Obtener userIdWS

El parámetro userIdWS es requerido para eventos en vivo y puede obtenerse de las respuestas de la API:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Extrae userIdWS de la respuesta
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Ahora puedes suscribirte a eventos en vivo
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

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, de modo que sepas ignorar el evento si planeas aplicar los cambios de forma optimista 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.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // ID único para esta operación
  }
});

Manejo de errores

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

aggregate

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

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
aggregationRequest	AggregationRequest	Sí
parentTenantId	string	No
includeStats	boolean	No

Respuesta

Devuelve: AggregationResponse

getAuditLogs

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Respuesta

Devuelve: GetAuditLogs200Response

blockFromCommentPublic

Parámetros

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

Respuesta

Devuelve: BlockFromCommentPublic200Response

unBlockCommentPublic

Parámetros

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

Respuesta

Devuelve: UnBlockCommentPublic200Response

checkedCommentsForBlocked

Parámetros

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

Respuesta

Devuelve: CheckedCommentsForBlocked200Response

blockUserFromComment

Parámetros

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

Respuesta

Devuelve: BlockFromCommentPublic200Response

createCommentPublic

Parámetros

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

Respuesta

Devuelve: CreateCommentPublic200Response

deleteComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	Sí
contextUserId	string	No
isLive	boolean	No

Respuesta

Devuelve: DeleteComment200Response

deleteCommentPublic

Parámetros

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

Respuesta

Devuelve: DeleteCommentPublic200Response

deleteCommentVote

Parámetros

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

Respuesta

Devuelve: DeleteCommentVote200Response

flagComment

Parámetros

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

Respuesta

Devuelve: FlagComment200Response

getComment

Parámetros

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

Respuesta

Devuelve: GetComment200Response

getComments

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No

Respuesta

Devuelve: GetComments200Response

getCommentsPublic

req tenantId urlId

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
page	number	No
direction	SortDirections	No
sso	string	No
skip	number	No
skipChildren	number	No
limit	number	No
limitChildren	number	No
countChildren	boolean	No
fetchPageForCommentId	string	No
includeConfig	boolean	No
countAll	boolean	No
includei10n	boolean	No
locale	string	No
modules	string	No
isCrawler	boolean	No
includeNotificationCount	boolean	No
asTree	boolean	No
maxTreeDepth	number	No
useFullTranslationIds	boolean	No
parentId	string	No
searchText	string	No
hashTags	Array	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

Respuesta

Devuelve: GetCommentsPublic200Response

getCommentText

Parámetros

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

Respuesta

Devuelve: GetCommentText200Response

getCommentVoteUserNames

Parámetros

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

Respuesta

Devuelve: GetCommentVoteUserNames200Response

lockComment

Parámetros

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

Respuesta

Devuelve: LockComment200Response

pinComment

Parámetros

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

Respuesta

Devuelve: PinComment200Response

saveComment

Parámetros

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

Respuesta

Devuelve: SaveComment200Response

saveCommentsBulk

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
createCommentParams	Array	Sí
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Respuesta

Devuelve: Array<SaveComment200Response

setCommentText

Parámetros

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

Respuesta

Devuelve: SetCommentText200Response

unBlockUserFromComment

Parámetros

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

Respuesta

Devuelve: UnBlockCommentPublic200Response

unFlagComment

Parámetros

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

Respuesta

Devuelve: FlagComment200Response

unLockComment

Parámetros

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

Respuesta

Devuelve: LockComment200Response

unPinComment

Parámetros

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

Respuesta

Devuelve: PinComment200Response

updateComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	Sí
body	PickAPICommentUpdatableCommentFields	Sí
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Respuesta

Devuelve: FlagCommentPublic200Response

voteComment

Parámetros

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

Respuesta

Devuelve: VoteComment200Response

addDomainConfig

Parámetros

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

Respuesta

Devuelve: AddDomainConfig200Response

deleteDomainConfig

Parámetros

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

Respuesta

Devuelve: DeleteDomainConfig200Response

getDomainConfig

Parámetros

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

Respuesta

Devuelve: GetDomainConfig200Response

getDomainConfigs

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetDomainConfigs200Response

patchDomainConfig

Parámetros

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

Respuesta

Devuelve: GetDomainConfig200Response

putDomainConfig

Parámetros

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

Respuesta

Devuelve: GetDomainConfig200Response

createEmailTemplate

Parámetros

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

Respuesta

Devuelve: CreateEmailTemplate200Response

Ejemplo

Ejemplo de createEmailTemplate

Copy

const tenantId: string = "tenant_7a9f2b3d";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Comment Notification",
  subject: "New comment on your article: ",
  htmlBody: "<p> left a comment:</p><blockquote></blockquote>",
  enabled: true,
  defaultLocale: "en-US",
  metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // datos adicionales (opcionales)
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteEmailTemplate

Copy

const tenantId: string = "tenant_4b2f6a-4b2f6a2d";
const templateId: string = "email_template_9f8b7c3e";
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);
const status: APIStatus | undefined = result?.status

deleteEmailTemplateRenderError

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	Sí
errorId	string	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

deleteEmailTemplateRenderError Ejemplo

Copy

const tenantId: string = "tenant_8f3b2a9c";
const id: string = "template_4a1c9f7e";
const errorId: string = "err_20260112_abc123";
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

getEmailTemplate

Parámetros

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

Respuesta

Devuelve: GetEmailTemplate200Response

Ejemplo

Ejemplo de getEmailTemplate

Copy

(async () => {
  const tenantId: string = 'acme-enterprises-123';
  const id: string = 'welcome-email-template-v2';
  const locale: string | undefined = 'en-US'; // ejemplo de parámetro opcional
  const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);
  console.log(template, locale);
})();

getEmailTemplateDefinitions

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetEmailTemplateDefinitions200Response

Ejemplo

Ejemplo de getEmailTemplateDefinitions

Copy

const tenantId: string = 'acme-enterprises-78f2';
const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

getEmailTemplateRenderErrors

Parámetros

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

Respuesta

Devuelve: GetEmailTemplateRenderErrors200Response

Ejemplo

Ejemplo de getEmailTemplateRenderErrors

Copy

const tenantId: string = "tenant_7b3f2a9c";
const id: string = "tmpl_4f1b2c9e";
const skip: number = 25;
const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

getEmailTemplates

Parámetros

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

Respuesta

Devuelve: GetEmailTemplates200Response

Ejemplo

Ejemplo de getEmailTemplates

Copy

const tenantId: string = 'tenant_8f4d2b7c';
const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
const skip: number = 20;
const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

renderEmailTemplate

Parámetros

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

Respuesta

Devuelve: RenderEmailTemplate200Response

Ejemplo

Ejemplo de renderEmailTemplate

Copy

const tenantId: string = 'acme-corp-7f3';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'new-comment-notification',
  recipientEmail: 'jane.doe@acme.com',
  variables: {
    commenterName: 'Samir Patel',
    commentText: 'I found this article really helpful — thanks for sharing!',
    threadUrl: 'https://acme.com/blog/123#comments'
  },
  includeUnsubscribeLink: true
};
const locale: string = 'en-US';
const response: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateEmailTemplate

Copy

const tenantId: string = 'acme-corp-tenant-01';
const id: string = 'email_tpl_42b7a9';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: 'Comment Flag Notification',
  subject: 'A comment was flagged on acme.com',
  html: '<p>A comment by  was flagged. Review at </p>',
  replyTo: 'noreply@acme.com', // campo opcional demostrado
  enabled: true,
  customConfig: { priority: 'high' } // parámetros personalizados opcionales
};
const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parámetros

Name	Type	Requerido
tenantId	string	Sí
urlId	string	Sí
userIdWS	string	Sí
startTime	number	Sí
endTime	number	Sí

Respuesta

Devuelve: GetEventLog200Response

getGlobalEventLog

req tenantId urlId userIdWS

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
userIdWS	string	Sí
startTime	number	Sí
endTime	number	Sí

Respuesta

Devuelve: GetEventLog200Response

createFeedPost

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
createFeedPostParams	CreateFeedPostParams	Sí
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Respuesta

Devuelve: CreateFeedPost200Response

createFeedPostPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
createFeedPostParams	CreateFeedPostParams	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: CreateFeedPostPublic200Response

deleteFeedPostPublic

Parámetros

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

Respuesta

Devuelve: DeleteFeedPostPublic200Response

getFeedPosts

req tenantId afterId

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
afterId	string	No
limit	number	No
tags	Array	No

Respuesta

Devuelve: GetFeedPosts200Response

getFeedPostsPublic

req tenantId afterId

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

Respuesta

Devuelve: GetFeedPostsPublic200Response

getFeedPostsStats

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
postIds	Array	Sí
sso	string	No

Respuesta

Devuelve: GetFeedPostsStats200Response

getUserReactsPublic

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
postIds	Array	No
sso	string	No

Respuesta

Devuelve: GetUserReactsPublic200Response

reactFeedPostPublic

Parámetros

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

Respuesta

Devuelve: ReactFeedPostPublic200Response

updateFeedPost

Parámetros

Name	Tipo	Requerido
tenantId	string	Sí
id	string	Sí
feedPost	FeedPost	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

updateFeedPostPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
postId	string	Sí
updateFeedPostParams	UpdateFeedPostParams	Sí
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: CreateFeedPostPublic200Response

flagCommentPublic

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

addHashTag

Parameters

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

Response

Devuelve: AddHashTag200Response

Ejemplo

Ejemplo de addHashTag

Copy

const tenantId: string = 'tenant_7b2f6c2b';
const createBody: CreateHashTagBody = {
  tag: 'feature-request',
  label: 'Feature Request',
  description: 'Requests for new functionality in the web client',
  isActive: true,
  visibility: 'public',
  allowedDomains: ['example.com', 'internal.example.com']
};
const result: AddHashTag200Response = await addHashTag(tenantId, createBody);
const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {
  tag: 'bug',
  label: 'Bug',
  description: 'Use for reproducible bugs reported by users',
  isActive: true,
  visibility: 'public'
});

addHashTagsBulk

Parámetros

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

Respuesta

Devuelve: AddHashTagsBulk200Response

Ejemplo

Ejemplo de addHashTagsBulk

Copy

(async () => {
  const tenantId: string = 'tenant_3f2b9a';
  const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
    tags: [
      { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },
      { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }
    ]
  };
  const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
  const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);
  console.log(result, resultWithNoTenant);
})();

deleteHashTag

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteHashTag

Copy

const tag: string = 'breaking-news';
const tenantId: string = 'tenant_42';
const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);

getHashTags

Parámetros

Name	Type	Requerido	Description
tenantId	string	Sí
page	number	No

Respuesta

Devuelve: GetHashTags200Response

Ejemplo

Ejemplo de getHashTags

Copy

(async () => {
  const tenantId: string = "acme-corp-7a9f";
  const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);
  const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);
  console.log(tagsPage1, tagsPage2);
})();

patchHashTag

Parámetros

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

Respuesta

Devuelve: PatchHashTag200Response

Ejemplo

Ejemplo de patchHashTag

Copy

const tag: string = 'release-2026';
const tenantId: string = 'tenant_42';
const updateHashTagBody: UpdateHashTagBody = {
  displayName: 'Release 2026',
  description: 'Discussions and notes for the 2026 product release',
  isActive: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createModeratorBody	CreateModeratorBody	Sí

Respuesta

Devuelve: CreateModerator200Response

Ejemplo

Ejemplo de createModerator

Copy

const tenantId: string = "tenant_prod_us-east_01";
const createModeratorBody: CreateModeratorBody = {
  email: "maria.lopez+mod@fastcompany.com",
  username: "mlopez_mod",
  displayName: "Maria Lopez",
  roles: ["content_moderator"],
  notifyOnReports: true,
  metadata: { region: "us-east", team: "community" }
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteModerator

Copy

const tenantId: string = 'acme-tenant-987';
const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

getModerator

Parámetros

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

Respuesta

Devuelve: GetModerator200Response

Ejemplo

Ejemplo de getModerator

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // origen opcional (podría ser undefined)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

getModerators

Parámetros

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

Respuesta

Devuelve: GetModerators200Response

Ejemplo

Ejemplo de getModerators

Copy

const tenantId: string = "tenant_corp_7f9b2a";
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const skip: number = 50;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

sendInvite

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	Sí
fromName	string	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de sendInvite

Copy

const tenantId: string = 'acme-tenant-004';
const id: string = 'comment_9b7f3a2c';
const fromName: string = 'María Hernández';
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

updateModerator

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	Sí
updateModeratorBody	UpdateModeratorBody	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateModerator

Copy

const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';
const id: string = 'mod_92a7c4';
const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };
const updateModeratorBodyWithOptional: UpdateModeratorBody = {
  displayName: 'Sophia Patel',
  email: 'sophia.patel@newsroom.example',
  permissions: ['remove_comments', 'ban_user'],
  notifyOnFlag: true // parámetro opcional demostrado
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);

deleteNotificationCount

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteNotificationCount

Copy

const tenantId: string = 'tenant_7f3a1b2c4d9e';
const notificationId: string = 'notif_8c9d0a1b2f3e4b7';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);

getCachedNotificationCount

Parámetros

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

Respuesta

Devuelve: GetCachedNotificationCount200Response

Ejemplo

Ejemplo de getCachedNotificationCount

Copy

const tenantId: string = 'acme-tenant-01';
const baseNotificationId: string = 'notif-000123';
const idSuffix: string | undefined = undefined; // ejemplo de parámetro opcional
const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);
console.log(result);

getNotificationCount

Parámetros

Name	Type	Required
tenantId	string	Sí
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

Respuesta

Devuelve: GetNotificationCount200Response

Ejemplo

Ejemplo de getNotificationCount

Copy

const tenantId: string = 'tenant_8a9b7c';
const userId: string = 'user_42b3c';
const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';
const fromCommentId: string | undefined = undefined;
const viewed: boolean = false;
const type: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

getNotifications

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Respuesta

Devuelve: GetNotifications200Response

Ejemplo

Ejemplo de getNotifications

Copy

(async () => {
  const tenantId: string = 'tenant_8f3b1a2c';
  const userId: string = 'user_42';
  const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';
  const fromCommentId: string = 'cmt_9a7b';
  const viewed: boolean = false;
  const type: string = 'mention';
  const skip: number = 0;
  const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);
  console.log(response);
})();

updateNotification

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateNotification

Copy

const tenantId: string = "tenant_86a7b3";
const id: string = "notif_20260112_01";
const userId: string = "moderator_42";
const updateNotificationBody: UpdateNotificationBody = {
  name: "Flagged comment alert",
  enabled: true,
  channels: ["email"],
  recipients: ["mod-team@news-site.com"],
  threshold: 1
};
(async () => {
  const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);
  console.log(result);
})();

addPage

Parámetros

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

Respuesta

Devuelve: AddPageAPIResponse

deletePage

Parámetros

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

Respuesta

Devuelve: DeletePageAPIResponse

getPageByURLId

Parámetros

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

Respuesta

Devuelve: GetPageByURLIdAPIResponse

getPages

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetPagesAPIResponse

patchPage

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	Sí
updateAPIPageData	UpdateAPIPageData	Sí

Respuesta

Devuelve: PatchPageAPIResponse

deletePendingWebhookEvent

Parámetros

Name	Type	Obligatorio	Description
tenantId	string	Sí
id	string	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deletePendingWebhookEvent

Copy

const tenantId: string = 'tenant_7f4e2b';
const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);
console.log(result);

getPendingWebhookEventCount

Parámetros

Name	Type	Requerido
tenantId	string	Sí
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Respuesta

Devuelve: GetPendingWebhookEventCount200Response

Ejemplo

Ejemplo de getPendingWebhookEventCount

Copy

(async () => {
  const tenantId: string = 'tenant_9c3b2b';
  const commentId: string = 'cmt_f4a1b2';
  const externalId: string = 'ext-789';
  const eventType: string = 'comment.created';
  const type: string = 'delivery';
  const domain: string = 'app.example.com';
  const attemptCountGT: number = 2;
  const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
    tenantId,
    commentId,
    externalId,
    eventType,
    type,
    domain,
    attemptCountGT
  );
  console.log(result);
})();

getPendingWebhookEvents

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

Respuesta

Devuelve: GetPendingWebhookEvents200Response

Ejemplo

Ejemplo de getPendingWebhookEvents

Copy

const tenantId: string = "tenant_78b2f1";
const commentId: string = "cmt_0042";
const eventType: string = "comment.created";
const domain: string = "blog.example.com";
const attemptCountGT: number = 1;
const skip: number = 0;
const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined, // externalId
  eventType,
  undefined, // type
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createQuestionConfigBody	CreateQuestionConfigBody	Sí

Respuesta

Devuelve: CreateQuestionConfig200Response

Ejemplo

Ejemplo de createQuestionConfig

Copy

const tenantId: string = "tenant_live_7f8b3c2a";
const customOptions: QuestionConfigCustomOptionsInner[] = [
  { value: "under18", label: "Under 18" },
  { value: "18-24", label: "18-24" },
  { value: "25-34", label: "25-34", defaultSelected: true }
];
const createQuestionConfigBody: CreateQuestionConfigBody = {
  key: "age_range",
  label: "What is your age range?",
  required: false, // opcional: demostrar campos opcionales omitidos vs incluidos
  renderingType: QuestionRenderingType.Dropdown,
  options: customOptions,
  whenSave: QuestionWhenSave.Always
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteQuestionConfig

Copy

async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {
  if (!id) return null;
  const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);
  return result;
}
const tenantId: string = 'tenant_acme_001';
const optionalConfigId: string | undefined = 'qcfg_20260112_01';
(async (): Promise<void> => {
  const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);
  void deleted;
})();

getQuestionConfig

Parámetros

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

Respuesta

Devuelve: GetQuestionConfig200Response

Ejemplo

Ejemplo de getQuestionConfig

Copy

const tenantId: string = 'acme-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata es opcional; implementación omitida por brevedad
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

getQuestionConfigs

Parámetros

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

Respuesta

Devuelve: GetQuestionConfigs200Response

Ejemplo

Ejemplo de getQuestionConfigs

Copy

const tenantId: string = 'tenant-42a7b9';
const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);

updateQuestionConfig

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateQuestionConfig

Copy

const tenantId: string = 'tenant-82b3a';
const id: string = 'qst-20260112';
const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parámetros

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

Respuesta

Devuelve: CreateQuestionResult200Response

Ejemplo

Ejemplo de createQuestionResult

Copy

const tenantId: string = "fc_tenant_7a3c_us-east-1";
const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "q_42",
  commenterId: "user_1984",
  answer: "yes",
  score: 4,
  meta: [metaItem] // metadatos opcionales demostrados
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteQuestionResult

Copy

const tenantId: string = 'acme-tenant-01';
const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';
const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);
console.log(deletedResult);

getQuestionResult

Parámetros

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

Respuesta

Devuelve: GetQuestionResult200Response

Ejemplo

Ejemplo de getQuestionResult

Copy

const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
const questionId: string = "question_72f1b9c3a4";
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
console.log(result);

getQuestionResults

Parámetros

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

Respuesta

Devuelve: GetQuestionResults200Response

Ejemplo

Ejemplo de getQuestionResults

Copy

const tenantId: string = 'tenant_42';
const urlId: string = 'news/2025/fastcomments-release';
const userId: string = 'user_8b7f3c';
const startDate: string = '2025-01-01T00:00:00Z';
const questionIds: string = 'q123,q124';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

updateQuestionResult

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	Sí
updateQuestionResultBody	UpdateQuestionResultBody	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateQuestionResult

Copy

const tenantId: string = 'tenant_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // parámetro opcional incluido
};
const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Respuesta

Devuelve: AggregateQuestionResults200Response

bulkAggregateQuestionResults

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Sí
forceRecalculate	boolean	No

Respuesta

Devuelve: BulkAggregateQuestionResults200Response

combineCommentsWithQuestionResults

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

Respuesta

Devuelve: CombineCommentsWithQuestionResults200Response

addSSOUser

Parámetros

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

Respuesta

Devuelve: AddSSOUserAPIResponse

deleteSSOUser

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	Sí
deleteComments	boolean	No
commentDeleteMode	string	No

Respuesta

Devuelve: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parámetros

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

Respuesta

Devuelve: GetSSOUserByEmailAPIResponse

getSSOUserById

Parámetros

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

Respuesta

Devuelve: GetSSOUserByIdAPIResponse

getSSOUsers

Parámetros

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

Respuesta

Devuelve: GetSSOUsers200Response

patchSSOUser

Parámetros

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

Respuesta

Devuelve: PatchSSOUserAPIResponse

putSSOUser

Parámetros

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

Respuesta

Devuelve: PutSSOUserAPIResponse

createSubscription

Parámetros

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

Respuesta

Devuelve: CreateSubscriptionAPIResponse

deleteSubscription

Parámetros

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

Respuesta

Devuelve: DeleteSubscriptionAPIResponse

getSubscriptions

Parámetros

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

Respuesta

Devuelve: GetSubscriptionsAPIResponse

getTenantDailyUsages

Parámetros

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

Respuesta

Devuelve: GetTenantDailyUsages200Response

Ejemplo

Ejemplo de getTenantDailyUsages

Copy

const tenantId: string = "tenant_89f3c2-prod";
const yearNumber: number = 2026;
const monthNumber: number = 1;
const skip: number = 0;
const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

createTenantPackage

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createTenantPackageBody	CreateTenantPackageBody	Sí

Respuesta

Devuelve: CreateTenantPackage200Response

Ejemplo

Ejemplo de createTenantPackage

Copy

const tenantId: string = "tenant_7f3b1a9c";
const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };
const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Premium Plus",
  tenantPackage,
  customConfig,
  notes: "Enable advanced moderation and image uploads" // parámetro opcional mostrado
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

deleteTenantPackage

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteTenantPackage

Copy

const tenantId: string = 'fc-tenant-8a9c2b';
const packageId: string = 'pkg-47f3c9';
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parámetros

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

Respuesta

Devuelve: GetTenantPackage200Response

Ejemplo

Ejemplo de getTenantPackage

Copy

const tenantId: string = 'tenant_westus_01';
const packageId: string = 'pkg_premium_annual_2026';
interface FetchOptions { includeArchived?: boolean }
const options: FetchOptions = { includeArchived: false };
const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
skip	number	No

Respuesta

Devuelve: GetTenantPackages200Response

Ejemplo

Ejemplo de getTenantPackages

Copy

const tenantId: string = 'tenant_4f3a9c2d';
const skip: number = 25;
const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);
const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

replaceTenantPackage

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de replaceTenantPackage

Copy

const tenantId: string = 'tenant-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // campos opcionales como "notes" o "trialExpiry" se omiten intencionalmente aquí
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

updateTenantPackage

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateTenantPackage

Copy

const tenantId: string = 'tenant_8a4f1c9b';
const packageId: string = 'pkg_premium_v2';
const customConfig: CustomConfigParameters = { enableRichText: true, maxImagesPerComment: 5 };
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Premium Moderation Package',
  enabled: true,
  description: 'Adds advanced spam rules, image moderation and priority support',
  customConfigParameters: customConfig
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, packageId, updateTenantPackageBody);

createTenantUser

Parámetros

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

Respuesta

Devuelve: CreateTenantUser200Response

Ejemplo

Ejemplo de createTenantUser

Copy

const tenantId: string = "tenant_9a8c7e4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "julia.smith@acme-corp.com",
  displayName: "Julia Smith",
  role: "moderator",
  password: "Str0ngP@ssword!23",
  sendInviteEmail: true, // parámetro opcional demostrado
  locale: "en-US",
  metadata: { department: "Customer Success" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

deleteTenantUser

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteTenantUser

Copy

const tenantId: string = 'tenant_8f3b2a9c';
const id: string = 'user_4e5f6a7b';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'hard';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

getTenantUser

Parámetros

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

Respuesta

Devuelve: GetTenantUser200Response

Ejemplo

Ejemplo de getTenantUser

Copy

const tenantId: string = "tenant_9f7d4b2a-1c3e";
const id: string = "user_6a12b3c4d5";
const includeProfile: boolean | undefined = true; // ejemplo de parámetro opcional
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log("Tenant user fetched", response);

getTenantUsers

Parámetros

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

Respuesta

Devuelve: GetTenantUsers200Response

Ejemplo

Ejemplo de getTenantUsers

Copy

const tenantId: string = 'tenant_8f3b2c1a';
const skip: number = 50;
const firstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
const nextPage: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

replaceTenantUser

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

replaceTenantUser Ejemplo

Copy

const tenantId: string = "tenant_5f8b9a";
const id: string = "user_92bf21";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "jane.doe@acme-corp.com",
  displayName: "Jane Doe",
  externalId: "acme|12345",
  roles: ["commenter", "moderator"],
  isActive: true,
  metadata: { team: "product", location: "NYC" }
};
const updateComments: string = "Update historical comments to reflect new display name";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de sendLoginLink

Copy

const tenantId: string = 'tenant_acme_01';
const id: string = 'user_9f3b2a';
const redirectURL: string = 'https://app.example.com/onboard?source=login-email';
const result: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

updateTenantUser

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateTenantUser

Copy

const tenantId: string = 'tenant_84f3b2';
const id: string = 'user_7a9d1c';
const updateComments: string = 'Promoted to moderator and updated contact email';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe+mod@example.com',
  displayName: 'Jane D.',
  roles: ['moderator'],
  isBanned: false,
  metadata: { department: 'community' }
};
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

createTenant

Parámetros

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

Respuesta

Devuelve: CreateTenant200Response

Ejemplo

Ejemplo de createTenant

Copy

const tenantId: string = "acme-corporation";
const billing: BillingInfo = { planId: "pro", billingContactEmail: "finance@acme-corp.com", currency: "USD" };
const domainConfig: APIDomainConfiguration = { primaryDomain: "comments.acme-corp.com", allowedDomains: ["acme-corp.com", "www.acme-corp.com"], enforceHttps: true };
const importedSites: ImportedSiteType[] = [{ siteId: "site-001", url: "https://blog.acme-corp.com", name: "Acme Blog" }]; // optional
const createBody: CreateTenantBody = { tenantName: "Acme Corporation", adminEmail: "admin@acme-corp.com", billingInfo: billing, domainConfiguration: domainConfig, importedSites, enableModeration: true };
const response: CreateTenant200Response = await createTenant(tenantId, createBody);

deleteTenant

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteTenant

Copy

const tenantId: string = "tenant_7b3f1a9e";
const id: string = "flag_9c4d2b1a";
const sure: string = "yes_confirm_delete";
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);
console.log(result);

getTenant

Parámetros

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

Respuesta

Devuelve: GetTenant200Response

Ejemplo

Ejemplo de getTenant

Copy

const tenantId: string = "tenant_acme_corp";
const id: string = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
interface GetOptions { includeDeleted?: boolean; locale?: string; }
const options: GetOptions = { locale: "en-US" };
const result: GetTenant200Response = await getTenant(tenantId, id);

getTenants

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
meta	string	No
skip	number	No

Respuesta

Devuelve: GetTenants200Response

Ejemplo

Ejemplo de getTenants

Copy

(async () => {
  const tenantId: string = 'tenant_9f2d1b7c';
  const meta: string = 'include=domains,billing,customConfig';
  const skip: number = 20;
  const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
  console.log(response);
})();

updateTenant

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateTenant

Copy

const tenantId: string = "tenant_01H4ZQ7KABCD";
const id: string = "site_9f8e7d6c";
const apiDomainConfiguration: APIDomainConfiguration = {
  primaryDomain: "comments.acme.com",
  allowSubdomains: true
};
const billingInfo: BillingInfo = {
  planName: "Business",
  billingContactEmail: "billing@acme.com",
  seats: 25
};
const updateTenantBody: UpdateTenantBody = {
  displayName: "Acme Corporation Comments",
  apiDomainConfiguration,
  billingInfo, // parámetro opcional demostrado
  enableModeration: true
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

uploadImage

Subir y redimensionar una imagen

Parámetros

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

Respuesta

Devuelve: UploadImageResponse

getUserBadgeProgressById

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressById200Response

getUserBadgeProgressByUserId

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressById200Response

getUserBadgeProgressList

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressList200Response

createUserBadge

Parámetros

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

Respuesta

Devuelve: CreateUserBadge200Response

deleteUserBadge

Parámetros

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

Respuesta

Devuelve: UpdateUserBadge200Response

getUserBadge

Parámetros

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

Respuesta

Devuelve: GetUserBadge200Response

getUserBadges

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

Respuesta

Devuelve: GetUserBadges200Response

updateUserBadge

Parámetros

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

Respuesta

Devuelve: UpdateUserBadge200Response

getUserNotificationCount

Parámetros

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

Respuesta

Devuelve: GetUserNotificationCount200Response

getUserNotifications

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
sso	string	No

Respuesta

Devuelve: GetUserNotifications200Response

resetUserNotificationCount

Parámetros

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

Respuesta

Devuelve: ResetUserNotifications200Response

resetUserNotifications

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Respuesta

Devuelve: ResetUserNotifications200Response

updateUserNotificationCommentSubscriptionStatus

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

Parámetros

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

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

updateUserNotificationPageSubscriptionStatus

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

Parámetros

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

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

updateUserNotificationStatus

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
notificationId	string	Sí
newStatus	UpdateUserNotificationStatusNewStatusEnum	Sí
sso	string	No

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

getUserPresenceStatuses

Parámetros

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

Respuesta

Devuelve: GetUserPresenceStatuses200Response

searchUsers

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
usernameStartsWith	string	Sí
mentionGroupIds	Array	No
sso	string	No

Respuesta

Devuelve: SearchUsers200Response

getUser

Parámetros

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

Respuesta

Devuelve: GetUser200Response

Ejemplo

Ejemplo de getUser

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // puede ser undefined en algunos flujos (opcional)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

createVote

Parámetros

Name	Type	Required
tenantId	string	Sí
commentId	string	Sí
direction	CreateVoteDirectionEnum	Sí
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: VoteComment200Response

Ejemplo

Ejemplo de createVote

Copy

(async () => {
  const tenantId: string = 'acme-tenant-812';
  const commentId: string = '5e8f8b7a-3d4b-4f1b-9a2e-1c9f2d6a7b8c';
  const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.UP;
  const anonUserId: string = 'anon-84b9c2d';
  const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);
  console.log(voteResult);
})();

deleteVote

Parámetros

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

Respuesta

Devuelve: DeleteCommentVote200Response

Ejemplo

Ejemplo de deleteVote

Copy

const tenantId: string = 'tenant_7f3b21c9';
const id: string = 'vote_4a2d9f1b';
const editKey: string = 'edit_92b7c6a1';
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);

getVotes

Parámetros

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

Respuesta

Devuelve: GetVotes200Response

Ejemplo

Ejemplo de getVotes

Copy

const tenantId: string = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// Si existiera un parámetro opcional, p. ej. includeHidden, podría usarse así:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

getVotesForUser

Parámetros

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

Respuesta

Devuelve: GetVotesForUser200Response

Ejemplo

Ejemplo de getVotesForUser

Copy

const tenantId: string = 'tenant_acme_01';
const urlId: string = 'news/2026/01/12/product-launch';
const userId: string = 'user_9c3f2b';
const anonUserId: string = 'anon_d4e7a1';
const votesForUser: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId);
const votesForAnon: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, undefined, anonUserId);

¿Necesitas ayuda?

Si encuentras algún problema o tienes preguntas sobre el SDK de JavaScript/TypeScript, por favor:

Contribuciones

¡Las contribuciones son bienvenidas! Visita el repositorio de GitHub para las pautas de contribución.

Idioma 🇪🇸 Español

Introducción

Referencia de la API

Documentación

Uso

Agregación

Registros de auditoría

Bloquear desde comentario

Comprobar comentarios bloqueados

Comentarios

Configuraciones de dominio

Plantillas de correo

Registro de eventos

Publicaciones del feed

Marcar comentario

Hashtags

Moderadores

Conteo de notificaciones

Notificaciones

Páginas

Eventos de webhook pendientes

Configuraciones de preguntas

Resultados de preguntas

Agregación de resultados de preguntas

Usuarios SSO

Suscripciones

Uso diario del tenant

Paquetes del tenant

Usuarios del tenant

Tenants

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones de usuario

Estado de presencia de usuario

Búsqueda de usuarios

Usuarios

Votos

FastComments JavaScript/TypeScript SDK

Repositorio

Instalación

Documentación de la API

Referencia completa de la API: docs/api/README.md

Compatibilidad Navegador vs Servidor

Uso

Browser Usage (Client-Side)

Server Usage (Node.js)

Types Only Import

Using Individual API Classes

Browser Environment

Server Environment

APIs públicas vs seguras

Ejemplo: Uso de la API pública (segura para navegadores)

Ejemplo: Uso de Default API (solo del lado del servidor)

Integración SSO (Inicio de sesión único)

SSO simple (solo en el servidor)

SSO seguro (lado del servidor, recomendado)

Uso de SSO desde el navegador (con token generado por el servidor)

SSO con creación de comentarios

Casos de uso comunes

Obtener comentarios para una página

Crear un comentario

Votar en un comentario

Gestión de usuarios (requiere clave de API)

Eventos en vivo (Actualizaciones en tiempo real)

Eventos a nivel de página

Suscribirse a eventos de usuario

Obtener userIdWS

IDs de transmisión

Manejo de errores

aggregate

Parámetros

Respuesta

getAuditLogs

Parámetros

Respuesta

blockFromCommentPublic

Parámetros

Respuesta

unBlockCommentPublic