SDK de JavaScript/TypeScript de FastComments

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

Administra comentarios, usuarios, SSO y moderación desde Node.js o el navegador.

Repositorio

Agentes de codificación IA

Proporcione a su agente de codificación el contexto de FastComments que necesita: widgets, configuración, Secure SSO, la API REST y los SDK:

npx skills add fastcomments/skills

Funciona con Claude Code, Codex, Cursor, Copilot, Gemini y cualquier otro agente que soporte la CLI de skills soporta.

Instalación

npm install fastcomments-sdk

Documentación de 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 estas clases de API:

DefaultApi - Endpoints seguros que requieren tu clave de API para la autenticación. Úsalos 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.
ModerationApi - Endpoints del panel de moderación (moderación de comentarios, expulsiones, insignias, factor de confianza, búsqueda). Autenticados mediante la sesión del moderador; pasa el parámetro de consulta sso para moderadores autenticados por SSO.
HiddenApi - Endpoints internos/administrativos para casos de uso avanzados.

Ejemplo: Uso de la API pública (seguro para navegador)

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

const publicApi = new PublicApi();

// Obtener comentarios para 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 la API predeterminada (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'
});

Ejemplo: Uso de la API de moderación

import { createFastCommentsSDK } from 'fastcomments-sdk/server';

const sdk = createFastCommentsSDK({ /* basePath, etc. */ });

// Llamadas autenticadas por moderador (cookie de sesión, o pasar `sso` para un moderador SSO).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

await sdk.moderationApi.postSetCommentSpamStatus({
  commentId: 'comment-id',
  spam: true
});

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);
  }
}

createAgentTenant

Crea una nueva cuenta de prueba para un agente de IA sin un registro humano. No se necesita una clave API para llamar a este.

La respuesta contiene el ID del inquilino, una clave API que funciona inmediatamente contra la API REST y el servidor MCP, y una URL de reclamación. Proporcione la URL de reclamación a la persona para la que está trabajando: abrirla mientras está conectado a FastComments asocia la cuenta a ella. Las cuentas no reclamadas, y sus claves, se eliminan 72 horas después de su creación. Hasta que se reclamen, la cuenta tiene los límites de prueba estándar.

Parameters

Name	Type	Required	Description
createAgentTenantBody	CreateAgentTenantBody	Yes

Response

Devuelve: CreateAgentTenantResponse

Example

Ejemplo createAgentTenant

Copy

const tenantBody: CreateAgentTenantBody = {
  name: "Acme Corp",
  domain: "acme.example.com",
  contactEmail: "admin@acme.example.com", // opcional
  planId: 3 // opcional
};
const result: CreateAgentTenantResponse = await createAgentTenant(tenantBody);

aggregate

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

Parámetros

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

Respuesta

Devuelve: AggregateResponse

Ejemplo

Ejemplo de agregación

Copy

const tenantId: string = "tenant-12345";
const aggregationRequest: AggregationRequest = {
  predicates: [
    {
      field: "status",
      operator: "eq",
      value: { type: "string", value: "approved" }
    }
  ],
  operations: [
    { type: "count", field: "commentId" }
  ],
  sort: { field: "createdAt", direction: "desc" }
};
const parentTenantId: string = "parent-001";
const includeStats: boolean = true;
const result: AggregateResponse = await aggregate(
  tenantId,
  aggregationRequest,
  parentTenantId,
  includeStats
);

getAuditLogs

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No
username	string	No
ip	string	No
crudType	string	No
resourceName	string	No
targetId	string	No
target	string	No
includeManagedTenants	boolean	No

Respuesta

Devuelve: GetAuditLogsResponse

Ejemplo

Ejemplo getAuditLogs

Copy

async function fetchAuditLogs(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const limit: number = 50;
  const skip: number = 0;
  const order: SORTDIR = { direction: "DESC" };
  const after: number = Date.now() - 86400000; // hace 1 día
  const before: number = Date.now();
  const username: string = "alice.smith";
  const ip: string = "198.51.100.23";
  const crudType: string = "CREATE";
  const resourceName: string = "thread";
  const targetId: string = "thread_45678";
  const target: string = "forum_12";
  const includeManagedTenants: boolean = false;
  const logs: GetAuditLogsResponse = await getAuditLogs(
    tenantId,
    limit,
    skip,
    order,
    after,
    before,
    username,
    ip,
    crudType,
    resourceName,
    targetId,
    target,
    includeManagedTenants
  );
  console.log(logs);
}
fetchAuditLogs();

blockFromCommentPublic

Parámetros

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

Respuesta

Devuelve: BlockSuccess

Ejemplo

Ejemplo de blockFromCommentPublic

Copy

async function demoBlock() {
  const tenantId: string = "tenant_9f8b7c";
  const commentId: string = "comment_3e2d1a";
  const blockParams: PublicBlockFromCommentParams = {
    reason: "harassment",
    expiresInHours: 48
  };
  const ssoToken: string = "sso_5g6h7i";
  const resultWithSso: BlockSuccess = await blockFromCommentPublic(tenantId, commentId, blockParams, ssoToken);
  const resultWithoutSso: BlockSuccess = await blockFromCommentPublic(tenantId, commentId, blockParams);
}

unBlockCommentPublic

Parámetros

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

Respuesta

Devuelve: UnblockSuccess

Ejemplo

Ejemplo de unBlockCommentPublic

Copy

const tenantId: string = "c9f1e2a4-5b6d-4f8a-9c2e-123456789abc";
const commentId: string = "d3b2c1a9-8f7e-4d6b-9a0b-987654321def";
const unblockParams: PublicBlockFromCommentParams = {
    reason: "User request resolved",
    moderatorId: "mod-456"
};
const ssoToken: string = "sso-token-789xyz";
const unblockResult: UnblockSuccess = await unBlockCommentPublic(tenantId, commentId, unblockParams, ssoToken);
const unblockResultNoSso: UnblockSuccess = await unBlockCommentPublic(tenantId, commentId, unblockParams);

checkedCommentsForBlocked

Parámetros

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

Respuesta

Devuelve: CheckBlockedCommentsResponse

Ejemplo

Ejemplo de checkedCommentsForBlocked

Copy

(async () => {
    const tenantId: string = "tenant_12345";
    const commentIds: string = "cmt_9876,cmt_5432";
    const ssoToken: string = "sso_user_abc123";
    const responseWithSso: CheckBlockedCommentsResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
    const responseWithoutSso: CheckBlockedCommentsResponse = await checkedCommentsForBlocked(tenantId, commentIds);
})();

blockUserFromComment

Parámetros

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

Respuesta

Devuelve: BlockSuccess

Ejemplo

Ejemplo de blockUserFromComment

Copy

async function demo() {
  const tenantId: string = "tenant-123e4567-e89b-12d3-a456-426614174000";
  const commentId: string = "cmt-9876543210";
  const blockParams: BlockFromCommentParams = {
    reason: "spam",
    durationHours: 24
  };
  const userId: string = "user-abc123";
  const anonUserId: string = "anon-xyz789";
  const result: BlockSuccess = await blockUserFromComment(tenantId, commentId, blockParams, userId, anonUserId);
  console.log(result);
}
demo();

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: SaveCommentsResponseWithPresence

Ejemplo

Ejemplo createCommentPublic

Copy

async function runExample() {
  const tenantId: string = "tenant-456";
  const urlId: string = "url-789";
  const broadcastId: string = "broadcast-101112";
  const commentData: CommentData = { text: "This is a comment", userId: "user-123" };
  const sessionId: string = "session-131415";
  const sso: string = "sso-token-xyz";
  const result: SaveCommentsResponseWithPresence = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);
  const resultNoOpt: SaveCommentsResponseWithPresence = await createCommentPublic(tenantId, urlId, broadcastId, commentData);
}

deleteComment

Parámetros

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

Respuesta

Returns: DeleteCommentResult

Ejemplo

Ejemplo deleteComment

Copy

async function removeComment(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const commentId: string = "comment_9876";
    const contextUserId: string = "user_42";
    const result: DeleteCommentResult = await deleteComment(tenantId, commentId, contextUserId, true);
    console.log(result);
}
removeComment();

deleteCommentPublic

Parámetros

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

Respuesta

Devuelve: PublicAPIDeleteCommentResponse

Ejemplo

Ejemplo deleteCommentPublic

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_9876";
  const broadcastId: string = "brd_5555";
  const editKey: string = "edit_abc123";
  const sso: string = "sso_token_xyz";
  const resultWithoutOptional: PublicAPIDeleteCommentResponse = await deleteCommentPublic(tenantId, commentId, broadcastId);
  const resultWithOptional: PublicAPIDeleteCommentResponse = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);
})();

deleteCommentVote

Parámetros

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

Respuesta

Devuelve: VoteDeleteResponse

Ejemplo

Ejemplo deleteCommentVote

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const voteId: string = "vote_555";
const urlId: string = "url_abcde";
const broadcastId: string = "brd_2023";
const editKey: string = "edit_abc123"; // opcional
const ssoToken: string = "sso_token_xyz"; // opcional
// Llamada con solo los parámetros obligatorios y uno opcional
const deleteResult: VoteDeleteResponse = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey
);
// Llamada con ambos parámetros opcionales
const deleteResultWithSSO: VoteDeleteResponse = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  ssoToken
);

flagComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: FlagCommentResponse

Ejemplo

Ejemplo flagComment

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-20230915-001";
  const userId: string = "user-42";
  const anonUserId: string = "anon-abc123";
  const response: FlagCommentResponse = await flagComment(tenantId, commentId, userId, anonUserId);
  console.log(response);
})();

getComment

Parámetros

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

Respuesta

Devuelve: APIGetCommentResponse

Ejemplo

Ejemplo getComment

Copy

async function fetchComment(): Promise<void> {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_1234567890";
  const response: APIGetCommentResponse = await getComment(tenantId, commentId);
  const comment: APIComment | undefined = response.comment;
  // Demostración de campos opcionales
  const badgeInfo: CommentUserBadgeInfo | undefined = comment?.user?.badge;
  const hashtags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashtags;
  const mentions: CommentUserMentionInfo[] | undefined = comment?.user?.mentions;
  const meta: APICommentBaseMeta | undefined = comment?.meta;
  console.log(comment?.id, badgeInfo?.type);
}
fetchComment();

getComments

Parámetros

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

Respuesta

Devuelve: APIGetCommentsResponse

Ejemplo

Ejemplo getComments

Copy

async function loadComments(): Promise<void> {
  const tenantId: string = "acme-corp";
  const page: number = 1;
  const limit: number = 50;
  const asTree: boolean = false;
  const direction: SortDirections = "asc";
  const fromDate: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // hace 30 días
  const toDate: number = Date.now();
  const commentsResponse: APIGetCommentsResponse = await getComments(
    tenantId,
    page,
    limit,
    undefined,
    asTree,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    undefined,
    direction,
    fromDate,
    toDate
  );
  console.log(commentsResponse);
}

getCommentsPublic

req tenantId urlId

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
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

Response

Devuelve: GetCommentsResponseWithPresencePublicComment

Example

Ejemplo getCommentsPublic

Copy

async function loadComments(): Promise<void> {
  const tenantId: string = "tenant-42",
        urlId: string = "post-2023-09-15",
        page: number = 1,
        direction: SortDirections = "desc",
        limit: number = 30,
        includeConfig: boolean = true,
        locale: string = "en-US",
        isCrawler: boolean = false,
        asTree: boolean = true,
        maxTreeDepth: number = 2,
        searchText: string = "fastcomments",
        hashTags: string[] = ["fastcomments","typescript"],
        userId: string = "user-123";
  const result: GetCommentsResponseWithPresencePublicComment = await getCommentsPublic(
    tenantId,
    urlId,
    page,
    direction,
    undefined,
    undefined,
    undefined,
    limit,
    undefined,
    undefined,
    undefined,
    includeConfig,
    undefined,
    undefined,
    locale,
    undefined,
    isCrawler,
    undefined,
    asTree,
    maxTreeDepth,
    undefined,
    undefined,
    searchText,
    hashTags,
    userId
  );
}

getCommentText

Parámetros

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

Respuesta

Devuelve: PublicAPIGetCommentTextResponse

Ejemplo

Ejemplo getCommentText

Copy

const tenantId: string = "acme-corp-tenant";
const commentId: string = "comment-987654321";
const editKey: string = "edit-key-abc123";
const sso: string = "sso-token-xyz789";
const commentWithEdit: PublicAPIGetCommentTextResponse = await getCommentText(
  tenantId,
  commentId,
  editKey,
  sso
);
const commentBasic: PublicAPIGetCommentTextResponse = await getCommentText(
  tenantId,
  commentId
);

getCommentVoteUserNames

Parámetros

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

Respuesta

Devuelve: GetCommentVoteUserNamesSuccessResponse

Ejemplo

Ejemplo getCommentVoteUserNames

Copy

async function example() {
  const tenantId: string = 'tenant-9876';
  const commentId: string = 'comment-abc123';
  const dir: number = 1;
  const ssoToken: string = 'sso-xyz789';
  const resultWithSso: GetCommentVoteUserNamesSuccessResponse = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);
  const resultWithoutSso: GetCommentVoteUserNamesSuccessResponse = await getCommentVoteUserNames(tenantId, commentId, dir);
}

lockComment

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de lockComment

Copy

async function demoLockComment() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_9876";
  const broadcastId: string = "brd_5555";
  const ssoToken: string = "sso_user_abc";
  const resultWithSso: APIEmptyResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  const resultWithoutSso: APIEmptyResponse = await lockComment(tenantId, commentId, broadcastId);
}
demoLockComment();

pinComment

Parámetros

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

Respuesta

Devuelve: ChangeCommentPinStatusResponse

Ejemplo

Ejemplo de pinComment

Copy

async function demoPinComment() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  const resultWithoutSso: ChangeCommentPinStatusResponse = await pinComment(tenantId, commentId, broadcastId);
  const ssoToken: string = "sso_abcde12345";
  const resultWithSso: ChangeCommentPinStatusResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);
}
demoPinComment();

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: APISaveCommentResponse

Ejemplo

Ejemplo de saveComment

Copy

const tenantId: string = "tenant_12345";
const commentParams: CreateCommentParams = {
  content: "This is a comment with a mention and a hashtag.",
  userId: "user_987",
  mentions: [
    { userId: "user_123", start: 27, end: 34 }
  ] as CommentUserMentionInfo[],
  hashtags: [
    { tag: "feedback", start: 45, end: 53 }
  ] as CommentUserHashTagInfo[],
  poll: {
    question: "Do you like this feature?",
    options: ["Yes", "No"]
  } as CommentPollInput,
};
const response: APISaveCommentResponse = await saveComment(
  tenantId,
  commentParams,
  true,   // isLive
  true,   // doSpamCheck
  false,  // sendEmails
  true    // populateNotifications
);

saveCommentsBulk

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Respuesta

Devuelve: Array<SaveCommentsBulkResponse

Ejemplo

Ejemplo de saveCommentsBulk

Copy

const tenantId: string = "tenant_12345";
const mention1: CommentUserMentionInfo = {
  userId: "user_002",
  start: 10,
  end: 20,
};
const hashtag1: CommentUserHashTagInfo = {
  tag: "news",
  start: 30,
  end: 35,
};
const poll1: CommentPollInput = {
  question: "Did you find this helpful?",
  options: ["Yes", "No"],
};
const commentA: CreateCommentParams = {
  content: "This is a great article!",
  userId: "user_001",
  mentions: [mention1],
  hashtags: [hashtag1],
  poll: poll1,
};
const commentB: CreateCommentParams = {
  content: "I have a question about the topic.",
  userId: "user_003",
};
const createCommentParams: CreateCommentParams[] = [commentA, commentB];
const isLive: boolean = true;
const doSpamCheck: boolean = false;
const sendEmails: boolean = true;
const populateNotifications: boolean = false;
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  createCommentParams,
  isLive,
  doSpamCheck,
  sendEmails,
  populateNotifications
);

setCommentText

Parámetros

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

Respuesta

Devuelve: PublicAPISetCommentTextResponse

Ejemplo

Ejemplo setCommentText

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  const commentTextUpdateRequest: CommentTextUpdateRequest = {
    text: "Revised comment text with additional details."
  };
  const editKey: string = "edit_abc123";
  const sso: string = "sso_token_456def";
  const response: PublicAPISetCommentTextResponse = await setCommentText(
    tenantId,
    commentId,
    broadcastId,
    commentTextUpdateRequest,
    editKey,
    sso
  );
})();

unBlockUserFromComment

Parámetros

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

Respuesta

Devuelve: UnblockSuccess

Ejemplo

Ejemplo de unBlockUserFromComment

Copy

(async () => {
  const tenantId: string = "tenant-9f8b7c6d";
  const commentId: string = "comment-4a3b2c1d";
  const params: UnBlockFromCommentParams = {
    reason: "User appealed the block",
    adminNote: "Reviewed and unblocked"
  };
  const userId: string = "user-5e6f7g8h";
  const anonUserId: string = "anon-1a2b3c4d";
  const result: UnblockSuccess = await unBlockUserFromComment(
    tenantId,
    commentId,
    params,
    userId,
    anonUserId
  );
  console.log(result);
})();

unFlagComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: FlagCommentResponse

Ejemplo

Ejemplo de unFlagComment

Copy

async function runExample() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt-20230915-001";
  const userId: string = "user-42";
  const unflaggedByUser: FlagCommentResponse = await unFlagComment(tenantId, commentId, userId);
  const unflaggedByAnon: FlagCommentResponse = await unFlagComment(tenantId, commentId, undefined, "anon-xyz");
  console.log(unflaggedByUser, unflaggedByAnon);
}

unLockComment

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de unLockComment

Copy

async function demoUnlock() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_1234567890";
  const broadcastId: string = "brd_987654321";
  const ssoToken: string = "sso_abcdef123456";
  const resultWithoutSso: APIEmptyResponse = await unLockComment(tenantId, commentId, broadcastId);
  const resultWithSso: APIEmptyResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
}

unPinComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Respuesta

Devuelve: ChangeCommentPinStatusResponse

Ejemplo

Ejemplo de unPinComment

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-20230915-001";
  const broadcastId: string = "broadcast-2023-09-15";
  const ssoToken: string = "sso-abc123";
  const result: ChangeCommentPinStatusResponse = await unPinComment(tenantId, commentId, broadcastId, ssoToken);
  const resultWithoutSso: ChangeCommentPinStatusResponse = await unPinComment(tenantId, commentId, broadcastId);
})();

updateComment

Parámetros

Name	Type	Required
tenantId	string	Sí
id	string	Sí
updatableCommentParams	UpdatableCommentParams	Sí
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de updateComment

Copy

const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
const commentId: string = "comment-9876543210";
const updateParams: UpdatableCommentParams = {
  content: "Edited comment content",
  isApproved: true
};
const contextUserId: string = "user-11223344";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const response: APIEmptyResponse = await updateComment(
  tenantId,
  commentId,
  updateParams,
  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: VoteResponse

Ejemplo

Ejemplo voteComment

Copy

async function runVote() {
  const tenantId: string = 'tenant_001';
  const commentId: string = 'cmt_987654';
  const urlId: string = 'url_12345';
  const broadcastId: string = 'brd_56789';
  const voteBody: VoteBodyParams = { direction: 'up' };
  const sessionId: string = 'sess_abc123';
  const sso: string = 'sso_token_xyz';
  const response: VoteResponse = await voteComment(
    tenantId,
    commentId,
    urlId,
    broadcastId,
    voteBody,
    sessionId,
    sso
  );
  console.log(response);
}
runVote();

getCommentsForUser

Parámetros

Nombre	Tipo	Requerido
userId	string	No
direction	SortDirections	No
repliesToUserId	string	No
page	number	No
includei10n	boolean	No
locale	string	No
isCrawler	boolean	No

Respuesta

Devuelve: GetCommentsForUserResponse

Ejemplo

Ejemplo getCommentsForUser

Copy

const userId: string = '550e8400-e29b-41d4-a716-446655440000';
const direction: SortDirections = SortDirections.Descending;
const page: number = 3;
const includei10n: boolean = true;
const locale: string = 'fr-FR';
const isCrawler: boolean = false;
const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(
  userId,
  direction,
  undefined,
  page,
  includei10n,
  locale,
  isCrawler
);

addDomainConfig

Parámetros

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

Respuesta

Devuelve: AddDomainConfigResponse

Ejemplo

addDomainConfig Ejemplo

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // la descripción es opcional y se omite aquí
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

deleteDomainConfig

Parámetros

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

Respuesta

Devuelve: DeleteDomainConfigResponse

Ejemplo

Ejemplo deleteDomainConfig

Copy

async function runExample() {
  const tenantId: string = 'acme-corp';
  const domain: string = 'blog.acme.com';
  const response: DeleteDomainConfigResponse = await deleteDomainConfig(tenantId, domain);
  console.log(response);
}
runExample();

getDomainConfig

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
domain	string	Yes

Respuesta

Devuelve: GetDomainConfigResponse

Ejemplo

Ejemplo getDomainConfig

Copy

async function main() {
  const tenantId: string = "acme-corp-123";
  const domain: string = "blog.acme.com";
  const config: GetDomainConfigResponse = await getDomainConfig(tenantId, domain);
  console.log(config);
}
main();

getDomainConfigs

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetDomainConfigsResponse

Ejemplo

Ejemplo getDomainConfigs

Copy

async function fetchDomainConfigs(): Promise<void> {
  const tenantId: string = "acme-corp-567";
  const configs: GetDomainConfigsResponse = await getDomainConfigs(tenantId);
  console.log(configs);
}

patchDomainConfig

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
domainToUpdate	string	Yes
patchDomainConfigParams	PatchDomainConfigParams	Yes

Respuesta

Devuelve: PatchDomainConfigResponse

Ejemplo

Ejemplo de patchDomainConfig

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // parámetro opcional demostrado
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

putDomainConfig

Parameters

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	Yes
updateDomainConfigParams	UpdateDomainConfigParams	Yes

Response

Returns: PutDomainConfigResponse

Example

Ejemplo putDomainConfig

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // campo opcional omitido, por ejemplo, maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

createEmailTemplate

Parámetros

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

Respuesta

Devuelve: CreateEmailTemplateResponse

Ejemplo

Ejemplo createEmailTemplate

Copy

const tenantId: string = "tenant_9f8b7c6d";
const templateBody: CreateEmailTemplateBody = {
  name: "Weekly Summary",
  subject: "Your weekly activity report",
  // campo opcional
  replyTo: "no-reply@myapp.com",
  htmlContent: "<p>Hello \{{userName}}, here is your summary...</p>"
};
const response: CreateEmailTemplateResponse = await createEmailTemplate(tenantId, templateBody);
console.log(response.template.id);

deleteEmailTemplate

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deleteEmailTemplate

Copy

interface APIStatus {
  code: number;
  message: string;
}
interface APIEmptyResponse {
  status?: APIStatus;
}
(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_987";
  const result: APIEmptyResponse = await deleteEmailTemplate(tenantId, templateId);
})();

deleteEmailTemplateRenderError

Parameters

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

Response

Devuelve: APIEmptyResponse

Example

deleteEmailTemplateRenderError Ejemplo

Copy

async function removeRenderError() {
  const tenantId: string = "acme-corp-tenant";
  const templateId: string = "welcome-email-template";
  const errorId: string = "render-err-20230915";
  const result: APIEmptyResponse = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);
}

getEmailTemplate

Parámetros

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

Respuesta

Devuelve: GetEmailTemplateResponse

Ejemplo

Ejemplo getEmailTemplate

Copy

async function fetchTemplate() {
  const tenantId: string = "acme-corp-123";
  const templateId: string = "welcome-email-456";
  const response: GetEmailTemplateResponse = await getEmailTemplate(tenantId, templateId);
  const status: APIStatus | undefined = response.status;
  const customTemplate: CustomEmailTemplate | undefined = response.template;
}

getEmailTemplateDefinitions

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes

Respuesta

Devuelve: GetEmailTemplateDefinitionsResponse

Ejemplo

Ejemplo getEmailTemplateDefinitions

Copy

async function fetchEmailTemplates() {
    const tenantId: string = "acme-corp-456";
    const result: GetEmailTemplateDefinitionsResponse = await getEmailTemplateDefinitions(tenantId);
    const status: APIStatus = result.status;
    const definitions: EmailTemplateDefinition[] = result.definitions ?? [];
    console.log(`Status: ${status.code}, Templates: ${definitions.length}`);
}

getEmailTemplateRenderErrors

Parámetros

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

Respuesta

Devuelve: GetEmailTemplateRenderErrorsResponse

Ejemplo

getEmailTemplateRenderErrors Ejemplo

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_9876";
  const resultWithSkip: GetEmailTemplateRenderErrorsResponse = await getEmailTemplateRenderErrors(tenantId, templateId, 10);
  const resultWithoutSkip: GetEmailTemplateRenderErrorsResponse = await getEmailTemplateRenderErrors(tenantId, templateId);
  console.log(resultWithSkip, resultWithoutSkip);
}
demo();

getEmailTemplates

Parámetros

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

Respuesta

Devuelve: GetEmailTemplatesResponse

Ejemplo

Ejemplo de getEmailTemplates

Copy

async function fetchEmailTemplates() {
  const tenantId: string = "acme-corp-123";
  const skip: number = 20;
  const templatesWithSkip: GetEmailTemplatesResponse = await getEmailTemplates(tenantId, skip);
  const templatesWithoutSkip: GetEmailTemplatesResponse = await getEmailTemplates(tenantId);
}

renderEmailTemplate

Parámetros

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

Respuesta

Devuelve: RenderEmailTemplateResponse

Ejemplo

renderEmailTemplate Ejemplo

Copy

const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
const templateBody: RenderEmailTemplateBody = {
  templateId: "welcome-email",
  variables: {
    userName: "Jane Doe",
    signupDate: "2024-04-01"
  }
};
const locale: string = "en-US";
(async () => {
  const rendered: RenderEmailTemplateResponse = await renderEmailTemplate(
    tenantId,
    templateBody,
    locale
  );
  console.log(rendered);
})();

updateEmailTemplate

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de updateEmailTemplate

Copy

async function runUpdate() {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "New Comment Notification",
    // htmlContent es opcional y omitido
    status: { code: 200, message: "Active" } // APIStatus
  };
  const response: APIEmptyResponse = await updateEmailTemplate(tenantId, templateId, updateBody);
  console.log(response);
}

getEventLog

solicitud
tenantId
urlId
userIdWS

Parámetros

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

Respuesta

Devuelve: GetEventLogResponse

Ejemplo

Ejemplo getEventLog

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "url_9876";
const userIdWS: string = "user_abcde";
const startTime: number = Date.now() - 86_400_000; // hace 24 horas
const endTime: number = Date.now();
const fullLog: GetEventLogResponse = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
const partialLog: GetEventLogResponse = await getEventLog(tenantId, urlId, userIdWS, startTime);

getGlobalEventLog

solicitud tenantId urlId userIdWS

Parámetros

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

Respuesta

Devuelve: GetEventLogResponse

Ejemplo

Ejemplo de getGlobalEventLog

Copy

async function fetchEventLogs() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_9876";
  const userIdWS: string = "user_ws_abcde";
  const startTime: number = Date.now() - 24 * 60 * 60 * 1000; // hace 24 horas
  const endTime: number = Date.now();
  const logWithEnd: GetEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
  const logWithoutEnd: GetEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);
}

createFeedPost

Parámetros

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

Respuesta

Devuelve: CreateFeedPostsResponse

Ejemplo

Ejemplo createFeedPost

Copy

(async () => {
  const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
  const broadcastId: string = "b1c2d3e4-5678-90ab-cdef-1234567890cd";
  const isLive: boolean = true;
  const doSpamCheck: boolean = false;
  const skipDupCheck: boolean = true;
  const mediaAsset: FeedPostMediaItemAsset = {
    url: "https://cdn.example.com/photos/sunrise.jpg",
    type: "image/jpeg"
  };
  const mediaItem: FeedPostMediaItem = {
    asset: mediaAsset,
    caption: "Sunrise over the mountains"
  };
  const linkItem: FeedPostLink = {
    url: "https://blog.example.com/tech-trends-2024",
    title: "Top Tech Trends for 2024"
  };
  const postParams: CreateFeedPostParams = {
    text: "Excited to share the latest tech trends!",
    media: [mediaItem],
    link: linkItem
  };
  const response: CreateFeedPostsResponse = await createFeedPost(
    tenantId,
    postParams,
    broadcastId,
    isLive,
    doSpamCheck,
    skipDupCheck
  );
  console.log(response);
})();

createFeedPostPublic

Parámetros

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

Respuesta

Devuelve: CreateFeedPostResponse

Ejemplo

createFeedPostPublic Ejemplo

Copy

const tenantId: string = "tenant_12345";
const mediaAsset: FeedPostMediaItemAsset = {
  url: "https://cdn.example.com/image.jpg",
  width: 800,
  height: 600,
  mimeType: "image/jpeg"
};
const mediaItem: FeedPostMediaItem = {
  type: "image",
  asset: mediaAsset,
  caption: "Sunset over the hills"
};
const link: FeedPostLink = {
  url: "https://example.com/blog/post",
  title: "Exciting New Features",
  description: "Read about our latest updates."
};
const createFeedPostParams: CreateFeedPostParams = {
  content: "Check out our latest blog post!",
  media: [mediaItem],
  link: link,
  visibility: "public"
};
const broadcastId: string = "broadcast_9876";
const sso: string = "sso_token_abc123";
const response: CreateFeedPostResponse = await createFeedPostPublic(
  tenantId,
  createFeedPostParams,
  broadcastId,
  sso
);

deleteFeedPostPublic

Parámetros

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

Respuesta

Devuelve: DeleteFeedPostPublicResponse

Ejemplo

Ejemplo deleteFeedPostPublic

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const postId: string = "post_98765";
  const broadcastId: string = "broadcast_abcde";
  const sso: string = "sso_token_xyz";
  const responseWithOpts: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(
    tenantId,
    postId,
    broadcastId,
    sso
  );
  const responseWithoutOpts: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(
    tenantId,
    postId
  );
})();

getFeedPosts

solicitud tenantId afterId

Parámetros

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

Respuesta

Devuelve: GetFeedPostsResponse

Ejemplo

Ejemplo getFeedPosts

Copy

async function loadFeed() {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const afterId: string = 'post_987654321';
  const limit: number = 25;
  const tags: string[] = ['technology', 'innovation'];
  const response: GetFeedPostsResponse = await getFeedPosts(tenantId, afterId, limit, tags);
  console.log(response);
}
loadFeed();

getFeedPostsPublic

req tenantId afterId

Parámetros

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

Respuesta

Devuelve: PublicFeedPostsResponse

Ejemplo

Ejemplo getFeedPostsPublic

Copy

const tenantId: string = "acme-corp-tenant";
const afterId: string = "post-20230915-abc123";
const limit: number = 15;
const tags: string[] = ["technology", "innovation"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSJ9.s3cr3tSignature";
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const feedResponse: PublicFeedPostsResponse = await getFeedPostsPublic(
  tenantId,
  afterId,
  limit,
  tags,
  sso,
  isCrawler,
  includeUserInfo
);

getFeedPostsStats

Parámetros

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

Respuesta

Devuelve: FeedPostsStatsResponse

Ejemplo

Ejemplo getFeedPostsStats

Copy

const tenantId: string = "tenant-9f8b7c6d";
const postIds: string[] = ["post-1a2b3c", "post-4d5e6f", "post-7g8h9i"];
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
const feedStats: FeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds, ssoToken);

getUserReactsPublic

Parámetros

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

Respuesta

Devuelve: UserReactsResponse

Ejemplo

Ejemplo getUserReactsPublic

Copy

const tenantId: string = "tenant_12345";
const postIds: string[] = ["post_abc", "post_def"];
const ssoToken: string = "sso_token_987";
const fullResponse: UserReactsResponse = await getUserReactsPublic(tenantId, postIds, ssoToken);
const minimalResponse: UserReactsResponse = await getUserReactsPublic(tenantId);

reactFeedPostPublic

Parámetros

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

Respuesta

Devuelve: ReactFeedPostResponse

Ejemplo

Ejemplo reactFeedPostPublic

Copy

async function demoReact() {
  const tenantId: string = "tenant_12345";
  const postId: string = "post_98765";
  const reactBodyParams: ReactBodyParams = {
    type: "like",
    userId: "user_abcde"
  };
  const response: ReactFeedPostResponse = await reactFeedPostPublic(
    tenantId,
    postId,
    reactBodyParams,
    true,
    "broadcast_001",
    "sso_token_xyz"
  );
}

getTranslations

Parámetros

Name	Type	Required
tenantId	string	Yes
id	string	Yes
feedPost	FeedPost	Yes

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

updateFeedPost Ejemplo

Copy

async function runUpdate() {
  const tenantId: string = "tenant_12345";
  const postId: string = "post_98765";
  const mediaAsset: FeedPostMediaItemAsset = {
    url: "https://cdn.example.com/image.jpg",
    width: 800,
    height: 600,
    mimeType: "image/jpeg"
  };
  const mediaItem: FeedPostMediaItem = {
    type: "image",
    asset: mediaAsset,
    caption: "Sunrise over the hills"
  };
  const link: FeedPostLink = {
    url: "https://example.com/blog",
    title: "Latest Blog Post",
    description: "Insights on recent developments"
  };
  const feedPost: FeedPost = {
    title: "Daily Highlights",
    content: "Check out today’s top stories.",
    mediaItems: [mediaItem], // opcional
    links: [link] // opcional
  };
  const response: APIEmptyResponse = await updateFeedPost(tenantId, postId, feedPost);
  console.log(response);
}
runUpdate();

updateFeedPostPublic

Parámetros

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

Respuesta

Devuelve: CreateFeedPostResponse

Ejemplo

Ejemplo updateFeedPostPublic

Copy

// Definir parámetros
const tenantId: string = "tenant_12345";
const postId: string = "post_98765";
const mediaAsset: FeedPostMediaItemAsset = {
  url: "https://cdn.example.com/image.jpg",
  width: 800,
  height: 600,
  mimeType: "image/jpeg"
};
const mediaItem: FeedPostMediaItem = {
  type: "image",
  asset: mediaAsset,
  caption: "A beautiful scenery"
};
const link: FeedPostLink = {
  url: "https://example.com/article",
  title: "Interesting Article",
  description: "An article about TypeScript best practices."
};
const updateParams: UpdateFeedPostParams = {
  content: "Updated post content with new media and link.",
  media: [mediaItem],
  link: link,
  isPublic: true
};
const broadcastId: string = "broadcast_001";
const sso: string = "sso_token_abc123";
const response: CreateFeedPostResponse = await updateFeedPostPublic(
  tenantId,
  postId,
  updateParams,
  broadcastId,
  sso
);

flagCommentPublic

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
isFlagged	boolean	Yes
sso	string	No

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

flagCommentPublic Ejemplo

Copy

const tenantId: string = "tenant_42";
const commentId: string = "comment_1001";
const isFlagged: boolean = true;
const sso: string = "sso_user_5678";
const resultWithSso: APIEmptyResponse = await flagCommentPublic(tenantId, commentId, isFlagged, sso);
const resultWithoutSso: APIEmptyResponse = await flagCommentPublic(tenantId, commentId, false);

getGifLarge

Parámetros

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

Respuesta

Devuelve: GifGetLargeResponse

Ejemplo

Ejemplo getGifLarge

Copy

async function runExample() {
    const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
    const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/large/abc123.gif";
    const response: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
    console.log(response);
}

getGifsSearch

Parámetros

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

Respuesta

Devuelve: GetGifsSearchResponse

Ejemplo

Ejemplo getGifsSearch

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const search: string = "celebration fireworks";
  const locale: string = "fr-FR";
  const rating: string = "g";
  const page: number = 1;
  const fullResult: GetGifsSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);
  const minimalResult: GetGifsSearchResponse = await getGifsSearch(tenantId, "dog memes");
}
runExample();

getGifsTrending

Parámetros

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

Respuesta

Devuelve: GetGifsTrendingResponse

Ejemplo

Ejemplo getGifsTrending

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const locale: string = "en-US";
  const rating: string = "PG-13";
  const page: number = 1;
  const trendingAll: GetGifsTrendingResponse = await getGifsTrending(tenantId, locale, rating, page);
  console.log(trendingAll);
  // Usando solo el parámetro requerido
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

addHashTag

Parámetros

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

Respuesta

Devuelve: CreateHashTagResponse

Ejemplo

Ejemplo addHashTag

Copy

const tenantId: string = "c3f5e8b2-9d4a-4f6a-8b2c-1a2b3c4d5e6f";
const tagPayload: CreateHashTagBody = {
  tag: "typescript",
  description: "Discussions about TypeScript"
};
const responseWithBody: CreateHashTagResponse = await addHashTag(tenantId, tagPayload);
const responseWithoutBody: CreateHashTagResponse = await addHashTag(tenantId);

addHashTagsBulk

Parámetros

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

Respuesta

Devuelve: BulkCreateHashTagsResponse

Ejemplo

Ejemplo addHashTagsBulk

Copy

const tenantId: string = "tenant_9f8b7c6d";
const tags: BulkCreateHashTagsBodyTagsInner[] = [
  { name: "typescript", color: "#3178c6" },
  { name: "fastcomments", color: "#ff6600" }
];
const bulkBody: BulkCreateHashTagsBody = { tags };
const resultWithBody: BulkCreateHashTagsResponse = await addHashTagsBulk(tenantId, bulkBody);
const resultWithoutBody: BulkCreateHashTagsResponse = await addHashTagsBulk(tenantId);

deleteHashTag

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
tag	string	Sí
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deleteHashTag

Copy

const tenantId: string = "tenant_42";
const tag: string = "high-priority";
const requestBody: DeleteHashTagRequestBody = {
  // rellenar campos según sea necesario
};
const resultWithBody: APIEmptyResponse = await deleteHashTag(tenantId, tag, requestBody);
const resultWithoutBody: APIEmptyResponse = await deleteHashTag(tenantId, tag);

getHashTags

Parámetros

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

Respuesta

Devuelve: GetHashTagsResponse

Ejemplo

Ejemplo de getHashTags

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const page: number = 1;
    const result: GetHashTagsResponse = await getHashTags(tenantId, page);
    console.log(result);
})();

patchHashTag

Parámetros

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

Respuesta

Devuelve: UpdateHashTagResponse

Ejemplo

Ejemplo patchHashTag

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const tag: string = "news";
  // Llamada sin cuerpo opcional
  const responseWithoutBody: UpdateHashTagResponse = await patchHashTag(tenantId, tag);
  // Preparar cuerpo para la actualización
  const updateBody: UpdateHashTagBody = {
    name: "Latest News",
    description: "Tag for the most recent news articles"
  };
  const responseWithBody: UpdateHashTagResponse = await patchHashTag(tenantId, tag, updateBody);
})();

getMe

Identifica la credencial en uso: el inquilino al que pertenece y, para tokens OAuth, el usuario que la autorizó.
Las integraciones usan esto para probar una conexión y etiquetarla.

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetMeResponse

Ejemplo

Ejemplo getMe

Copy

(async () => {
  const tenantId: string = "acme-corp-tenant";
  const me: GetMeResponse = await getMe(tenantId);
  const authType: MeAuthType = me.auth.type;
  const scopes: OAuthScope[] = me.auth.scopes ?? [];
  const status: APIStatus = me.status;
})();

deleteModerationVote

Parámetros

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

Respuesta

Devuelve: VoteDeleteResponse

Ejemplo

Ejemplo de deleteModerationVote

Copy

async function runDeleteModerationVote(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6a";
  const commentId: string = "comment_4d3e2f1a";
  const voteId: string = "vote_12345abcde";
  const broadcastId: string | undefined = "broadcast_2023_09_15";
  const sso: string | undefined = "sso_user_7890token";
  const result: VoteDeleteResponse = await deleteModerationVote(
    tenantId,
    commentId,
    voteId,
    broadcastId,
    sso
  );
  console.log(result);
}

getApiComments

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
sso	string	No

Respuesta

Devuelve: ModerationAPIGetCommentsResponse

Ejemplo

Ejemplo getApiComments

Copy

async function fetchComments(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const page: number = 2;
  const count: number = 20;
  const textSearch: string = "typescript";
  const byIPFromComment: string = "192.168.1.100";
  const filters: string = "spam,offensive";
  const searchFilters: string = "user:john";
  const sorts: string = "date_desc";
  const demo: boolean = true;
  const sso: string = "sso_token_abc";
  const response: ModerationAPIGetCommentsResponse = await getApiComments(
    tenantId,
    page,
    count,
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    sorts,
    demo,
    sso
  );
}
fetchComments();

getApiExportStatus

Parámetros

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

Respuesta

Devuelve: ModerationExportStatusResponse

Ejemplo

Ejemplo getApiExportStatus

Copy

async function run() {
  const tenantId: string = "tenant_12345";
  const batchJobId: string = "job_98765";
  const ssoToken: string = "sso_abcde12345";
  const statusOnlyTenant: ModerationExportStatusResponse = await getApiExportStatus(tenantId);
  const statusWithBatch: ModerationExportStatusResponse = await getApiExportStatus(tenantId, batchJobId);
  const statusFull: ModerationExportStatusResponse = await getApiExportStatus(tenantId, batchJobId, ssoToken);
}
run();

getApiIds

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
sso	string	No

Respuesta

Devuelve: ModerationAPIGetCommentIdsResponse

Ejemplo

Ejemplo getApiIds

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme-corp";
  const textSearch: string = "offensive language";
  const byIPFromComment: string = "203.0.113.45";
  const filters: string = "status:unmoderated";
  const searchFilters: string = "author:alice";
  const afterId: string = "cmt_00123";
  const demo: boolean = true;
  const sso: string = "sso_9f8e7d6c";
  const fullResult: ModerationAPIGetCommentIdsResponse = await getApiIds(
    tenantId,
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    afterId,
    demo,
    sso
  );
  const minimalResult: ModerationAPIGetCommentIdsResponse = await getApiIds(tenantId);
}

getBanUsersFromComment

Parámetros

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

Respuesta

Devuelve: GetBannedUsersFromCommentResponse

Ejemplo

Ejemplo getBanUsersFromComment

Copy

const tenantId: string = "tenant_9f8b7c";
const commentId: string = "comment_a1b2c3";
const ssoToken: string = "sso_abc123";
const bannedUsers: GetBannedUsersFromCommentResponse = await getBanUsersFromComment(tenantId, commentId, ssoToken);
const bannedUsersNoSso: GetBannedUsersFromCommentResponse = await getBanUsersFromComment(tenantId, commentId);

getCommentBanStatus

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
sso	string	No

Respuesta

Devuelve: GetCommentBanStatusResponse

Ejemplo

Ejemplo getCommentBanStatus

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_987654";
  const ssoToken: string = "sso_user_abc";
  const statusWithSso: GetCommentBanStatusResponse = await getCommentBanStatus(tenantId, commentId, ssoToken);
  const statusWithoutSso: GetCommentBanStatusResponse = await getCommentBanStatus(tenantId, commentId);
})();

getCommentChildren

Parámetros

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

Respuesta

Devuelve: ModerationAPIChildCommentsResponse

Ejemplo

Ejemplo de getCommentChildren

Copy

async function fetchChildren() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const ssoToken: string = "sso_user_abc123";
  const responseWithSSO: ModerationAPIChildCommentsResponse = await getCommentChildren(tenantId, commentId, ssoToken);
  const responseWithoutSSO: ModerationAPIChildCommentsResponse = await getCommentChildren(tenantId, commentId);
}
fetchChildren();

getCount

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	boolean	No
sso	string	No

Respuesta

Devuelve: ModerationAPICountCommentsResponse

Ejemplo

Ejemplo getCount

Copy

const tenantId: string = "tenant_12345";
const basicCount: ModerationAPICountCommentsResponse = await getCount(tenantId);
const detailedCount: ModerationAPICountCommentsResponse = await getCount(
  tenantId,
  "spam",
  "192.168.1.100",
  "status:pending",
  "user:john",
  true,
  "sso_token_abc"
);

getCounts

Parámetros

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

Respuesta

Devuelve: GetBannedUsersCountResponse

Ejemplo

Ejemplo getCounts

Copy

async function run() {
  const tenantId: string = "tenant_9876";
  const ssoToken: string = "sso_user_42";
  const resultWithOnlyTenant: GetBannedUsersCountResponse = await getCounts(tenantId);
  const resultWithBoth: GetBannedUsersCountResponse = await getCounts(tenantId, ssoToken);
}
run();

getLogs

Parámetros

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

Respuesta

Devuelve: ModerationAPIGetLogsResponse

Ejemplo

Ejemplo getLogs

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const commentId: string = "cmt_4567890";
  const ssoToken: string = "sso_abcdef123456";
  const logsWithSso: ModerationAPIGetLogsResponse = await getLogs(tenantId, commentId, ssoToken);
  const logsWithoutSso: ModerationAPIGetLogsResponse = await getLogs(tenantId, commentId);
})();

getManualBadges

Parámetros

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

Respuesta

Devuelve: GetTenantManualBadgesResponse

Ejemplo

Ejemplo getManualBadges

Copy

async function fetchBadges() {
  const tenantId: string = "tenant-987654321";
  const ssoToken: string = "sso-token-abc123";
  const badgesWithSso: GetTenantManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  const badgesWithoutSso: GetTenantManualBadgesResponse = await getManualBadges(tenantId);
}

getManualBadgesForUser

Parámetros

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

Respuesta

Devuelve: GetUserManualBadgesResponse

Ejemplo

Ejemplo getManualBadgesForUser

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const badgesUserId: string | undefined = "user_98765";
  const commentId: string | undefined = "comment_abcde";
  const sso: string | undefined = "sso_token_xyz";
  const basicResponse: GetUserManualBadgesResponse = await getManualBadgesForUser(tenantId);
  const fullResponse: GetUserManualBadgesResponse = await getManualBadgesForUser(
    tenantId,
    badgesUserId,
    commentId,
    sso
  );
  console.log(basicResponse, fullResponse);
}();

getModerationComment

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
includeEmail	boolean	No
includeIP	boolean	No
sso	string	No

Respuesta

Devuelve: ModerationAPICommentResponse

Ejemplo

Ejemplo de getModerationComment

Copy

async function fetchComments() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_1234567890";
  // Llamada con solo los parámetros requeridos
  const basicResponse: ModerationAPICommentResponse = await getModerationComment(tenantId, commentId);
  // Llamada con parámetros opcionales
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const sso: string = "sso-token-abc123";
  const detailedResponse: ModerationAPICommentResponse = await getModerationComment(
    tenantId,
    commentId,
    includeEmail,
    includeIP,
    sso
  );
}

getModerationCommentText

Parámetros

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
sso	string	No

Respuesta

Returns: GetCommentTextResponse

Ejemplo

Ejemplo getModerationCommentText

Copy

async function fetchComment() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const ssoToken: string = "sso_abcde12345";
  const commentWithoutSso: GetCommentTextResponse = await getModerationCommentText(tenantId, commentId);
  const commentWithSso: GetCommentTextResponse = await getModerationCommentText(tenantId, commentId, ssoToken);
}
fetchComment();

getPreBanSummary

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
sso	string	No

Respuesta

Devuelve: PreBanSummary

Ejemplo

Ejemplo getPreBanSummary

Copy

async function fetchSummary(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const includeByUserIdAndEmail: boolean = true;
  const includeByIP: boolean = false;
  const includeByEmailDomain: boolean = true;
  const sso: string = "sso_token_abc";
  const summary: PreBanSummary = await getPreBanSummary(
    tenantId,
    commentId,
    includeByUserIdAndEmail,
    includeByIP,
    includeByEmailDomain,
    sso
  );
  console.log(summary);
}
fetchSummary();

getSearchCommentsSummary

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
value	string	No
filters	string	No
searchFilters	string	No
sso	string	No

Respuesta

Devuelve: ModerationCommentSearchResponse

Ejemplo

Ejemplo de getSearchCommentsSummary

Copy

async function runSearch() {
  const tenantId: string = "tenant_12345";
  const value: string = "spam";
  const filters: string = "status:pending";
  const searchFilters: string = "author:john";
  const sso: string = "sso_token_abc";
  const result: ModerationCommentSearchResponse = await getSearchCommentsSummary(
    tenantId,
    value,
    filters,
    searchFilters,
    sso
  );
  console.log(result);
}
runSearch();

getSearchPages

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
value	string	No
sso	string	No

Respuesta

Devuelve: ModerationPageSearchResponse

Ejemplo

Ejemplo getSearchPages

Copy

const tenantId: string = "acme-corp-123";
const searchValue: string = "spam";
const ssoToken: string = "sso-abc123def456";
const result1: ModerationPageSearchResponse = await getSearchPages(tenantId);
const result2: ModerationPageSearchResponse = await getSearchPages(tenantId, searchValue);
const result3: ModerationPageSearchResponse = await getSearchPages(tenantId, searchValue, ssoToken);

getSearchSites

Parámetros

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

Respuesta

Devuelve: ModerationSiteSearchResponse

Ejemplo

Ejemplo getSearchSites

Copy

async function runSearches(): Promise<void> {
  const tenantId: string = "tenant-987654";
  const query: string = "offensive content";
  const ssoToken: string = "sso-token-xyz";
  const fullResult: ModerationSiteSearchResponse = await getSearchSites(tenantId, query, ssoToken);
  const minimalResult: ModerationSiteSearchResponse = await getSearchSites(tenantId);
}
runSearches();

getSearchSuggest

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
textSearch	string	No
sso	string	No

Respuesta

Devuelve: ModerationSuggestResponse

Ejemplo

Ejemplo getSearchSuggest

Copy

(async () => {
  const tenantId: string = "tenant-9f8b7c6d";
  const textSearch: string = "harassment";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
  const suggestResponse: ModerationSuggestResponse = await getSearchSuggest(tenantId, textSearch, sso);
  const minimalResponse: ModerationSuggestResponse = await getSearchSuggest(tenantId);
})();

getSearchUsers

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
value	string	No
sso	string	No

Respuesta

Devuelve: ModerationUserSearchResponse

Ejemplo

Ejemplo getSearchUsers

Copy

async function runSearch() {
  const tenantId: string = "tenant-9876";
  const emailFragment: string = "jane";
  const ssoToken: string = "sso-token-456";
  const resultWithAll: ModerationUserSearchResponse = await getSearchUsers(tenantId, emailFragment, ssoToken);
  const resultWithTenantOnly: ModerationUserSearchResponse = await getSearchUsers(tenantId);
}

getTrustFactor

Parámetros

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

Respuesta

Devuelve: GetUserTrustFactorResponse

Ejemplo

Ejemplo getTrustFactor

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_98765";
  const sso: string = "sso_token_abcde";
  const trustFactor: GetUserTrustFactorResponse = await getTrustFactor(tenantId);
  const trustFactorWithUser: GetUserTrustFactorResponse = await getTrustFactor(tenantId, userId);
  const trustFactorFull: GetUserTrustFactorResponse = await getTrustFactor(tenantId, userId, sso);
}

getUserBanPreference

Parámetros

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

Respuesta

Devuelve: APIModerateGetUserBanPreferencesResponse

Ejemplo

getUserBanPreference Ejemplo

Copy

async function demoGetUserBanPreference() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_user_abc123xyz";
  const responseWithSso: APIModerateGetUserBanPreferencesResponse = await getUserBanPreference(tenantId, ssoToken);
  const responseWithoutSso: APIModerateGetUserBanPreferencesResponse = await getUserBanPreference(tenantId);
}

getUserInternalProfile

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	No
sso	string	No

Respuesta

Devuelve: GetUserInternalProfileResponse

Ejemplo

Ejemplo getUserInternalProfile

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_9876";
  const ssoToken: string = "sso_abcde12345";
  const profileOnly: GetUserInternalProfileResponse = await getUserInternalProfile(tenantId);
  const profileWithComment: GetUserInternalProfileResponse = await getUserInternalProfile(tenantId, commentId);
  const fullProfile: GetUserInternalProfileResponse = await getUserInternalProfile(tenantId, commentId, ssoToken);
}
demo();

postAdjustCommentVotes

Parámetros

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

Respuesta

Devuelve: AdjustVotesResponse

Ejemplo

Ejemplo de postAdjustCommentVotes

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_987654321";
const adjustParams: AdjustCommentVotesParams = { voteDelta: 1 };
const broadcastId: string = "brd_112233";
const sso: string = "sso-token-xyz";
const result: AdjustVotesResponse = await postAdjustCommentVotes(
  tenantId,
  commentId,
  adjustParams,
  broadcastId,
  sso
);

postApiExport

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
sso	string	No

Respuesta

Devuelve: ModerationExportResponse

Ejemplo

Ejemplo postApiExport

Copy

async function runExport() {
  const tenantId: string = "c9f1e2b4-8a6d-4f3a-9d2e-5b6c7d8e9f0a";
  const textSearch: string = "spam";
  const byIPFromComment: string = "203.0.113.45";
  const filters: string = "status:pending";
  const searchFilters: string = "createdAt>2023-01-01";
  const sorts: string = "createdAt:desc";
  const sso: string = "sso-token-abc123";
  const fullExport: ModerationExportResponse = await postApiExport(
    tenantId,
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    sorts,
    sso
  );
  const minimalExport: ModerationExportResponse = await postApiExport(tenantId);
  console.log(fullExport, minimalExport);
}
runExport();

postBanUserFromComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
banEmail	boolean	No
banEmailDomain	boolean	No
banIP	boolean	No
deleteAllUsersComments	boolean	No
bannedUntil	string	No
isShadowBan	boolean	No
updateId	string	No
banReason	string	No
sso	string	No

Respuesta

Devuelve: BanUserFromCommentResult

Ejemplo

Ejemplo postBanUserFromComment

Copy

async function banUserExample(): Promise<void> {
  const result: BanUserFromCommentResult = await postBanUserFromComment(
    "tenant_42",
    "comment_1001",
    true,                     // banEmail
    undefined,                // banEmailDomain (omitido)
    true,                     // banIP
    false,                    // deleteAllUsersComments
    "2025-01-01T00:00:00Z",   // bannedUntil
    true,                     // isShadowBan
    undefined,                // updateId (omitido)
    "Harassment",             // banReason
    undefined                 // sso (omitido)
  );
  console.log(result);
}

postBanUserUndo

Parámetros

Name	Type	Required
tenantId	string	Sí
banUserUndoParams	BanUserUndoParams	Sí
sso	string	No

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

postBanUserUndo Ejemplo

Copy

const tenantId: string = "tenant_9876";
const undoParams: BanUserUndoParams = {
  userId: "user_12345",
  // additional required fields can be added here
};
const resultWithoutSSO: APIEmptyResponse = await postBanUserUndo(tenantId, undoParams);
const ssoToken: string = "sso_abcdef123456";
const resultWithSSO: APIEmptyResponse = await postBanUserUndo(tenantId, undoParams, ssoToken);

postBulkPreBanSummary

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
bulkPreBanParams	BulkPreBanParams	Sí
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
sso	string	No

Respuesta

Devuelve: BulkPreBanSummary

Ejemplo

Ejemplo de postBulkPreBanSummary

Copy

const tenantId: string = "c1f2e3d4-5678-90ab-cdef-1234567890ab";
const bulkPreBanParams: BulkPreBanParams = {
  userIds: ["user123"],
  emails: ["spam@example.com"],
  ips: ["192.0.2.1"],
  emailDomains: ["example.com"]
};
const includeByUserIdAndEmail: boolean = true;
const includeByIP: boolean = false;
const includeByEmailDomain: boolean = true;
const sso: string = "sso-token-abc123";
const summary: BulkPreBanSummary = await postBulkPreBanSummary(
  tenantId,
  bulkPreBanParams,
  includeByUserIdAndEmail,
  includeByIP,
  includeByEmailDomain,
  sso
);

postCommentsByIds

Parámetros

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

Respuesta

Devuelve: ModerationAPIChildCommentsResponse

Ejemplo

Ejemplo postCommentsByIds

Copy

const tenantId: string = 'tenant-9f8b7c6d-1234-5678-90ab-cdef12345678';
const commentsByIdsParams: CommentsByIdsParams = {
  commentIds: ['comment-1', 'comment-2'],
  includeUserBadges: true
};
const responseWithoutSso: ModerationAPIChildCommentsResponse = await postCommentsByIds(tenantId, commentsByIdsParams);
const sso: string = 'sso-abc123def456';
const responseWithSso: ModerationAPIChildCommentsResponse = await postCommentsByIds(tenantId, commentsByIdsParams, sso);

postFlagComment

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de postFlagComment

Copy

async function runExample() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  // Solo parámetros requeridos
  const result1: APIEmptyResponse = await postFlagComment(tenantId, commentId);
  // Incluyendo parámetros opcionales
  const broadcastId: string = "brd_54321";
  const sso: string = "user@example.com";
  const result2: APIEmptyResponse = await postFlagComment(tenantId, commentId, broadcastId, sso);
  console.log(result1, result2);
}
runExample();

postRemoveComment

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: PostRemoveCommentApiResponse

Ejemplo

Ejemplo postRemoveComment

Copy

async function removeCommentExample() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_555";
  const sso: string = "sso_token_abc";
  const response: PostRemoveCommentApiResponse = await postRemoveComment(
    tenantId,
    commentId,
    broadcastId,
    sso
  );
  console.log(response);
}
removeCommentExample();

postRestoreDeletedComment

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de postRestoreDeletedComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const resultRequired: APIEmptyResponse = await postRestoreDeletedComment(tenantId, commentId);
const broadcastId: string = "brd_001";
const sso: string = "sso_token_abc123";
const resultAll: APIEmptyResponse = await postRestoreDeletedComment(
  tenantId,
  commentId,
  broadcastId,
  sso
);

postSetCommentApprovalStatus

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
commentId	string	Yes
approved	boolean	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: SetCommentApprovedResponse

Ejemplo

postSetCommentApprovalStatus Ejemplo

Copy

(async () => {
  const tenantId: string = "tenant_001";
  const commentId: string = "comment_123";
  const approved: boolean = false;
  const broadcastId: string = "broadcast_456";
  const sso: string = "sso_789";
  const result: SetCommentApprovedResponse = await postSetCommentApprovalStatus(
    tenantId,
    commentId,
    approved,
    broadcastId,
    sso
  );
  const minimalResult: SetCommentApprovedResponse = await postSetCommentApprovalStatus(
    tenantId,
    commentId
  );
})();

postSetCommentReviewStatus

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

postSetCommentReviewStatus Ejemplo

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const reviewed: boolean = true;
const broadcastId: string = "brd_001";
const sso: string = "sso_token_abc";
const result: APIEmptyResponse = await postSetCommentReviewStatus(
  tenantId,
  commentId,
  reviewed,
  broadcastId,
  sso
);

postSetCommentSpamStatus

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
commentId	string	Sí
spam	boolean	No
permNotSpam	boolean	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de postSetCommentSpamStatus

Copy

const tenantId: string = "tenant_42";
const commentId: string = "comment_1001";
const spam: boolean = true;
const permNotSpam: boolean = false;
const broadcastId: string = "broadcast_2023";
const sso: string = "sso_user_5678";
const resultFull: APIEmptyResponse = await postSetCommentSpamStatus(
  tenantId,
  commentId,
  spam,
  permNotSpam,
  broadcastId,
  sso
);
const resultMinimal: APIEmptyResponse = await postSetCommentSpamStatus(
  tenantId,
  commentId
);

postSetCommentText

Parámetros

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

Respuesta

Devuelve: SetCommentTextResponse

Ejemplo

postSetCommentText Ejemplo

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const setCommentTextParams: SetCommentTextParams = {
  text: "Revised comment after user edit.",
  format: "plain"
};
const broadcastId: string = "broadcast_2023_09";
const response: SetCommentTextResponse = await postSetCommentText(
  tenantId,
  commentId,
  setCommentTextParams,
  broadcastId
);
console.log(response);

postUnFlagComment

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

postUnFlagComment Ejemplo

Copy

async function runExample() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "comment_98765";
  const broadcastId: string = "broadcast_55555";
  const sso: string = "sso_token_abcde";
  const result1: APIEmptyResponse = await postUnFlagComment(tenantId, commentId);
  const result2: APIEmptyResponse = await postUnFlagComment(tenantId, commentId, broadcastId, sso);
}
runExample();

postVote

Parámetros

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

Respuesta

Devuelve: VoteResponse

Ejemplo

Ejemplo de postVote

Copy

async function runVoteExamples(): Promise<void> {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_1234567890";
  // Llamada con solo los parámetros obligatorios
  const simpleVote: VoteResponse = await postVote(tenantId, commentId);
  // Llamada con los parámetros opcionales
  const direction: string = "down";
  const broadcastId: string = "brd_987654321";
  const sso: string = "user-42";
  const detailedVote: VoteResponse = await postVote(tenantId, commentId, direction, broadcastId, sso);
  console.log(simpleVote, detailedVote);
}

putAwardBadge

Parámetros

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

Respuesta

Devuelve: AwardUserBadgeResponse

Ejemplo

Ejemplo putAwardBadge

Copy

async function awardBadgeExample(): Promise<void> {
  const tenantId: string = "tenant_42";
  const badgeId: string = "badge_superstar";
  const userId: string = "user_1001";
  const commentId: string = "comment_2023";
  const result: AwardUserBadgeResponse = await putAwardBadge(
    tenantId,
    badgeId,
    userId,
    commentId
  );
  console.log(result);
}

putCloseThread

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo putCloseThread

Copy

(async () => {
  const tenantId: string = "my-company";
  const urlId: string = "post-2023-09-15";
  const ssoToken: string = "sso-abc123def";
  const resultWithSso: APIEmptyResponse = await putCloseThread(tenantId, urlId, ssoToken);
  const resultWithoutSso: APIEmptyResponse = await putCloseThread(tenantId, urlId);
})();

putRemoveBadge

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
badgeId	string	Yes
userId	string	No
commentId	string	No
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: RemoveUserBadgeResponse

Ejemplo

Ejemplo putRemoveBadge

Copy

async function demoRemoveBadge() {
  const tenantId: string = "tenant_42";
  const badgeId: string = "badge_gold";
  const userId: string = "user_1001";
  const commentId: string = "comment_20230915";
  const broadcastId: string = "broadcast_live_01";
  const sso: string = "sso_abcdef123456";
  const result: RemoveUserBadgeResponse = await putRemoveBadge(
    tenantId,
    badgeId,
    userId,
    commentId,
    broadcastId,
    sso
  );
  console.log(result);
}

putReopenThread

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

putReopenThread Ejemplo

Copy

async function reopenThreadExample() {
    const tenantId: string = "tenant_12345";
    const urlId: string = "post-9876";
    const sso: string = "user-abc123";
    const responseWithoutSso: APIEmptyResponse = await putReopenThread(tenantId, urlId);
    const responseWithSso: APIEmptyResponse = await putReopenThread(tenantId, urlId, sso);
}
reopenThreadExample();

setTrustFactor

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
userId	string	No
trustFactor	string	No
sso	string	No

Respuesta

Devuelve: SetUserTrustFactorResponse

Ejemplo

Ejemplo de setTrustFactor

Copy

async function demoSetTrustFactor() {
  const tenantId: string = "acme-corp";
  const userId: string = "user-9876";
  const trustFactor: string = "high";
  const sso: string = "sso-token-xyz";
  const fullResponse: SetUserTrustFactorResponse = await setTrustFactor(
    tenantId,
    userId,
    trustFactor,
    sso
  );
  const minimalResponse: SetUserTrustFactorResponse = await setTrustFactor(tenantId);
}

createModerator

Parámetros

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

Respuesta

Devuelve: CreateModeratorResponse

Ejemplo

Ejemplo createModerator

Copy

const tenantId: string = "tenant_12345";
const moderatorPayload: CreateModeratorBody = {
  userId: "user_9876",
  // campo opcional; puede omitirse si no es necesario
  notes: "Temporary moderator for event"
};
const response: CreateModeratorResponse = await createModerator(tenantId, moderatorPayload);

deleteModerator

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deleteModerator

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const moderatorId: string = "mod_9876";
  const notifyEmail: string = "admin@company.com";
  const resultWithEmail: APIEmptyResponse = await deleteModerator(tenantId, moderatorId, notifyEmail);
  const resultWithoutEmail: APIEmptyResponse = await deleteModerator(tenantId, moderatorId);
})();

getModerator

Parámetros

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

Respuesta

Devuelve: GetModeratorResponse

Ejemplo

Ejemplo getModerator

Copy

async function fetchModerator() {
  const tenantId: string = "c9f1e2b3-4d5a-6f78-90ab-cdef12345678";
  const moderatorId: string = "mod-987654";
  const response: GetModeratorResponse = await getModerator(tenantId, moderatorId);
  const isActive: boolean | undefined = response.moderator?.isActive;
  const statusCode: number | undefined = response.status?.code;
}

getModerators

Parámetros

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

Respuesta

Devuelve: GetModeratorsResponse

Ejemplo

Ejemplo getModerators

Copy

const tenantId: string = "tenant_987654321";
const moderators: GetModeratorsResponse = await getModerators(tenantId);
const skip: number = 20;
const moreModerators: GetModeratorsResponse = await getModerators(tenantId, skip);

sendInvite

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de sendInvite

Copy

const tenantId: string = "tenant-987654321";
const id: string = "user-123456789";
const fromName: string = "Alice Johnson";
const result: APIEmptyResponse = await sendInvite(tenantId, id, fromName);
console.log(result);

updateModerator

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de updateModerator

Copy

const tenantId: string = "tenant_9f8b7c6d";
const moderatorId: string = "mod_12345";
const updateBody: UpdateModeratorBody = {
  isActive: true,
  // role?: string es opcional y se omite aquí
};
const result: APIEmptyResponse = await updateModerator(tenantId, moderatorId, updateBody);

deleteNotificationCount

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deleteNotificationCount

Copy

let tenantId: string = "tenant-42f9b8c1";
let notificationId: string = "notif-7e3a9d4f";
const result: APIEmptyResponse = await deleteNotificationCount(tenantId, notificationId);

getCachedNotificationCount

Parámetros

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

Respuesta

Devuelve: GetCachedNotificationCountResponse

Ejemplo

Ejemplo getCachedNotificationCount

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const id: string = "user_9876";
  const response: GetCachedNotificationCountResponse = await getCachedNotificationCount(tenantId, id);
})();

getNotificationCount

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

Respuesta

Devuelve: GetNotificationCountResponse

Ejemplo

Ejemplo getNotificationCount

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-12345";
const urlId: string = "https://app.example.com/dashboard";
const fromCommentId: string = "cmt-9876";
const viewed: boolean = false;
const type: string = "reply";
const notificationCount: GetNotificationCountResponse = await getNotificationCount(
  tenantId,
  userId,
  urlId,
  fromCommentId,
  viewed,
  type
);

getNotifications

Parámetros

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

Respuesta

Devuelve: GetNotificationsResponse

Ejemplo

Ejemplo de getNotifications

Copy

async function fetchNotifications(): Promise<void> {
  const tenantId: string = "tenant_42";
  const userId: string = "user_1001";
  const urlId: string = "url_2023";
  const viewed: boolean = true;
  const skip: number = 0;
  const notifications: GetNotificationsResponse = await getNotifications(
    tenantId,
    userId,
    urlId,
    undefined,
    viewed,
    undefined,
    skip
  );
  console.log(notifications);
}

updateNotification

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

updateNotification Ejemplo

Copy

async function main(): Promise<void> {
  const tenantId: string = "tenant-abc123";
  const notificationId: string = "notif-9876";
  const updateBody: UpdateNotificationBody = {
    title: "System Maintenance",
    message: "Scheduled maintenance at 02:00 UTC.",
    enabled: true
  };
  const userId: string = "user-42";
  const resultWithoutUser: APIEmptyResponse = await updateNotification(tenantId, notificationId, updateBody);
  const resultWithUser: APIEmptyResponse = await updateNotification(tenantId, notificationId, updateBody, userId);
}

createV1PageReact

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
title	string	No
sso	string	No

Respuesta

Devuelve: CreateV1PageReact

Ejemplo

createV1PageReact Ejemplo

Copy

const tenantId: string = "my-tenant-123";
const urlId: string = "article-456";
const pageTitle: string = "Understanding TypeScript Generics";
const ssoToken: string = "user-789-token";
const fullResult: CreateV1PageReact = await createV1PageReact(tenantId, urlId, pageTitle, ssoToken);
const minimalResult: CreateV1PageReact = await createV1PageReact(tenantId, urlId);

createV2PageReact

Parámetros

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

Respuesta

Devuelve: CreateV1PageReact

Ejemplo

Ejemplo createV2PageReact

Copy

async function run() {
  const tenantId: string = "acme-corp";
  const urlId: string = "product-page-123";
  const pageId: string = "page-456";
  const pageTitle: string = "Product Overview";
  const ssoToken: string = "jwt-token-abc123";
  const pageFull: CreateV1PageReact = await createV2PageReact(tenantId, urlId, pageId, pageTitle, ssoToken);
  const pageTitleOnly: CreateV1PageReact = await createV2PageReact(tenantId, urlId, pageId, pageTitle);
  const pageMinimal: CreateV1PageReact = await createV2PageReact(tenantId, urlId, pageId);
}
run();

deleteV1PageReact

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
urlId	string	Yes
sso	string	No

Respuesta

Devuelve: CreateV1PageReact

Ejemplo

Ejemplo deleteV1PageReact

Copy

async function runExamples() {
  const tenantId: string = "tenant_9f8b7c6d";
  const urlId: string = "blog/post-2024-06-15";
  const ssoToken: string = "sso_user_42";
  const resultWithSso: CreateV1PageReact = await deleteV1PageReact(tenantId, urlId, ssoToken);
  const resultWithoutSso: CreateV1PageReact = await deleteV1PageReact(tenantId, urlId);
}

deleteV2PageReact

Parameters

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

Response

Devuelve: CreateV1PageReact

Example

Ejemplo deleteV2PageReact

Copy

async function runDeleteExamples() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "page_98765";
  const commentId: string = "comment_abcde";
  // Llamada sin sso opcional
  const resultWithoutSso: CreateV1PageReact = await deleteV2PageReact(tenantId, urlId, commentId);
  // Llamada con sso opcional
  const ssoToken: string = "sso_token_xyz";
  const resultWithSso: CreateV1PageReact = await deleteV2PageReact(tenantId, urlId, commentId, ssoToken);
}

getV1PageLikes

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
urlId	string	Yes
sso	string	No

Respuesta

Devuelve: GetV1PageLikes

Ejemplo

Ejemplo getV1PageLikes

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const urlId: string = "https://myblog.com/post/42";
  const ssoToken: string = "sso_user_987";
  const likesWithSSO: GetV1PageLikes = await getV1PageLikes(tenantId, urlId, ssoToken);
  const likesWithoutSSO: GetV1PageLikes = await getV1PageLikes(tenantId, urlId);
})();

getV2PageReacts

Parámetros

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

Respuesta

Devuelve: GetV2PageReacts

Ejemplo

Ejemplo getV2PageReacts

Copy

const tenantId: string = "tenant-42";
const urlId: string = "article-9876";
const ssoToken: string = "sso-abc123";
const reactsWithSso: GetV2PageReacts = await getV2PageReacts(tenantId, urlId, ssoToken);
const reactsWithoutSso: GetV2PageReacts = await getV2PageReacts(tenantId, urlId);

getV2PageReactUsers

Parámetros

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

Respuesta

Devuelve: GetV2PageReactUsersResponse

Ejemplo

Ejemplo getV2PageReactUsers

Copy

async function demoGetUsers() {
  const tenantId: string = "d4e5f6a7-89ab-4cde-f012-3456789abcde";
  const urlId: string = "blog/2024/06/fastcomments-typescript";
  const userId: string = "user_123456789";
  const ssoToken: string = "sso_token_abcdef123456";
  const responseWithSso: GetV2PageReactUsersResponse = await getV2PageReactUsers(tenantId, urlId, userId, ssoToken);
  const responseWithoutSso: GetV2PageReactUsersResponse = await getV2PageReactUsers(tenantId, urlId, userId);
}

addPage

Parameters

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

Response

Devuelve: AddPageAPIResponse

Example

Ejemplo addPage

Copy

const tenantId: string = "tenant_9f8432b1-4c2e-4f9d-8a5d-7bc9e2f6d9a0";
const pageData: CreateAPIPageData = {
    url: "https://example.com/articles/fastcomments-intro",
    title: "FastComments Introduction",
    description: "An introductory guide to FastComments API usage.",
    tags: ["fastcomments", "api", "tutorial"],
    metadata: {
        author: "Jane Doe",
        publishedAt: "2024-03-15T08:00:00Z"
    }
};
const response: AddPageAPIResponse = await addPage(tenantId, pageData);

deletePage

Parámetros

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

Respuesta

Devuelve: DeletePageAPIResponse

Ejemplo

Ejemplo deletePage

Copy

async function example() {
    const tenantId: string = "acme-corp-001";
    const pageId: string = "page-987654321";
    const result: DeletePageAPIResponse = await deletePage(tenantId, pageId);
    console.log(result);
}
example();

getOfflineUsers

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

Parameters

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	Sí
afterName	string	No
afterUserId	string	No

Response

Returns: PageUsersOfflineResponse

Example

Ejemplo getOfflineUsers

Copy

async function fetchOfflineUsers(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const urlId: string = "page_9876";
  const afterName: string = "John Doe";
  const afterUserId: string = "user_abc123";
  const offlineResponse: PageUsersOfflineResponse = await getOfflineUsers(
    tenantId,
    urlId,
    afterName,
    afterUserId
  );
  console.log(offlineResponse);
}

getOnlineUsers

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

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
afterName	string	No
afterUserId	string	No

Respuesta

Devuelve: PageUsersOnlineResponse

Ejemplo

Ejemplo getOnlineUsers

Copy

async function fetchOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "article-9876";
  const afterName: string | undefined = "john_doe";
  const afterUserId: string | undefined = "user_456";
  const onlineUsers: PageUsersOnlineResponse = await getOnlineUsers(
    tenantId,
    urlId,
    afterName,
    afterUserId
  );
  console.log(onlineUsers);
}
fetchOnlineUsers();

getPageByURLId

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Respuesta

Devuelve: GetPageByURLIdAPIResponse

Ejemplo

Ejemplo getPageByURLId

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_9876";
  const response: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
  const page: APIPage | undefined = response.page;
})();

getPages

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetPagesAPIResponse

Ejemplo

Ejemplo getPages

Copy

const tenantId: string = "tenant_12345";
(async () => {
  const response: GetPagesAPIResponse = await getPages(tenantId);
  const firstPage: APIPage | undefined = response.pages?.[0];
  console.log(firstPage?.title);
})();

getPagesPublic

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requiere que enableFChat sea verdadero en la configuración personalizada resuelta para cada página.
Las páginas que requieren SSO se filtran según el acceso a grupos del usuario solicitante.

Parameters

Name	Type	Required
tenantId	string	Yes
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

Response

Devuelve: GetPublicPagesResponse

Example

Ejemplo getPagesPublic

Copy

async function fetchPublicPages() {
  const tenantId: string = "tenant_12345";
  const cursor: string = "page_5";
  const limit: number = 20;
  const query: string = "support";
  const hasComments: boolean = true;
  const response: GetPublicPagesResponse = await getPagesPublic(
    tenantId,
    cursor,
    limit,
    query,
    undefined,
    hasComments
  );
  console.log(response);
}

getUsersInfo

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

Parámetros

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

Respuesta

Devuelve: PageUsersInfoResponse

Ejemplo

Ejemplo getUsersInfo

Copy

async function fetchUsersInfo(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const ids: string = "user_001,user_002";
  const response: PageUsersInfoResponse = await getUsersInfo(tenantId, ids);
  console.log(response);
}
fetchUsersInfo();

patchPage

Parámetros

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

Respuesta

Devuelve: PatchPageAPIResponse

Ejemplo

Ejemplo patchPage

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string puede omitirse
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

deletePendingWebhookEvent

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

deletePendingWebhookEvent Ejemplo

Copy

async function runDeletion() {
  const tenantId: string = "tenant-42f7b9c2";
  const eventId: string = "webhook-event-8a7d6c5b";
  const result: APIEmptyResponse = await deletePendingWebhookEvent(tenantId, eventId);
  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: GetPendingWebhookEventCountResponse

Ejemplo

Ejemplo getPendingWebhookEventCount

Copy

async function runExample() {
  const tenantId: string = "tenant_42";
  const commentId: string = "comment_1001";
  const eventType: string = "comment.deleted";
  const domain: string = "myblog.com";
  const result: GetPendingWebhookEventCountResponse = await getPendingWebhookEventCount(
    tenantId,
    commentId,
    undefined,
    eventType,
    undefined,
    domain
  );
  console.log(result);
}
runExample();

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: GetPendingWebhookEventsResponse

Ejemplo

Ejemplo getPendingWebhookEvents

Copy

const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
const commentId: string = "cmt_987654321";
const externalId: string = "ext_abc123";
const eventType: string = "comment_created";
const type: string = "outbound";
const domain: string = "myblog.com";
const attemptCountGT: number = 2;
const skip: number = 10;
const pendingEvents: GetPendingWebhookEventsResponse = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

createPollVote

Record a vote on a poll, or move an existing one to a different option. A voter has at most one vote per poll, so calling this again for the same voter moves their vote rather than adding one.

Esto respeta la configuración de encuestas del sitio: si la votación está configurada solo para usuarios registrados, un voto con solo un anonUserId es rechazado, y los votos anónimos están limitados por tasa por IP por encuesta.

Parameters

Nombre	Tipo	Requerido	Descripción
tenantId	string	Sí
createPollVoteBody	CreatePollVoteBody	Sí

Response

Returns: CreatePollVoteResponse

Example

Ejemplo createPollVote

Copy

(async () => {
  const tenantId: string = "acme-corp-tenant";
  const vote: CreatePollVoteBody = {
    pollId: "poll-2024-09",
    optionId: "option-A"
    // userId es opcional y se omite aquí
  };
  const result: CreatePollVoteResponse = await createPollVote(tenantId, vote);
  console.log(result);
})();

deletePollVote

Retirar un voto. La opción en la que se emitió devuelve su recuento.

Parámetros

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

Respuesta

Devuelve: DeletePollVoteResponse

Ejemplo

Ejemplo deletePollVote

Copy

async function runDeletePollVoteExample(): Promise<void> {
  const tenantId: string = "tenant_42abc";
  const pollId: string = "poll_7f9e2d";
  const result: DeletePollVoteResponse = await deletePollVote(tenantId, pollId);
  console.log(result);
}

getPollVote

Parámetros

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

Respuesta

Devuelve: GetPollVoteResponse

Ejemplo

Ejemplo getPollVote

Copy

async function fetchPollVote(): Promise<void> {
  const tenantId: string = "acme-corp-tenant";
  const pollId: string = "poll-2024-05";
  const result: GetPollVoteResponse = await getPollVote(tenantId, pollId);
  const status: APIStatus = result.status;
  const vote: PublicPollVote | undefined = result.vote;
}

getPollVotes

Los votos individuales detrás de los recuentos de una encuesta, del más antiguo al más reciente.

Una encuesta pertenece a un comentario, por lo que los votos siempre se leen una encuesta a la vez - commentId es obligatorio. Eso mantiene cada consulta en los índices que ya tiene la colección.

Respeta la privacidad de la encuesta: los votos de una encuesta anónima no pueden leerse (poll-anonymous), aquí o por id.

Parameters

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
voterId	string	No
optionId	string	No
skip	number	No

Response

Devuelve: GetPollVotesResponse

Example

Ejemplo getPollVotes

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const voterId: string = "user_abc";
const optionId: string = "opt_1";
const skip: number = 20;
const pollResult: GetPollVotesResponse = await getPollVotes(
  tenantId,
  commentId,
  voterId,
  optionId,
  skip
);
console.log(pollResult);

deletePoll

Eliminar una encuesta de su comentario, junto con todos los votos emitidos en ella. El propio comentario se deja sin cambios.

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deletePoll

Copy

async function runDeletePoll(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const commentId: string = "comment_a1b2c3d4";
  const result: APIEmptyResponse = await deletePoll(tenantId, commentId);
  console.log(result);
}

getPoll

Parámetros

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

Respuesta

Devuelve: GetPollResponse

Ejemplo

Ejemplo getPoll

Copy

const tenantId: string = "c9f1e2b4-8a3d-4f6a-9d2e-7b5c1a2f3e4d";
const commentId: string = "a1b2c3d4e5f6g7h8i9j0";
const pollResponse: GetPollResponse = await getPoll(tenantId, commentId);
const poll: CommentPoll | undefined = pollResponse.poll;
const privacy: PollPrivacy | undefined = poll?.privacy;
const options: CommentPollOption[] | undefined = poll?.options;

patchPoll

Editar una encuesta en el lugar, manteniendo sus recuentos: cambiar la pregunta, volver a etiquetar una opción, cerrar o reabrirla, o cambiar quién puede ver a los votantes. Las opciones se identifican por id; para añadir, eliminar o reordenarlas, haga PUT de la lista completa.

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
commentPollPatch	CommentPollPatch	Sí

Respuesta

Devuelve: SavePollResponse

Ejemplo

Ejemplo patchPoll

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_9876543210";
  const pollPatch: CommentPollPatch = {
    question: "Which new feature would you like to see?",
    options: [
      { id: "opt-1", label: "Dark Mode" },
      { id: "opt-2", label: "Multi-language Support" }
    ]
  };
  const response: SavePollResponse = await patchPoll(tenantId, commentId, pollPatch);
  console.log(response);
})();

putPoll

Adjunte una encuesta a un comentario, o establezca el estado completo de la encuesta que ya tiene.

Las opciones se emparejan por id: una opción enviada con el id de una opción existente conserva sus votos (y toma la nueva etiqueta y posición), una opción enviada sin id se agrega, y las opciones existentes que se omiten de la lista se eliminan junto con los votos emitidos en ellas.

Mantener sin ids de opciones existentes en una encuesta que tiene votos elimina todas ellas, por lo que se necesita replaceVotes=true.

Parameters

Nombre	Tipo	Obligatorio
tenantId	string	Sí
commentId	string	Sí
commentPollPutInput	CommentPollPutInput	Sí
replaceVotes	boolean	No

Response

Returns: SavePollResponse

Example

Ejemplo putPoll

Copy

const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
const commentId: string = "9876543210";
const optionA: CommentPollOptionInput = { text: "Dark mode" };
const optionB: CommentPollOptionInput = { text: "Light mode" };
const pollInput: CommentPollPutInput = {
  question: "Which UI theme do you prefer?",
  options: [optionA, optionB],
};
const replaceVotes: boolean = true;
const result: SavePollResponse = await putPoll(tenantId, commentId, pollInput, replaceVotes);

createQuestionConfig

Parámetros

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

Respuesta

Devuelve: CreateQuestionConfigResponse

Ejemplo

createQuestionConfig Ejemplo

Copy

async function runExample() {
  const tenantId: string = "acme-corp-123";
  const customOption: QuestionConfigCustomOptionsInner = {
    key: "maxLength",
    value: 500,
  };
  const createQuestionConfigBody: CreateQuestionConfigBody = {
    name: "User Feedback",
    description: "Collect user feedback after purchase",
    enabled: true,
    customOptions: [customOption],
    // campo opcional
    tags: ["feedback", "post-purchase"],
  };
  const response: CreateQuestionConfigResponse = await createQuestionConfig(
    tenantId,
    createQuestionConfigBody
  );
  console.log(response);
}

deleteQuestionConfig

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de deleteQuestionConfig

Copy

async function executeDeletion() {
  const tenantId: string = "tenant_12345";
  const configId: string = "config_9876";
  const result: APIEmptyResponse = await deleteQuestionConfig(tenantId, configId);
  console.log(result);
}
executeDeletion();

getQuestionConfig

Parámetros

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

Respuesta

Devuelve: GetQuestionConfigResponse

Ejemplo

Ejemplo getQuestionConfig

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "q-987654321";
const configResponse: GetQuestionConfigResponse = await getQuestionConfig(tenantId, questionId);
const status: APIStatus = configResponse.status;
const questionConfig?: QuestionConfig = configResponse.question;
const firstOption?: QuestionConfigCustomOptionsInner = questionConfig?.customOptions?.[0];

getQuestionConfigs

Parámetros

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

Respuesta

Devuelve: GetQuestionConfigsResponse

Ejemplo

Ejemplo getQuestionConfigs

Copy

async function fetchConfigs() {
  const tenantId: string = "tenant_12345";
  const firstPage: GetQuestionConfigsResponse = await getQuestionConfigs(tenantId);
  const secondPage: GetQuestionConfigsResponse = await getQuestionConfigs(tenantId, 20);
}

updateQuestionConfig

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de updateQuestionConfig

Copy

(async () => {
  const tenantId: string = "acme-corp-tenant";
  const questionId: string = "question-42";
  const updateBody: UpdateQuestionConfigBody = {
    title: "Revised FAQ Question"
    // isActive, customOptions, etc. son opcionales y se omiten
  };
  const response: APIEmptyResponse = await updateQuestionConfig(tenantId, questionId, updateBody);
  console.log(response);
})();

createQuestionResult

Parámetros

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

Respuesta

Devuelve: CreateQuestionResultResponse

Ejemplo

Ejemplo de createQuestionResult

Copy

const tenantId: string = "tenant_12345";
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "q_9876",
  answer: "Yes",
  score: 5,
  meta: [
    { key: "source", value: "survey" }
  ]
};
const result: CreateQuestionResultResponse = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

deleteQuestionResult Ejemplo

Copy

async function runDelete() {
  const tenantId: string = "tenant_12345";
  const resultId: string = "qr_98765";
  const response: APIEmptyResponse = await deleteQuestionResult(tenantId, resultId);
  console.log(response);
}

getQuestionResult

Parámetros

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

Respuesta

Devuelve: GetQuestionResultResponse

Ejemplo

Ejemplo getQuestionResult

Copy

const tenantId: string = "tenant_12345";
const questionId: string = "question_98765";
const response: GetQuestionResultResponse = await getQuestionResult(tenantId, questionId);
const status: APIStatus | undefined = response.status;
const firstResult: QuestionResult | undefined = response.results?.[0];
const firstMeta: MetaItem | undefined = response.meta?.[0];
console.log(response);

getQuestionResults

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Respuesta

Devuelve: GetQuestionResultsResponse

Ejemplo

Ejemplo getQuestionResults

Copy

async function fetchResults() {
  const tenantId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';
  const urlId: string = 'blog-post-789';
  const startDate: string = '2023-01-01T00:00:00Z';
  const questionIds: string = 'q-abc123,q-def456';
  const response: GetQuestionResultsResponse = await getQuestionResults(
    tenantId,
    urlId,
    undefined,
    startDate,
    undefined,
    questionIds
  );
  console.log(response);
}

updateQuestionResult

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

updateQuestionResult Ejemplo

Copy

const tenantId: string = "c1f5e8b2-9a4d-4f3a-8d2e-6b7c9d0e1f2a";
const questionId: string = "qstn_1234567890";
const updateBody: UpdateQuestionResultBody = {
  score: 85,
  comment: "Adjusted based on new criteria",
  meta: [
    { key: "reviewer", value: "john.doe@example.com" },
    { key: "timestamp", value: new Date().toISOString() }
  ]
};
const response: APIEmptyResponse = await updateQuestionResult(tenantId, questionId, updateBody);

aggregateQuestionResults

Parámetros

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

Respuesta

Devuelve: AggregateQuestionResultsResponse

Ejemplo

aggregateQuestionResults Ejemplo

Copy

async function runAggregation() {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const questionId: string = 'question-9f8e7d6c5b4a3';
  const questionIds: string[] = ['question-1a2b3c', 'question-4d5e6f'];
  const urlId: string = 'blog-post-2023-08-15';
  const startDate: Date = new Date('2023-01-01T00:00:00Z');
  const forceRecalculate: boolean = true;
  const result: AggregateQuestionResultsResponse = await aggregateQuestionResults(
    tenantId,
    questionId,
    questionIds,
    urlId,
    undefined,
    startDate,
    forceRecalculate
  );
}

bulkAggregateQuestionResults

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Yes
forceRecalculate	boolean	No

Respuesta

Devuelve: BulkAggregateQuestionResultsResponse

Ejemplo

Ejemplo bulkAggregateQuestionResults

Copy

const tenantId: string = "tenant_12345";
const request: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: "q_9876",
      startDate: "2023-01-01T00:00:00Z",
      endDate: "2023-01-31T23:59:59Z",
      timeBucket: "day"
    }
  ]
};
const response: BulkAggregateQuestionResultsResponse = await bulkAggregateQuestionResults(tenantId, request, true);

combineCommentsWithQuestionResults

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
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: CombineQuestionResultsWithCommentsResponse

Ejemplo

Ejemplo de combineCommentsWithQuestionResults

Copy

async function runExample() {
  const tenantId: string = "tenant_12345";
  const questionId: string | undefined = "q_987";
  const questionIds: string[] = ["q_001", "q_002"];
  const urlId: string | undefined = "url_abc";
  const startDate: Date = new Date("2023-01-01T00:00:00Z");
  const forceRecalculate: boolean = true;
  const minValue: number = 0;
  const maxValue: number = 100;
  const limit: number = 50;
  const result: CombineQuestionResultsWithCommentsResponse = await combineCommentsWithQuestionResults(
    tenantId,
    questionId,
    questionIds,
    urlId,
    startDate,
    forceRecalculate,
    minValue,
    maxValue,
    limit
  );
  console.log(result);
}
runExample();

addSSOUser

Parámetros

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

Respuesta

Devuelve: AddSSOUserAPIResponse

Ejemplo

Ejemplo addSSOUser

Copy

const tenantId: string = "tenant_12345";
const newUser: CreateAPISSOUserData = {
  userId: "sso_user_987",
  name: "Jane Doe",
  email: "jane.doe@example.com",
  // campo opcional
  avatarUrl: "https://example.com/avatars/jane.jpg",
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, newUser);

deleteSSOUser

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

Respuesta

Devuelve: DeleteSSOUserAPIResponse

Ejemplo

Ejemplo deleteSSOUser

Copy

const tenantId: string = "acme-corp-tenant";
const userId: string = "sso-user-42";
const deleteComments: boolean = true;
const commentDeleteMode: string = "hard";
const detailedResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId,
  deleteComments,
  commentDeleteMode
);
const simpleResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId
);

getSSOUserByEmail

Parámetros

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

Respuesta

Devuelve: GetSSOUserByEmailAPIResponse

Ejemplo

Ejemplo getSSOUserByEmail

Copy

async function fetchSSOUser() {
  const tenantId: string = "tenant_12345";
  const email: string = "john.doe@example.com";
  const result: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
  const user: APISSOUser | undefined = result?.user;
}

getSSOUserById

Parámetros

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

Respuesta

Devuelve: GetSSOUserByIdAPIResponse

Ejemplo

Ejemplo getSSOUserById

Copy

async function fetchUser() {
  const tenantId: string = "tenant-987654321";
  const userId: string = "sso-user-abc123";
  const result: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, userId);
  const ssoUser: APISSOUser = result.user;
}

getSSOUsers

Parámetros

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

Respuesta

Devuelve: GetSSOUsersResponse

Ejemplo

getSSOUsers Ejemplo

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // Llamada sin `skip` opcional
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // Llamada con `skip` opcional
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

patchSSOUser

Parámetros

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

Respuesta

Devuelve: PatchSSOUserAPIResponse

Ejemplo

Ejemplo patchSSOUser

Copy

const tenantId: string = "c1f2a3b4-5678-90ab-cdef-1234567890ab";
const userId: string = "user-987654321";
const updateData: UpdateAPISSOUserData = {
  email: "jane.smith@enterprise.com",
  displayName: "Jane Smith",
  role: "editor"
};
const responseWithComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData,
  true
);
const responseWithoutComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData
);

putSSOUser

Parámetros

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

Respuesta

Devuelve: PutSSOUserAPIResponse

Ejemplo

Ejemplo putSSOUser

Copy

(async () => {
  const tenantId: string = "tenant_abc123";
  const userId: string = "user_456def";
  const updateData: UpdateAPISSOUserData = {
    email: "jane.doe@example.com",
    displayName: "Jane Doe",
    isActive: true,
  };
  const response: PutSSOUserAPIResponse = await putSSOUser(tenantId, userId, updateData, true);
})();

createSubscription

Parámetros

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

Respuesta

Devuelve: CreateSubscriptionAPIResponse

Ejemplo

Ejemplo createSubscription

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const subscriptionData: CreateAPIUserSubscriptionData = {
        userId: "user-456",
        planId: "premium-monthly",
        startDate: new Date(),
        trialPeriodDays: 14 // campo opcional
    };
    const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, subscriptionData);
    console.log(result);
})();

deleteSubscription

Parámetros

Name	Type	Required
tenantId	string	Yes
id	string	Yes
userId	string	No

Respuesta

Returns: DeleteSubscriptionAPIResponse

Ejemplo

Ejemplo de deleteSubscription

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // Con userId opcional
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // Sin userId opcional
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

getSubscriptions

Parámetros

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

Respuesta

Devuelve: GetSubscriptionsAPIResponse

Ejemplo

Ejemplo getSubscriptions

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const userId: string = "user-789";
    const responseWithUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
    const responseWithoutUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
})();

updateSubscription

Parámetros

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

Respuesta

Devuelve: UpdateSubscriptionAPIResponse

Ejemplo

Ejemplo de updateSubscription

Copy

const tenantId: string = "tenant_12345";
const subscriptionId: string = "sub_98765";
const updateData: UpdateAPIUserSubscriptionData = {
  planId: "premium_plan",
  status: "active",
  renewalDate: "2024-12-31",
};
const userId: string = "user_abcde";
const response: UpdateSubscriptionAPIResponse = await updateSubscription(
  tenantId,
  subscriptionId,
  updateData,
  userId
);

getTenantDailyUsages

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

Respuesta

Devuelve: GetTenantDailyUsagesResponse

Ejemplo

Ejemplo getTenantDailyUsages

Copy

async function demoGetTenantDailyUsages() {
  const tenantId: string = "tenant_9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 2;
  const dayNumber: number = 28;
  const skip: number = 10;
  const fullResult: GetTenantDailyUsagesResponse = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  const partialResult: GetTenantDailyUsagesResponse = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
}

createTenantPackage

Parámetros

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

Respuesta

Devuelve: CreateTenantPackageResponse

Ejemplo

Ejemplo createTenantPackage

Copy

async function runExample() {
  const tenantId: string = "tenant_9f8b7c6d";
  const createTenantPackageBody: CreateTenantPackageBody = {
    name: "Enterprise Package",
    priceCents: 49999,
    // campo opcional
    description: "Full suite of enterprise features"
  };
  const result: CreateTenantPackageResponse = await createTenantPackage(tenantId, createTenantPackageBody);
  console.log(result);
}
runExample();

deleteTenantPackage

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de deleteTenantPackage

Copy

let tenantId: string = "tenant_12345";
let packageId: string = "pkg_98765";
const result: APIEmptyResponse = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parámetros

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

Respuesta

Devuelve: GetTenantPackageResponse

Ejemplo

Ejemplo getTenantPackage

Copy

function fetchPackage(tenantId?: string, id?: string): Promise<GetTenantPackageResponse> {
    const tid: string = tenantId ?? "acme-corp-001";
    const pid: string = id ?? "premium-plan-2024";
    return getTenantPackage(tid, pid);
}
async function runExample(): Promise<void> {
    const response: GetTenantPackageResponse = await fetchPackage();
    const status: APIStatus | undefined = response.status;
    const pkg: TenantPackage | undefined = response.package;
}

getTenantPackages

Parámetros

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

Respuesta

Devuelve: GetTenantPackagesResponse

Ejemplo

Ejemplo getTenantPackages

Copy

async function fetchPackages() {
  const tenantId: string = "acme-corp-001";
  const skip: number = 15;
  const resultWithSkip: GetTenantPackagesResponse = await getTenantPackages(tenantId, skip);
  const resultWithoutSkip: GetTenantPackagesResponse = await getTenantPackages(tenantId);
}

replaceTenantPackage

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
replaceTenantPackageBody	ReplaceTenantPackageBody	Yes

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo replaceTenantPackage

Copy

async function replacePackageDemo(): Promise<void> {
  const tenantId: string = "acme-corp-001";
  const packageId: string = "basic-plan-2023";
  const replaceBody: ReplaceTenantPackageBody = {
    newPackageId: "enterprise-plan-2024"
    // los campos opcionales pueden agregarse aquí si es necesario
  };
  const response: APIEmptyResponse = await replaceTenantPackage(tenantId, packageId, replaceBody);
  console.log(response);
}

updateTenantPackage

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de updateTenantPackage

Copy

const tenantId: string = "tenant_9f8b7c6d";
const packageId: string = "pkg_3a2b1c";
const updateBody: UpdateTenantPackageBody = {
  // los campos opcionales pueden omitirse o incluirse según sea necesario
  // newPackageName?: string;
  // renewalDate?: string;
};
const result: APIEmptyResponse = await updateTenantPackage(tenantId, packageId, updateBody);

createTenantUser

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	Yes

Respuesta

Devuelve: CreateTenantUserResponse

Ejemplo

Ejemplo createTenantUser

Copy

async function addTenantUser() {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const digestFreq: DigestEmailFrequency = 'daily';
  const body: CreateTenantUserBody = {
    email: 'jane.doe@example.com',
    firstName: 'Jane',
    lastName: 'Doe',
    role: 'admin',
    digestEmailFrequency: digestFreq,
    phoneNumber: '+15551234567' // opcional
  };
  const response: CreateTenantUserResponse = await createTenantUser(tenantId, body);
  console.log(response);
}
addTenantUser();

deleteTenantUser

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deleteTenantUser

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "u-112233";
  const result1: APIEmptyResponse = await deleteTenantUser(tenantId, userId);
  const result2: APIEmptyResponse = await deleteTenantUser(tenantId, userId, "true", "hard");
  console.log(result1, result2);
})();

getTenantUser

Parámetros

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

Respuesta

Devuelve: GetTenantUserResponse

Ejemplo

getTenantUser Ejemplo

Copy

(async () => {
    const tenantId: string = "acme-tenant-001";
    const userId: string = "user-12345";
    const response: GetTenantUserResponse = await getTenantUser(tenantId, userId);
    console.log(response);
})();

getTenantUsers

Parámetros

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

Respuesta

Devuelve: GetTenantUsersResponse

Ejemplo

Ejemplo de getTenantUsers

Copy

const tenantId: string = "tenant_12345";
const skip: number = 20;
const firstPage: GetTenantUsersResponse = await getTenantUsers(tenantId);
const secondPage: GetTenantUsersResponse = await getTenantUsers(tenantId, skip);

replaceTenantUser

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo replaceTenantUser

Copy

const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
const userId: string = "user-987654321";
const replaceBody: ReplaceTenantUserBody = {
  email: "newuser@example.com",
  name: "New User",
  role: "admin"
};
const response: APIEmptyResponse = await replaceTenantUser(
  tenantId,
  userId,
  replaceBody,
  "Migrated user to new tenant"
);

sendLoginLink

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de sendLoginLink

Copy

interface APIStatus {
  // campos de estado
}
interface APIEmptyResponse {
  status: APIStatus;
}
(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "user-98765";
  const redirectURL: string = "https://app.example.com/welcome";
  const responseWithRedirect: APIEmptyResponse = await sendLoginLink(tenantId, userId, redirectURL);
  const responseWithoutRedirect: APIEmptyResponse = await sendLoginLink(tenantId, userId);
})();

updateTenantUser

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

updateTenantUser Ejemplo

Copy

async function runUpdate() {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_987";
  const updateBody: UpdateTenantUserBody = {
    email: "new.email@example.com",
    role: "admin",
    isActive: true
  };
  const comment: string = "Promoted to admin role";
  const result: APIEmptyResponse = await updateTenantUser(tenantId, userId, updateBody, comment);
  console.log(result);
}
runUpdate();

createTenant

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

Respuesta

Devuelve: CreateTenantResponse

Ejemplo

Ejemplo createTenant

Copy

async function run() {
  const tenantId: string = "acme-corp-2024";
  const createTenantBody: CreateTenantBody = {
    name: "Acme Corp",
    domainConfiguration: { domain: "comments.acme.com", sslEnabled: true },
    importedSite: { siteId: "site-123", source: "wordpress" },
    billingInfo: { plan: "enterprise", renewalDate: "2025-01-01" },
    description: "Tenant for Acme Corp's production environment", // opcional
  };
  const response: CreateTenantResponse = await createTenant(tenantId, createTenantBody);
}
run();

deleteTenant

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de deleteTenant

Copy

async function main(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_9876";
  const resultWithoutSure: APIEmptyResponse = await deleteTenant(tenantId, userId);
  const resultWithSure: APIEmptyResponse = await deleteTenant(tenantId, userId, "confirm");
}
main();

getTenant

Parámetros

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

Respuesta

Devuelve: GetTenantResponse

Ejemplo

Ejemplo getTenant

Copy

async function fetchTenant(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const id: string = "tenant_12345";
    const tenantResponse: GetTenantResponse = await getTenant(tenantId, id);
    // Campos opcionales en la respuesta
    const billing: BillingInfo | undefined = tenantResponse.billingInfo;
    const domainConfig: APIDomainConfiguration | undefined = tenantResponse.domainConfiguration;
}

getTenants

Parámetros

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

Respuesta

Devuelve: GetTenantsResponse

Ejemplo

Ejemplo getTenants

Copy

async function runExample() {
    const tenantId: string = "c3f5e9b2-4d1a-4f2b-9a6e-1234567890ab";
    const meta: string = "includeBilling";
    const skip: number = 10;
    const result: GetTenantsResponse = await getTenants(tenantId, meta, skip);
    console.log(result);
}
runExample();

updateTenant

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo de updateTenant

Copy

async function runUpdateTenant() {
  const tenantId: string = "tenant-abc123";
  const id: string = "config-456def";
  const updateTenantBody: UpdateTenantBody = {
    // campo requerido
    name: "Acme International",
    // los campos opcionales pueden omitirse, p.ej., billingInfo, domainConfiguration
  };
  const response: APIEmptyResponse = await updateTenant(tenantId, id, updateTenantBody);
  console.log(response);
}

changeTicketState

Parámetros

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

Respuesta

Devuelve: ChangeTicketStateResponse

Ejemplo

Ejemplo changeTicketState

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const ticketId: string = "ticket-20230915-001";
  const changeTicketStateBody: ChangeTicketStateBody = {
    // ejemplo de campo opcional
    note: "Resolved after investigation"
  };
  const response: ChangeTicketStateResponse = await changeTicketState(
    tenantId,
    userId,
    ticketId,
    changeTicketStateBody
  );
  console.log(response);
})();

createTicket

Parámetros

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

Respuesta

Devuelve: CreateTicketResponse

Ejemplo

Ejemplo createTicket

Copy

async function submitTicket() {
  const tenantId: string = "acme-corp";
  const userId: string = "user-9876";
  const ticketBody: CreateTicketBody = {
    subject: "Login issues after password reset",
    description: "User reports being unable to log in despite using the new password.",
    priority: "medium",
    // campo opcional en CreateTicketBody
    tags: ["login", "password-reset"]
  };
  const response: CreateTicketResponse = await createTicket(tenantId, userId, ticketBody);
  console.log(response);
}
submitTicket();

getTicket

Parámetros

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

Respuesta

Devuelve: GetTicketResponse

Ejemplo

Ejemplo getTicket

Copy

async function fetchTickets() {
  const tenantId: string = "acme-corp";
  const ticketId: string = "ticket-12345";
  const userId: string = "user-9876";
  const ticketWithUser: GetTicketResponse = await getTicket(tenantId, ticketId, userId);
  const ticketWithoutUser: GetTicketResponse = await getTicket(tenantId, ticketId);
}

getTickets

Parámetros

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

Respuesta

Devuelve: GetTicketsResponse

Ejemplo

Ejemplo getTickets

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const ticketsSimple: GetTicketsResponse = await getTickets(tenantId);
  const userId: string = "user_9876";
  const state: number = 1; // p.ej., abierto
  const skip: number = 0;
  const limit: number = 20;
  const ticketsFull: GetTicketsResponse = await getTickets(
    tenantId,
    userId,
    state,
    skip,
    limit
  );
})();

getTranslations

Parámetros

Nombre	Tipo	Requerido
namespace	string	Sí
component	string	Sí
locale	string	No
useFullTranslationIds	boolean	No

Respuesta

Devuelve: GetTranslationsResponse

Ejemplo

Ejemplo de getTranslations

Copy

async function fetchTranslations() {
  const adminDashboard: GetTranslationsResponse = await getTranslations('admin', 'dashboard');
  const userProfileFr: GetTranslationsResponse = await getTranslations('user', 'profile', 'fr-FR', true);
}

uploadImage

Subir y cambiar el tamaño de una imagen

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

Respuesta

Devuelve: UploadImageResponse

Ejemplo

Ejemplo uploadImage

Copy

const tenantId: string = "acme-tenant-01";
const imageBlob: Blob = new Blob([new Uint8Array([137,80,78,71])], { type: "image/png" });
const uploadResult1: UploadImageResponse = await uploadImage(tenantId, imageBlob);
const sizePreset: SizePreset = { presetName: "medium" };
const urlId: string = "article-9876";
const uploadResult2: UploadImageResponse = await uploadImage(tenantId, imageBlob, sizePreset, urlId);

getUserBadgeProgressById

Parámetros

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

Respuesta

Devuelve: APIGetUserBadgeProgressResponse

Ejemplo

Ejemplo getUserBadgeProgressById

Copy

const tenantId: string = "acme-corp-tenant";
const badgeId: string = "badge-2024-07";
const result: APIGetUserBadgeProgressResponse = await getUserBadgeProgressById(tenantId, badgeId);
const progress: UserBadgeProgress | undefined = result?.progress;
const status: APIStatus | undefined = result?.status;

getUserBadgeProgressByUserId

Parámetros

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

Respuesta

Devuelve: APIGetUserBadgeProgressResponse

Ejemplo

Ejemplo getUserBadgeProgressByUserId

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-42";
const badgeProgress: APIGetUserBadgeProgressResponse = await getUserBadgeProgressByUserId(tenantId, userId);
if (badgeProgress.status?.code !== undefined) {
  const statusCode: number = badgeProgress.status.code;
}
if (badgeProgress.progress?.length) {
  const firstProgress: UserBadgeProgress = badgeProgress.progress[0];
}

getUserBadgeProgressList

Parámetros

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

Respuesta

Devuelve: APIGetUserBadgeProgressListResponse

Ejemplo

Ejemplo getUserBadgeProgressList

Copy

(async () => {
  const tenantId: string = "tenant-9f8b7c6d";
  const userId: string = "user-123e4567-e89b-12d3-a456-426614174000";
  const limit: number = 10;
  const skip: number = 0;
  const response: APIGetUserBadgeProgressListResponse = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  const status: APIStatus = response.status;
  const badges: UserBadgeProgress[] = response.badges;
})();

createUserBadge

Parámetros

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

Respuesta

Devuelve: APICreateUserBadgeResponse

Ejemplo

Ejemplo createUserBadge

Copy

async function main(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c";
  const badgeParams: CreateUserBadgeParams = {
    name: "Community Helper",
    iconUrl: "https://cdn.example.com/badges/helper.png"
  };
  const response: APICreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);
}
main();

deleteUserBadge

Parámetros

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

Respuesta

Devuelve: APIEmptySuccessResponse

Ejemplo

Ejemplo deleteUserBadge

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const badgeId: string = "moderator-badge";
  const result: APIEmptySuccessResponse = await deleteUserBadge(tenantId, badgeId);
  console.log(result);
})();

getUserBadge

Parámetros

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

Respuesta

Devuelve: APIGetUserBadgeResponse

Ejemplo

Ejemplo getUserBadge

Copy

async function demoGetUserBadge() {
    const tenantId: string = "tenant-9f8b7c6d";
    const userId: string = "user-123456";
    const badgeResponse: APIGetUserBadgeResponse = await getUserBadge(tenantId, userId);
}

getUserBadges

Parámetros

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

Respuesta

Devuelve: APIGetUserBadgesResponse

Ejemplo

Ejemplo getUserBadges

Copy

(async () => {
  const tenantId: string = "acme-corp";
  // Todos los parámetros suministrados
  const fullResponse: APIGetUserBadgesResponse = await getUserBadges(
    tenantId,
    "user-42",
    "badge-premium",
    1,
    true,
    10,
    0
  );
  // Sólo los requeridos y un parámetro opcional (limit)
  const limitedResponse: APIGetUserBadgesResponse = await getUserBadges(
    tenantId,
    undefined,
    undefined,
    undefined,
    undefined,
    5
  );
  console.log(fullResponse, limitedResponse);
})();

updateUserBadge

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

Respuesta

Devuelve: APIEmptySuccessResponse

Ejemplo

Ejemplo de updateUserBadge

Copy

const tenantId: string = "tenant-9f8b7c6d";
const id: string = "user-4a3b2c1d";
const updateParams: UpdateUserBadgeParams = {
  badgeId: "badge-premium",
  // campo opcional
  expiresAt: new Date("2025-12-31T23:59:59Z")
};
const result: APIEmptySuccessResponse = await updateUserBadge(tenantId, id, updateParams);

getUserNotificationCount

Parámetros

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

Respuesta

Devuelve: GetUserNotificationCountResponse

Ejemplo

Ejemplo de getUserNotificationCount

Copy

async function demo(): Promise<void> {
  const tenantId: string = "acme-corp-001";
  const ssoToken: string = "sso-token-xyz789";
  const countWithoutSso: GetUserNotificationCountResponse = await getUserNotificationCount(tenantId);
  const countWithSso: GetUserNotificationCountResponse = await getUserNotificationCount(tenantId, ssoToken);
}
demo();

getUserNotifications

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
urlId	string	No
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
includeTenantNotifications	boolean	No
sso	string	No

Respuesta

Devuelve: GetMyNotificationsResponse

Ejemplo

Ejemplo getUserNotifications

Copy

async function fetchNotifications(): Promise<void> {
  const tenantId: string = "acme-corp";
  const urlId: string = "article-42";
  const pageSize: number = 20;
  const includeContext: boolean = true;
  const unreadOnly: boolean = true;
  const notifications: GetMyNotificationsResponse = await getUserNotifications(
    tenantId,
    urlId,
    pageSize,
    undefined,
    includeContext,
    undefined,
    unreadOnly
  );
  console.log(notifications);
}

resetUserNotificationCount

Parámetros

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

Respuesta

Devuelve: ResetUserNotificationsResponse

Ejemplo

Ejemplo de resetUserNotificationCount

Copy

async function demoReset() {
  const tenantId: string = "tenant_12345";
  const ssoToken: string = "sso_abcdef123456";
  const resultWithSso: ResetUserNotificationsResponse = await resetUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSso: ResetUserNotificationsResponse = await resetUserNotificationCount(tenantId);
}
demoReset();

resetUserNotifications

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Respuesta

Devuelve: ResetUserNotificationsResponse

Ejemplo

Ejemplo resetUserNotifications

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const afterId: string = "notif-2023-09-01";
  const afterCreatedAt: number = 1693526400; // Marca de tiempo Unix
  const unreadOnly: boolean = true;
  const dmOnly: boolean = false;
  const response: ResetUserNotificationsResponse = await resetUserNotifications(
    tenantId,
    afterId,
    afterCreatedAt,
    unreadOnly,
    dmOnly
  );
  console.log(response);
})();

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

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

Response

Devuelve: UpdateUserNotificationCommentSubscriptionStatusResponse

Example

Ejemplo de updateUserNotificationCommentSubscriptionStatus

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const notificationId: string = "notif_9876";
  const commentId: string = "comment_abc123";
  const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum =
    UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
  const sso: string = "sso_token_456";
  const resultWithSso: UpdateUserNotificationCommentSubscriptionStatusResponse = await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId,
    sso
  );
  const resultWithoutSso: UpdateUserNotificationCommentSubscriptionStatusResponse = await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId
  );
}

updateUserNotificationPageSubscriptionStatus

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

Parameters

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

Response

Devuelve: UpdateUserNotificationPageSubscriptionStatusResponse

Example

Ejemplo de updateUserNotificationPageSubscriptionStatus

Copy

async function runExample() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_9876";
  const url: string = "https://example.com/articles/awesome-article";
  const pageTitle: string = "Awesome Article";
  const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
    UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
  const sso: string = "sso_token_abc";
  const response: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed,
    sso
  );
  console.log(response);
}
runExample();

updateUserNotificationStatus

Parámetros

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

Respuesta

Devuelve: UpdateUserNotificationStatusResponse

Ejemplo

Ejemplo de updateUserNotificationStatus

Copy

const tenantId: string = "tenant_12345";
const notificationId: string = "notif_9876";
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.READ;
const ssoToken: string = "sso_token_abc";
const responseWithSso: UpdateUserNotificationStatusResponse = await updateUserNotificationStatus(
  tenantId,
  notificationId,
  newStatus,
  ssoToken
);
const responseWithoutSso: UpdateUserNotificationStatusResponse = await updateUserNotificationStatus(
  tenantId,
  notificationId,
  newStatus
);

getUserPresenceStatuses

Parámetros

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

Respuesta

Devuelve: GetUserPresenceStatusesResponse

Ejemplo

Ejemplo getUserPresenceStatuses

Copy

(async () => {
  const tenantId: string = "my-tenant-42";
  const urlIdWS: string = "post-9876";
  const userIds: string = "alice,bob,carol";
  const presence: GetUserPresenceStatusesResponse = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);
  console.log(presence);
})();

searchUsers

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
urlId	string	Sí
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

Respuesta

Devuelve: SearchUsersResult

Ejemplo

Ejemplo de searchUsers

Copy

async function example() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "article-9876";
  const usernameStartsWith: string = "john";
  const mentionGroupIds: string[] = ["group1", "group2"];
  const sso: string = "sso_token_abc";
  const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.MENTIONS;
  const result: SearchUsersResult = await searchUsers(
    tenantId,
    urlId,
    usernameStartsWith,
    mentionGroupIds,
    sso,
    searchSection
  );
  console.log(result);
}

getUser

Parámetros

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

Respuesta

Devuelve: GetUserResponse

Ejemplo

Ejemplo getUser

Copy

async function main(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const id: string = "user_98765";
  const response: GetUserResponse = await getUser(tenantId, id);
  const { user }: { user?: User } = response;
}
main();

createVote

Parámetros

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

Respuesta

Devuelve: VoteResponse

Ejemplo

Ejemplo createVote

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "comment_67890";
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.UP;
const userId: string = "user_abcde";
const voteResult: VoteResponse = await createVote(tenantId, commentId, direction, userId);
const anonUserId: string = "anon_zyxwv";
const anonVoteResult: VoteResponse = await createVote(tenantId, commentId, direction, undefined, anonUserId);

deleteVote

Parámetros

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

Respuesta

Devuelve: VoteDeleteResponse

Ejemplo

Ejemplo deleteVote

Copy

async function run() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "comment_98765";
  const editKey: string = "edit_abcde";
  const responseWithKey: VoteDeleteResponse = await deleteVote(tenantId, commentId, editKey);
  const responseWithoutKey: VoteDeleteResponse = await deleteVote(tenantId, commentId);
}
run();

getVotes

Parámetros

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

Respuesta

Devuelve: GetVotesResponse

Ejemplo

Ejemplo getVotes

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "article-67890";
(async () => {
  const votesResponse: GetVotesResponse = await getVotes(tenantId, urlId);
  // Ejemplo de acceso a una propiedad opcional de la respuesta
  const firstVote: PublicVote | undefined = votesResponse.votes?.[0];
})();

getVotesForUser

Parámetros

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

Respuesta

Devuelve: GetVotesForUserResponse

Ejemplo

Ejemplo getVotesForUser

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "post_9876";
  const userId: string = "user_abcde";
  const anonUserId: string = "anon_5678";
  const responseWithUser: GetVotesForUserResponse = await getVotesForUser(tenantId, urlId, userId);
  const responseWithAnon: GetVotesForUserResponse = await getVotesForUser(tenantId, urlId, undefined, anonUserId);
}
demo();

createWebhook

Suscribe una URL a un evento de comentario (suscripción de webhook REST). Suscribir la misma URL al mismo evento y dominio nuevamente devuelve la suscripción existente. Las entregas están firmadas con HMAC, consulte la guía de webhooks; el encabezado token heredado nunca se envía a suscripciones de API.

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí
createWebhookParams	CreateWebhookParams	Sí

Respuesta

Devuelve: CreateWebhookResponse

Ejemplo

Ejemplo createWebhook

Copy

const tenantId: string = "tenant_9f8b7c6d";
const webhookParams: CreateWebhookParams = {
  event: "comment.created" as WebhookEventName,
  method: "POST" as WebhookHTTPMethod,
  url: "https://myapp.example.com/webhook",
  source: "comment" as WebhookSource,
  // secreto opcional para la verificación de la carga útil
  secret: "s3cr3tK3y123",
};
const result: CreateWebhookResponse = await createWebhook(tenantId, webhookParams);
const webhookId: string = result.webhook.id;

deleteWebhook

Desuscripciones (REST hook unsubscribe). Sólo las suscripciones creadas a través de esta API pueden eliminarse aquí; los webhooks gestionados desde el panel se editan en el panel.

Parámetros

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

Respuesta

Devuelve: APIEmptyResponse

Ejemplo

Ejemplo deleteWebhook

Copy

const tenantId: string = "tenant_12345";
const webhookId: string = "wh_98765";
const result: APIEmptyResponse = await deleteWebhook(tenantId, webhookId);

getWebhooks

Enumera los webhooks configurados para el inquilino, tanto las filas gestionadas desde el panel como las suscripciones API.

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Sí
event	WebhookEventName	No
domain	string	No
source	WebhookSource	No
skip	number	No

Respuesta

Devuelve: GetWebhooksResponse

Ejemplo

Ejemplo getWebhooks

Copy

(async () => {
  const tenantId: string = 'tenant_42';
  const event: WebhookEventName = 'comment.created';
  const domain: string = 'forum.example.org';
  const source: WebhookSource = 'admin';
  const skip: number = 0;
  const fullResponse: GetWebhooksResponse = await getWebhooks(tenantId, event, domain, source, skip);
  const minimalResponse: GetWebhooksResponse = await getWebhooks(tenantId);
})();

getWebhookSamplePayloads

Comentarios recientes en exactamente la forma que usan las entregas de webhook, para crear integraciones (por ejemplo datos de muestra de Zapier). Cada evento entrega el mismo objeto de comentario, por lo que event solo tiene que ser válido.

Parameters

Name	Type	Required
tenantId	string	Sí
event	WebhookEventName	No
limit	number	No

Response

Devuelve: GetWebhookSamplePayloadsResponse

Example

Ejemplo getWebhookSamplePayloads

Copy

const tenantId: string = "c1a2b3d4-5678-90ab-cdef-1234567890ab";
const responseAll: GetWebhookSamplePayloadsResponse = await getWebhookSamplePayloads(
  tenantId,
  "comment.created",
  10
);
const responseWithEvent: GetWebhookSamplePayloadsResponse = await getWebhookSamplePayloads(
  tenantId,
  "comment.created"
);
const responseBasic: GetWebhookSamplePayloadsResponse = await getWebhookSamplePayloads(
  tenantId
);

¿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

Documentación

Comenzando

Referencia de API

Uso

Inquilinos de agente

Agregado

Registros de auditoría

Bloquear desde comentario

Verificar comentarios bloqueados

Comentarios

Comentarios para usuario

Configuraciones de dominio

Plantillas de correo electrónico

Registro de eventos

Publicaciones del feed

Traducciones

Denunciar comentario

GIFs

Etiquetas

Yo

Moderación

Moderadores

Conteo de notificaciones

Notificaciones

Reacciones de página

Páginas

Eventos de webhook pendientes

Votos de encuesta

Encuestas

Configuraciones de preguntas

Resultados de preguntas

Agregación de resultados de preguntas

Usuarios SSO

Suscripciones

Uso diario del inquilino

Paquetes de inquilino

Usuarios del inquilino

Inquilinos

Tickets

Translations

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones de usuario

Estado de presencia del usuario

Búsqueda de usuarios

Usuarios

Votos

Webhooks

SDK de JavaScript/TypeScript de FastComments

Repositorio

Agentes de codificación IA

Instalación

Documentación de 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 (seguro para navegador)

Ejemplo: Uso de la API predeterminada (solo del lado del servidor)

Ejemplo: Uso de la API de moderación

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