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

Ejemplo

Ejemplo de getAuditLogs

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_9b8f6c';
  const limit: number = 50;
  const skip: number = 0;
  const order: SORTDIR = 'desc';
  const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000;
  const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after);
  console.log(response);
}
main();

blockFromCommentPublic

Parámetros

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

Respuesta

Devuelve: BlockFromCommentPublic200Response

Ejemplo

Ejemplo de blockFromCommentPublic

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

unBlockCommentPublic

Parámetros

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

Respuesta

Devuelve: UnBlockCommentPublic200Response

Ejemplo

Ejemplo de unBlockCommentPublic

Copy

const tenantId: string = 'tenant_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

checkedCommentsForBlocked

Parámetros

Name	Type	Required
tenantId	string	Sí
commentIds	string	Sí
sso	string	No

Respuesta

Devuelve: CheckedCommentsForBlocked200Response

Ejemplo

Ejemplo de checkedCommentsForBlocked

Copy

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

blockUserFromComment

Parámetros

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

Respuesta

Devuelve: BlockFromCommentPublic200Response

Ejemplo

Ejemplo blockUserFromComment

Copy

const tenantId: string = "tenant_12345";
const id: string = "comment_67890";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated abusive language",
  blockDurationHours: 168,
  blockReplies: true,
  notifyAuthor: true
};
const userId: string = "user_abc123";
const anonUserId: string = "anon_xyz789";
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

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

Ejemplo

Ejemplo de createCommentPublic

Copy

const tenantId: string = 'tenant_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Parámetros

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

Respuesta

Devuelve: DeleteComment200Response

Ejemplo

Ejemplo de deleteComment

Copy

const tenantId: string = 'tenant_7b3f2a';
const commentId: string = 'cmt_8a1f4d2b';
const contextUserId: string = 'user_102';
const isLive: boolean = true;
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

deleteCommentPublic

Parámetros

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

Respuesta

Devuelve: DeleteCommentPublic200Response

Ejemplo

Ejemplo de deleteCommentPublic

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(
  tenantId,
  commentId,
  broadcastId,
  editKey,
  sso
);

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

Ejemplo

Ejemplo de deleteCommentVote

Copy

const tenantId: string = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: DeleteCommentVote200Response = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  sso
);

flagComment

Parámetros

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

Respuesta

Devuelve: FlagComment200Response

Ejemplo

flagComment Ejemplo

Copy

const tenantId: string = 'tenant_acme_001';
const id: string = 'comment_7f3a2b9e';
const userId: string = 'user_jdoe_1001';
const anonUserId: string = 'anon_3f2b_visitor';
const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

getComment

Parámetros

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

Respuesta

Devuelve: GetComment200Response

Ejemplo

Ejemplo de getComment

Copy

const tenantId: string = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

getComments

Parámetros

Name	Type	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

Ejemplo

Ejemplo de getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // página
  20, // límite
  0, // omitir
  true, // como árbol
  1, // omitir hijos
  3, // límite de hijos
  4, // profundidad máxima del árbol
  'articles/2026/new-product-launch', // id de la URL
  'user_7890', // id de usuario
  'anon_4f3b2', // id de usuario anónimo
  undefined, // id de usuario en contexto
  '#launch', // etiqueta hash
  undefined // id del comentario padre
);

getCommentsPublic

req tenantId urlId

Parámetros

Name	Type	Requerido
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

Ejemplo

Ejemplo de getCommentsPublic

Copy

const tenantId: string = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

getCommentText

Parámetros

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

Respuesta

Devuelve: GetCommentText200Response

Ejemplo

Ejemplo de getCommentText

Copy

const tenantId: string = 'tenant_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

getCommentVoteUserNames

Parámetros

Name	Type	Requerido
tenantId	string	Sí
commentId	string	Sí
dir	number	Sí
sso	string	No

Respuesta

Devuelve: GetCommentVoteUserNames200Response

Ejemplo

Ejemplo de getCommentVoteUserNames

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

lockComment

Parámetros

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

Respuesta

Devuelve: LockComment200Response

Ejemplo

Ejemplo de lockComment

Copy

const tenantId: string = "tenant_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

pinComment

Parámetros

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

Respuesta

Devuelve: PinComment200Response

Ejemplo

Ejemplo de pinComment

Copy

const tenantId: string = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

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

Ejemplo

Ejemplo de saveComment

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

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

Ejemplo

Ejemplo de saveCommentsBulk

Copy

const tenantId: string = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

setCommentText

Parámetros

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

Respuesta

Devuelve: SetCommentText200Response

Ejemplo

Ejemplo de setCommentText

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

unBlockUserFromComment

Parámetros

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

Respuesta

Devuelve: UnBlockCommentPublic200Response

Ejemplo

Ejemplo de unBlockUserFromComment

Copy

const tenantId: string = 'tenant_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

unFlagComment

Parámetros

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

Respuesta

Devuelve: FlagComment200Response

Ejemplo

Ejemplo de unFlagComment

Copy

const tenantId: string = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

unLockComment

Parámetros

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

Respuesta

Devuelve: LockComment200Response

Ejemplo

Ejemplo de unLockComment

Copy

const tenantId: string = 'tenant_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

unPinComment

Parámetros

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

Respuesta

Devuelve: PinComment200Response

Ejemplo

Ejemplo de unPinComment

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

updateComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
id	string	Sí
updatableCommentParams	UpdatableCommentParams	Sí
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateComment

Copy

const tenantId: string = "tenant_acme_corp_01";
const id: string = "comment_20260325_4592";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",
  editedByUserId: "user_8721",
  isVisible: true
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

voteComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
urlId	string	Sí
broadcastId	string	Sí
voteBodyParams	VoteBodyParams	Sí
sessionId	string	No
sso	string	No

Respuesta

Devuelve: VoteComment200Response

Ejemplo

Ejemplo de voteComment

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

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	Obligatorio	Descripción
tenantId	string	Sí
createEmailTemplateBody	CreateEmailTemplateBody	Sí

Respuesta

Devuelve: CreateEmailTemplate200Response

Ejemplo

Ejemplo de createEmailTemplate

Copy

const tenantId: string = "tenant_7a9f3c2b";
const customConfig: CustomConfigParameters = { smtpHost: "smtp.fastmail.com", smtpPort: 587, useTLS: true };
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Account Notification",
  subject: "Your ACME account was updated",
  fromEmail: "no-reply@acme-corp.com",
  replyTo: "support@acme-corp.com",
  html: "<p>Hi {{user.firstName}}, your account settings were changed.</p>",
  text: "Hi {{user.firstName}}, your account settings were changed.",
  isActive: true,
  description: "Used for transactional account update emails",
  customConfig
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteEmailTemplate

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // ejemplo de parámetro opcional
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parámetros

Name	Type	Required
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteEmailTemplateRenderError

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // selector de entorno opcional
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

getEmailTemplate

Parámetros

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

Respuesta

Devuelve: GetEmailTemplate200Response

Ejemplo

Ejemplo de getEmailTemplate

Copy

const tenantId: string = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

getEmailTemplateDefinitions

Parámetros

Name	Type	Required	Description
tenantId	string	Sí

Respuesta

Devuelve: GetEmailTemplateDefinitions200Response

Ejemplo

Ejemplo de getEmailTemplateDefinitions

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

getEmailTemplateRenderErrors

Parámetros

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

Respuesta

Devuelve: GetEmailTemplateRenderErrors200Response

Ejemplo

Ejemplo de getEmailTemplateRenderErrors

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

getEmailTemplates

Parámetros

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

Respuesta

Devuelve: GetEmailTemplates200Response

Ejemplo

Ejemplo de getEmailTemplates

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

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 = 'tenant_b6f3c2';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'comment-notification',
  recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },
  context: {
    siteName: 'City Gazette',
    commentText: 'Thanks for the in-depth coverage — very helpful.',
    articleTitle: 'Downtown Redevelopment Plan Advances',
    threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'
  }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateEmailTemplate

Copy

const tenantId: string = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parámetros

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

Respuesta

Devuelve: GetEventLog200Response

Ejemplo

Ejemplo de getEventLog

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // valor upstream opcional
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

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

Ejemplo

Ejemplo de getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // hace 7 días
const endTimeOptional: number | undefined = undefined; // fin del período opcional
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parámetros

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

Response

Devuelve: CreateFeedPost200Response

Ejemplo

Ejemplo de createFeedPost

Copy

const tenantId: string = "tenant_7f3b9a";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — March 2026",
  body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",
  authorId: "user_86fa2b",
  allowComments: true,
  media: [
    {
      url: "https://cdn.example.com/images/update-march.png",
      mimeType: "image/png",
      caption: "Performance graph",
      assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]
    }
  ],
  links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]
};
const broadcastId: string = "broadcast_prod_updates_202603";
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

createFeedPostPublic

Parámetros

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

Respuesta

Devuelve: CreateFeedPostPublic200Response

Ejemplo

Ejemplo de createFeedPostPublic

Copy

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

deleteFeedPostPublic

Parámetros

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

Respuesta

Devuelve: DeleteFeedPostPublic200Response

Ejemplo

Ejemplo de deleteFeedPostPublic

Copy

const tenantId: string = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

getFeedPosts

req tenantId afterId

Parámetros

Name	Type	Required
tenantId	string	Sí
afterId	string	No
limit	number	No
tags	Array	No

Respuesta

Devuelve: GetFeedPosts200Response

Ejemplo

Ejemplo de getFeedPosts

Copy

const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

getFeedPostsPublic

req tenantId afterId

Parámetros

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

Respuesta

Devuelve: GetFeedPostsPublic200Response

Ejemplo

Ejemplo de getFeedPostsPublic

Copy

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

getFeedPostsStats

Parámetros

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

Respuesta

Devuelve: GetFeedPostsStats200Response

Ejemplo

Ejemplo de getFeedPostsStats

Copy

const tenantId: string = 'tenant_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

getUserReactsPublic

Parámetros

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

Respuesta

Devuelve: GetUserReactsPublic200Response

Ejemplo

Ejemplo de getUserReactsPublic

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

reactFeedPostPublic

Parámetros

Name	Type	Required
tenantId	string	Sí
postId	string	Sí
reactBodyParams	ReactBodyParams	Sí
isUndo	boolean	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: ReactFeedPostPublic200Response

Ejemplo

Ejemplo de reactFeedPostPublic

Copy

const tenantId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const postId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍', source: 'web' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast-2026-03-25-001';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, sso);

updateFeedPost

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateFeedPost

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // array opcional incluido
  links: [link],          // enlaces opcionales incluidos
  isPublished: true       // indicador de publicación opcional usado aquí
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Parámetros

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

Respuesta

Devuelve: CreateFeedPostPublic200Response

Ejemplo

Ejemplo de updateFeedPostPublic

Copy

const tenantId: string = "tenant_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

flagCommentPublic

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de flagCommentPublic

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

addHashTag

Parámetros

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

Respuesta

Devuelve: AddHashTag200Response

Ejemplo

Ejemplo de addHashTag

Copy

const tenantId: string = 'tenant_acme_01';
const createHashTagBody: CreateHashTagBody = {
  name: 'feature-request',
  label: 'Feature Request',
  color: '#FF5722',
  enabled: true
};
const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);
const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBody);

addHashTagsBulk

Parámetros

Name	Type	Required	Description
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Respuesta

Devuelve: AddHashTagsBulk200Response

Ejemplo

Ejemplo de addHashTagsBulk

Copy

// Crear identificador de tenant (parámetro opcional)
const tenantId: string = "tenant_9f8c2b7a";
// Preparar entradas individuales de etiquetas
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Cuerpo para creación masiva (parámetro opcional)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Llamar a la función async global y asignar el resultado tipado
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

deleteHashTag

Parámetros

Nombre	Tipo	Requerido
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_12345";
const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

getHashTags

Parámetros

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

Respuesta

Devuelve: GetHashTags200Response

Ejemplo

Ejemplo de getHashTags

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

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 = "feature-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parámetros

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

Respuesta

Devuelve: CreateModerator200Response

Ejemplo

Ejemplo de createModerator

Copy

const tenantId: string = 'tenant_7d9f2b4a';
const customConfig: CustomConfigParameters = { timezone: 'UTC', moderationQueueEnabled: true };
const createModeratorBody: CreateModeratorBody = {
  email: 'jane.martin@publisher.com',
  displayName: 'Jane Martin',
  roles: ['moderator'],
  sendWelcomeEmail: true,
  customConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteModerator

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

getModerator

Parámetros

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

Respuesta

Devuelve: GetModerator200Response

Ejemplo

Ejemplo de getModerator

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Parámetros

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

Respuesta

Devuelve: GetModerators200Response

Ejemplo

Ejemplo de getModerators

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

sendInvite

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de sendInvite

Copy

const tenantId: string = 'tenant_acme-42';
const id: string = 'comment_8f3b21a7';
const fromName: string = 'Elena Morales';
const replyToEmail: string | undefined = undefined;
const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

updateModerator

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateModerator

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // campo opcional demostrado
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

deleteNotificationCount

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteNotificationCount

Copy

const tenantSuffix: string | undefined = undefined;
const tenantId: string = tenantSuffix ? `tenant-${tenantSuffix}` : 'tenant-9142a7';
const id: string = '3f9b2a44-1c2e-4d3b-9f6a-8e7c6d5b2a1f';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

getCachedNotificationCount

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Respuesta

Devuelve: GetCachedNotificationCount200Response

Ejemplo

Ejemplo de getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // bandera de parámetro opcional (demostrado)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

getNotificationCount

Parámetros

Name	Type	Requerido
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_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, 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

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

updateNotification

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateNotification

Copy

const tenantId: string = 'tenant_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

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	Required	Description
tenantId	string	Sí
id	string	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deletePendingWebhookEvent

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // ejemplo de parámetro opcional (no requerido por la función)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

Parámetros

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

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

getPendingWebhookEvents

Parámetros

Nombre	Tipo	Requerido
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_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parámetros

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

Respuesta

Devuelve: CreateQuestionConfig200Response

Ejemplo

Ejemplo de createQuestionConfig

Copy

const tenantId: string = "tenant_9f8b2c";
const option: QuestionConfigCustomOptionsInner = { id: "opt_yes", label: "Yes, helpful", value: "yes" };
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Article usefulness",
  prompt: "Was this article helpful?",
  type: "singleChoice",
  required: false, // parámetro opcional demostrado
  options: [option],
  saveBehavior: "immediate"
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteQuestionConfig

Copy

const tenantId: string = "acme-enterprises-01";
const idOptional: string | undefined = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const id: string = idOptional ?? "11111111-1111-1111-1111-111111111111";
const response: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

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-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

getQuestionConfigs

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
skip	number	No

Respuesta

Devuelve: GetQuestionConfigs200Response

Ejemplo

Ejemplo de getQuestionConfigs

Copy

const tenantId: string = "tenant_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

updateQuestionConfig

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

updateQuestionConfig Example

Copy

const tenantId: string = 'tenant_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parámetros

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

Respuesta

Devuelve: CreateQuestionResult200Response

Ejemplo

Ejemplo de createQuestionResult

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // metadatos opcionales
  note: "Follow-up requested" // parámetro opcional demostrado
};
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 = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // parámetro opcional que demuestra la selección alternativa de destino
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

getQuestionResult

Parámetros

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

Respuesta

Devuelve: GetQuestionResult200Response

Ejemplo

Ejemplo de getQuestionResult

Copy

const post: { title: string; questionId?: string } = { title: 'Product feedback' };
const tenantId: string = 'acme-corp-tenant-01';
const id: string = post.questionId ?? 'q-8f3a7b2c4d9e';
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);

getQuestionResults

Parámetros

Nombre	Tipo	Obligatorio
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_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, 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_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // metadatos opcionales
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parámetros

Name	Type	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

Ejemplo

Ejemplo de aggregateQuestionResults

Copy

const tenantId: string = 'tenant_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // questionId omitido, usando questionIds en su lugar
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

bulkAggregateQuestionResults

Parámetros

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

Respuesta

Devuelve: BulkAggregateQuestionResults200Response

Ejemplo

Ejemplo de bulkAggregateQuestionResults

Copy

const tenantId: string = "tenant_live_7c9d";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    { questionId: "q_feedback_rating", includeSubQuestions: false, filters: { locale: "en-US" } }
  ],
  timeBuckets: [
    { granularity: "day", startUtc: "2026-03-01T00:00:00Z", endUtc: "2026-03-15T00:00:00Z" }
  ]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

combineCommentsWithQuestionResults

Parámetros

Name	Type	Requerido
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

Ejemplo

Ejemplo de combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant_9f3a2';
const questionIds: string[] = ['question-42', 'question-43'];
const urlId: string = 'url_5d7b';
const startDate: Date = new Date('2026-02-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

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

Ejemplo

Ejemplo de createSubscription

Copy

const tenantId: string = "acme-corp-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "u_987654",
  planId: "pro_monthly",
  startDate: new Date().toISOString(),
  trialDays: 14, // parámetro opcional demostrado
  metadata: { source: "marketing-email" } // parámetro opcional demostrado
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
const subscription: APIUserSubscription = result.subscription;

deleteSubscription

Parámetros

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

Respuesta

Devuelve: DeleteSubscriptionAPIResponse

getSubscriptions

Parámetros

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

Respuesta

Devuelve: GetSubscriptionsAPIResponse

Ejemplo

Ejemplo de getSubscriptions

Copy

const tenantId: string = 'tenant_acme_corp_01';
const userId: string = 'user_76a3b9f2';
const subscriptionsForUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
const subscriptionsForTenant: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);

updateSubscription

Parámetros

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

Respuesta

Devuelve: UpdateSubscriptionAPIResponse

Ejemplo

Ejemplo de updateSubscription

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

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_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, 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_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // parámetro opcional proporcionado
  // campos opcionales omitidos: p. ej., advanced moderation rules, custom CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // valor ilustrativo; utiliza la forma CustomConfigParameters
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de deleteTenantPackage

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // parámetros opcionales demostrados
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_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parámetros

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

Respuesta

Devuelve: GetTenantPackages200Response

Ejemplo

Ejemplo de getTenantPackages

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: 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-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

updateTenantPackage

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // campos opcionales omitidos intencionalmente (p. ej., description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, 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_6f4b2c';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'sara.kim@example.com',
  displayName: 'Sara Kim',
  role: 'moderator',
  notifyOnMentions: true
};
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 = '4f3a9b2e-1c6a-4f7b-9e2a-0b8d6f1c2a3e';
const userId: string = '9d2f7b3a-5c4e-48a2-b1f0-6c7d8e9f0a12';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'permanent';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, userId, deleteComments, commentDeleteMode);

getTenantUser

Parámetros

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

Respuesta

Devuelve: GetTenantUser200Response

Ejemplo

Ejemplo de getTenantUser

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // accediendo a la carga útil
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

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_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

replaceTenantUser

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de replaceTenantUser

Copy

const tenantId: string = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
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_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

updateTenantUser

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateTenantUser

Copy

const tenantId: string = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

createTenant

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createTenantBody	CreateTenantBody	Sí

Respuesta

Devuelve: CreateTenant200Response

Ejemplo

Ejemplo de createTenant

Copy

const tenantId: string = "acme-corp-001";
const createTenantBody: CreateTenantBody = {
  name: "Acme Corporation",
  domain: "comments.acme.com",
  adminContact: { name: "Jane Doe", email: "jane.doe@acme.com" },
  billingInfo: { planId: "pro-monthly", billingContactEmail: "billing@acme.com" },
  importedSite: { siteId: "site-123", siteName: "Acme Blog" } // sitio importado opcional
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

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_7f3d2c";
const id: string = "flag_8392b1a7";
const sure: string = "confirmed";
const responseWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const responseWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

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_9f4b2c1a";
const idOverride: string | undefined = undefined; // anulación opcional, si está disponible
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

getTenants

Parámetros

Name	Type	Required
tenantId	string	Sí
meta	string	No
skip	number	No

Respuesta

Devuelve: GetTenants200Response

Ejemplo

Ejemplo de getTenants

Copy

const tenantId: string = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

updateTenant

Parámetros

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

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // opcional, omitir para conservar la facturación actual
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	Sí
id	string	Sí
changeTicketStateBody	ChangeTicketStateBody	Sí

Respuesta

Devuelve: ChangeTicketState200Response

Ejemplo

Ejemplo de changeTicketState

Copy

const tenantId: string = 'tenant_82f9b3';
const userId: string = 'user_9472';
const id: string = 'ticket_550e8400-e29b-41d4-a716-446655440000';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'resolved',
  comment: 'Confirmed fix deployed to production; closing ticket.',
  notifySubscribers: true
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

createTicket

Parámetros

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

Respuesta

Devuelve: CreateTicket200Response

Ejemplo

Ejemplo de createTicket

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_72b9f4";
const createTicketBody: CreateTicketBody = {
  subject: "Subscription renewal failed for card on file",
  description: "Customer's card was declined by the payment processor during automatic renewal. Transaction ID: txn_9a8b7c. Please review gateway logs and retry.",
  priority: "high", // campo opcional (demostrado)
  contactEmail: "billing@acme-corp.com", // información de contacto opcional
  relatedUrl: "https://acme-corp.com/account/billing"
};
const ticketResponse: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

getTicket

Parámetros

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

Respuesta

Devuelve: GetTicket200Response

Ejemplo

Ejemplo de getTicket

Copy

const tenantId: string = 'acme-corp-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

getTickets

Parámetros

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

Respuesta

Devuelve: GetTickets200Response

Ejemplo

Ejemplo de getTickets

Copy

const tenantId: string = "tenant_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

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

Ejemplo

Ejemplo de getUserBadgeProgressById

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

getUserBadgeProgressByUserId

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressById200Response

Ejemplo

Ejemplo de getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // fuente opcional (podría ser undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

getUserBadgeProgressList

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressList200Response

Ejemplo

Ejemplo de getUserBadgeProgressList

Copy

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

createUserBadge

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
createUserBadgeParams	CreateUserBadgeParams	Sí

Respuesta

Devuelve: CreateUserBadge200Response

Ejemplo

Ejemplo de createUserBadge

Copy

const tenantId: string = 'tenant_84f3b2';
const createUserBadgeParams: CreateUserBadgeParams = {
  name: 'Top Contributor',
  slug: 'top-contributor',
  imageUrl: 'https://assets.fastcomments.com/badges/top-contributor.png',
  description: 'Awarded for 100 helpful comments',
  active: true,
  criteria: { commentsCount: 100 }, // criterios opcionales
  displayOrder: 10,
  metadata: { featured: true } // metadatos opcionales
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);
console.log(result);

deleteUserBadge

Parámetros

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

Respuesta

Devuelve: UpdateUserBadge200Response

Ejemplo

Ejemplo de deleteUserBadge

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Parámetros

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

Respuesta

Devuelve: GetUserBadge200Response

Ejemplo

Ejemplo de getUserBadge

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

getUserBadges

Parámetros

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

Respuesta

Devuelve: GetUserBadges200Response

Ejemplo

Ejemplo de getUserBadges

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Parámetros

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

Respuesta

Devuelve: UpdateUserBadge200Response

Ejemplo

Ejemplo de updateUserBadge

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

getUserNotificationCount

Parámetros

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

Respuesta

Devuelve: GetUserNotificationCount200Response

Ejemplo

Ejemplo de getUserNotificationCount

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

getUserNotifications

Parámetros

Name	Type	Required
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

Ejemplo

Ejemplo de getUserNotifications

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

resetUserNotificationCount

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
sso	string	No

Respuesta

Devuelve: ResetUserNotifications200Response

Ejemplo

Ejemplo de resetUserNotificationCount

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

resetUserNotifications

Parámetros

Name	Type	Required
tenantId	string	Sí
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Respuesta

Devuelve: ResetUserNotifications200Response

Ejemplo

Ejemplo de resetUserNotifications

Copy

const tenantId: string = "tenant_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

updateUserNotificationCommentSubscriptionStatus

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

Parámetros

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

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de updateUserNotificationCommentSubscriptionStatus

Copy

const tenantId: string = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

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

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

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de updateUserNotificationPageSubscriptionStatus

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

updateUserNotificationStatus

Parámetros

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

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de updateUserNotificationStatus

Copy

const tenantId: string = 'tenant_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

getUserPresenceStatuses

Parámetros

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

Respuesta

Devuelve: GetUserPresenceStatuses200Response

Ejemplo

Ejemplo de getUserPresenceStatuses

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // fuente opcional
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Parámetros

Name	Type	Required
tenantId	string	Sí
urlId	string	Sí
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

Respuesta

Devuelve: SearchUsers200Response

Ejemplo

Ejemplo de searchUsers

Copy

const tenantId: string = 'tenant_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

getUser

Parámetros

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

Respuesta

Devuelve: GetUser200Response

Ejemplo

Ejemplo de getUser

Copy

const tenantId: string = 'tenant_7b3f42';
const id: string = 'user_9c4d2a';
const userResponse: GetUser200Response = await getUser(tenantId, id);
console.log(userResponse);

createVote

Parámetros

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

Respuesta

Devuelve: VoteComment200Response

Ejemplo

Ejemplo de createVote

Copy

const tenantId: string = 'tenant_9f8b6a';
const commentId: string = 'comment_3b7d2e';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_4c2a1f';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

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_7c3f2b4a";
const voteId: string = "vote_4f8d9a11";
const editKey: string = "edit_2b9f8c";
const resultWithoutKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId);
const resultWithKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId, editKey);

getVotes

Parámetros

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

Respuesta

Devuelve: GetVotes200Response

Ejemplo

Ejemplo de getVotes

Copy

const tenantId: string = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // parámetro de consulta opcional
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

getVotesForUser

Parámetros

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

Respuesta

Devuelve: GetVotesForUser200Response

Ejemplo

Ejemplo de getVotesForUser

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

¿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

Primeros pasos

Referencia de API

Documentación

Uso

Agregación

Registros de auditoría

Bloquear desde comentario

Comprobar comentarios bloqueados

Comentarios

Configuraciones de dominio

Plantillas de correo electrónico

Registro de eventos

Publicaciones del feed

Marcar comentario

Hashtags

Moderadores

Recuento 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 inquilino

Paquetes del inquilino

Usuarios del inquilino

Inquilinos

Tickets

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones de usuario

Estado de presencia del 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

Ejemplo

blockFromCommentPublic

Parámetros