SDK de FastComments para JavaScript/TypeScript

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

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

Repositorio

Instalación

npm install fastcomments-sdk

Documentación de la API

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

Compatibilidad navegador vs servidor

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

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

Uso

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

Browser Usage (Client-Side)

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

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

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

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

Server Usage (Node.js)

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

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

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

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

Types Only Import

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

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

Using Individual API Classes

Browser Environment

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

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

const publicApi = new PublicApi(config);

Server Environment

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

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

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

APIs públicas vs seguras

El SDK proporciona 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);
  }
}

Agregación

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

Obtener registros de auditoría

Parámetros

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

Respuesta

Devuelve: GetAuditLogsResponse1

Ejemplo

Ejemplo getAuditLogs

Copy

(async () => {
  const tenantId: string = "tenant_42";
  const limit: number = 100;
  const skip: number = 10;
  const order: SORTDIR = "desc";
  const after: number = Date.now() - 3 * 24 * 60 * 60 * 1000; // hace 3 días
  const auditResponse: GetAuditLogsResponse1 = await getAuditLogs(
    tenantId,
    limit,
    skip,
    order,
    after
  );
  console.log(auditResponse);
})();

Bloquear desde comentario (público)

Parámetros

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

Respuesta

Devuelve: BlockFromCommentPublicResponse

Ejemplo

Ejemplo blockFromCommentPublic

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const commentId: string = "cmt_1234567890";
  const blockParams: PublicBlockFromCommentParams = {
    reason: "spam",
    durationHours: 24,
  };
  const ssoToken: string = "sso_ABCDEF123456";
  const responseWithSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams,
    ssoToken
  );
  const responseWithoutSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams
  );
  console.log(responseWithSso, responseWithoutSso);
}
demo();

Desbloquear comentario (público)

Parámetros

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

Respuesta

Devuelve: UnBlockCommentPublicResponse

Ejemplo

Ejemplo de unBlockCommentPublic

Copy

const tenantId: string = "acme-corp-tenant";
const commentId: string = "cmt-20230915-001";
const unblockParams: PublicBlockFromCommentParams = {
  reason: "User appealed and was cleared",
  unblockExpiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString()
};
const ssoToken: string = "sso-3d9f8a7b";
const result: UnBlockCommentPublicResponse = await unBlockCommentPublic(
  tenantId,
  commentId,
  unblockParams,
  ssoToken
);

Comprobar comentarios bloqueados

Parámetros

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

Respuesta

Devuelve: CheckedCommentsForBlockedResponse

Ejemplo

Ejemplo de checkedCommentsForBlocked

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const commentIds: string = "cmt_001,cmt_002";
  const ssoToken: string = "ssoTokenXYZ";
  const blockedCheck: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds);
  const blockedCheckWithSso: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
})();

Bloquear usuario desde comentario

Parámetros

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

Respuesta

Devuelve: BlockUserFromCommentResponse

Ejemplo

Ejemplo de blockUserFromComment

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // parámetro opcional
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

Crear comentario público

Parámetros

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

Respuesta

Devuelve: CreateCommentPublicResponse

Ejemplo

createCommentPublic Ejemplo

Copy

(async () => {
  const tenantId: string = "tenant-abc123";
  const urlId: string = "post-987654";
  const broadcastId: string = "bcast-001";
  const commentData: CommentData = {
    content: "I really enjoyed this article!"
  };
  const sessionId: string = "session-xyz789";
  const sso: string = "sso-token-456def";
  const response: CreateCommentPublicResponse = await createCommentPublic(
    tenantId,
    urlId,
    broadcastId,
    commentData,
    sessionId,
    sso
  );
  console.log(response);
})();

Eliminar comentario

Parámetros

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

Respuesta

Devuelve: DeleteCommentResponse

Ejemplo

Ejemplo deleteComment

Copy

(async () => {
  const tenantId: string = 'tenant_01';
  const commentId: string = 'comment_abc123';
  const contextUserId: string = 'user_42';
  const isLive: boolean = false;
  const deleteResult: DeleteCommentResponse = await deleteComment(tenantId, commentId, contextUserId, isLive);
  const simpleResult: DeleteCommentResponse = await deleteComment(tenantId, commentId);
})();

Eliminar comentario público

Parámetros

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

Respuesta

Devuelve: DeleteCommentPublicResponse

Ejemplo

deleteCommentPublic Ejemplo

Copy

(async () => {
  const tenantId: string = 'c6f9a2e3-9b1d-4f8a-b2d2-1a2b3c4d5e6f';
  const commentId: string = '7d9f0b1c-2e3f-4a5b-6c7d-8e9f0a1b2c3d';
  const broadcastId: string = 'live-2023-09-15';
  const editKey: string = 'ed1tK3y1234567890';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123';
  const result: DeleteCommentPublicResponse = await deleteCommentPublic(
    tenantId,
    commentId,
    broadcastId,
    editKey,
    sso
  );
})();

Eliminar voto de comentario

Parámetros

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

Respuesta

Devuelve: DeleteCommentVoteResponse

Ejemplo

Ejemplo de deleteCommentVote

Copy

async function removeVote() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const voteId: string = "vote_abcde";
  const urlId: string = "url_56789";
  const broadcastId: string = "brd_001";
  const editKey: string = "edit_456";
  // sso es opcional y se omite
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

Marcar comentario

Parameters

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

Response

Devuelve: FlagCommentResponse1

Example

Ejemplo flagComment

Copy

(async () => {
  const tenantId: string = "tenant_2023";
  const commentId: string = "comment_5678";
  const userId: string = "user_1234";
  const anonUserId: string = "anon_4321";
  const result: FlagCommentResponse1 = await flagComment(tenantId, commentId, userId);
  const anonResult: FlagCommentResponse1 = await flagComment(tenantId, commentId, undefined, anonUserId);
})();

Obtener comentario

Parámetros

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

Respuesta

Devuelve: GetCommentResponse

Ejemplo

Ejemplo getComment

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-987654";
  const result: GetCommentResponse = await getComment(tenantId, commentId);
  const badgeInfo: CommentUserBadgeInfo | undefined = result.comment?.user?.badgeInfo;
  console.log(badgeInfo?.label);
})();

Obtener comentarios

Parámetros

Nombre	Tipo	Obligatorio
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: GetCommentsResponse

Ejemplo

Ejemplo getComments

Copy

const tenantId: string = "tenant_12345";
const page: number = 2;
const limit: number = 50;
const asTree: boolean = true;
const urlId: string = "article_5678";
const direction: SortDirections = "desc";
const fromDate: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // one week ago
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

Obtener comentarios públicos

req tenantId urlId

Parámetros

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

Respuesta

Devuelve: GetCommentsPublicResponse

Ejemplo

Ejemplo getCommentsPublic

Copy

async function fetchComments() {
  const tenantId: string = 'acme-corp';
  const urlId: string = 'blog/post-789';
  const page: number = 1;
  const direction: SortDirections = SortDirections.Desc;
  const limit: number = 25;
  const includeConfig: boolean = true;
  const locale: string = 'en-GB';
  const modules: string = 'reactions,attachments';
  const isCrawler: boolean = false;
  const includeNotificationCount: boolean = true;
  const asTree: boolean = true;
  const maxTreeDepth: number = 4;
  const searchText: string = 'TypeScript';
  const hashTags: string[] = ['typescript', 'api'];
  const response: GetCommentsPublicResponse = await getCommentsPublic(
    tenantId,
    urlId,
    page,
    direction,
    undefined,
    undefined,
    undefined,
    limit,
    undefined,
    undefined,
    undefined,
    includeConfig,
    undefined,
    undefined,
    locale,
    modules,
    isCrawler,
    includeNotificationCount,
    asTree,
    maxTreeDepth,
    undefined,
    undefined,
    searchText,
    hashTags,
    undefined,
    undefined,
    undefined,
    undefined
  );
}

Obtener texto del comentario

Parámetros

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

Respuesta

Devuelve: GetCommentTextResponse1

Ejemplo

Ejemplo getCommentText

Copy

async function run() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt-5f2e9a1b";
  const editKey: string = "edk-9b7c3";
  const ssoToken: string = "sso-xyz789";
  const commentOnly: GetCommentTextResponse1 = await getCommentText(tenantId, commentId);
  const commentWithEdit: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey);
  const commentFull: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey, ssoToken);
}
run();

Obtener nombres de usuarios que votaron el comentario

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

Respuesta

Devuelve: GetCommentVoteUserNamesResponse

Ejemplo

Ejemplo getCommentVoteUserNames

Copy

async function demoGetCommentVoteUserNames() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_5f2a1e3b";
  const dir: number = 1; // ascendente
  const votesWithoutSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir
  );
  const ssoToken: string = "sso_abcdef123456";
  const votesWithSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir,
    ssoToken
  );
  console.log(votesWithoutSSO, votesWithSSO);
}

Bloquear comentario

Parámetros

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

Respuesta

Devuelve: LockCommentResponse

Ejemplo

Ejemplo lockComment

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // Con token SSO opcional
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // Sin token SSO
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

Fijar comentario

Parámetros

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

Respuesta

Devuelve: PinCommentResponse

Ejemplo

pinComment Ejemplo

Copy

(async () => {
  const tenantId: string = 'tenant-001';
  const commentId: string = 'comment-5678';
  const broadcastId: string = 'broadcast-2023';
  const ssoToken: string = 'sso-xyz-789';
  const pinResult: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId);
  const pinResultWithSso: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);
})();

Guardar comentario

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

Ejemplo

Ejemplo de saveComment

Copy

async function submitComment() {
  const tenantId: string = "tenant_9f8e7d6c";
  const commentParams: CreateCommentParams = {
    text: "Great post, thanks for sharing!",
    authorId: "user_123abc",
    mentions: [] as CommentUserMentionInfo[],
    hashtags: [] as CommentUserHashTagInfo[]
  };
  const response: SaveCommentResponse = await saveComment(
    tenantId,
    commentParams,
    true,   // en vivo
    false   // comprobar spam
  );
  console.log(response);
}
submitComment();

Guardar comentarios en bloque

Parámetros

Nombre	Tipo	Requerido
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_9f8b7c6d";
const bulkComments: CreateCommentParams[] = [
  {
    content: "Welcome to the new forum thread!",
    authorId: "user_42",
    mentions: [{ userId: "user_84", username: "alice" }],
    hashtags: [{ tag: "intro" }]
  },
  {
    content: "Please review the updated guidelines.",
    authorId: "moderator_1",
    mentions: [],
    hashtags: [{ tag: "guidelines" }, { tag: "update" }]
  }
];
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  bulkComments,
  true,      // isLive
  false,     // doSpamCheck
  true,      // sendEmails
  undefined  // populateNotifications (using default)
);

Establecer texto del comentario

Parámetros

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

Respuesta

Devuelve: SetCommentTextResponse1

Ejemplo

Ejemplo setCommentText

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const commentId: string = 'cmt_98765';
  const broadcastId: string = 'brd_112233';
  const commentTextUpdateRequest: CommentTextUpdateRequest = {
    text: 'Updated comment with @john.doe and #important',
    mentions: [{ userId: 'user_001', username: 'john.doe' }],
    hashtags: [{ tag: 'important' }],
  };
  const editKey: string = 'edit_abc123';
  const result: SetCommentTextResponse1 = await setCommentText(
    tenantId,
    commentId,
    broadcastId,
    commentTextUpdateRequest,
    editKey,
  );
  console.log(result);
})();

Desbloquear usuario desde comentario

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

Respuesta

Devuelve: UnBlockUserFromCommentResponse

Ejemplo

Ejemplo de unBlockUserFromComment

Copy

async function demoUnblock() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt_9f8b7a6d";
  const params: UnBlockFromCommentParams = {
    reason: "User resolved the issue",
    notifyUser: true
  };
  const userId: string = "usr_12345";
  const result: UnBlockUserFromCommentResponse = await unBlockUserFromComment(
    tenantId,
    commentId,
    params,
    userId
    // anonUserId omitted
  );
  console.log(result);
}
demoUnblock();

Quitar marca de comentario

Parámetros

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

Respuesta

Devuelve: UnFlagCommentResponse

Ejemplo

Ejemplo de unFlagComment

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_123456";
const userId: string = "usr_98765";
const result: UnFlagCommentResponse = await unFlagComment(tenantId, commentId, userId);
const anonCommentId: string = "cmt_123457";
const anonUserId: string = "anon_abc123";
const anonResult: UnFlagCommentResponse = await unFlagComment(tenantId, anonCommentId, undefined, anonUserId);

Desbloquear comentario

Parámetros

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

Respuesta

Devuelve: UnLockCommentResponse

Ejemplo

unLockComment Ejemplo

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const broadcastId: string = "brd_001";
const ssoToken: string | undefined = "sso_token_abc";
async function run() {
  const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
  console.log(unlocked);
  // Llamada sin el parámetro sso opcional
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

Desanclar comentario

Parámetros

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

Respuesta

Devuelve: UnPinCommentResponse

Ejemplo

Ejemplo de unPinComment

Copy

(async () => {
  const tenantId: string = "tenant-001"
  const commentId: string = "comment-123"
  const broadcastId: string = "broadcast-456"
  const sso: string = "sso-token-xyz"
  const resultWithSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId, sso)
  const resultWithoutSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId)
  console.log(resultWithSso, resultWithoutSso)
})()

Actualizar comentario

Parámetros

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

Respuesta

Devuelve: UpdateCommentResponse

Ejemplo

Ejemplo de updateComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // campos de ejemplo; la forma real depende de la definición de la API
  // por ejemplo, body: "Edited comment content",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

Votar comentario

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

Ejemplo

Ejemplo voteComment

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_9f8e7d6c";
const urlId: string = "url_123456";
const broadcastId: string = "bcast_2024_01";
const voteBodyParams: VoteBodyParams = {
  vote: "up",               // p.ej., "up" | "down"
  weight: 1,                // ponderación opcional del voto
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

Obtener comentarios de usuario

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

Ejemplo

Ejemplo de getCommentsForUser

Copy

async function demo() {
    const userId: string = "user-12345";
    const direction: SortDirections = "desc";
    const page: number = 1;
    const includei10n: boolean = true;
    const locale: string = "en-US";
    const isCrawler: boolean = false;
    const response: GetCommentsForUserResponse1 = await getCommentsForUser(
        userId,
        direction,
        undefined,
        page,
        includei10n,
        locale,
        isCrawler
    );
    console.log(response);
}

Agregar configuración de dominio

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

Eliminar configuración de dominio

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

Obtener configuración de dominio

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

Obtener configuraciones de dominio

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

Actualizar parcialmente configuración de dominio

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

Reemplazar configuración de dominio

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

Crear plantilla de correo

Parámetros

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

Respuesta

Devuelve: CreateEmailTemplateResponse1

Ejemplo

Ejemplo de createEmailTemplate

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // optional fields like textContent, isActive are omitted to demonstrate optional parameters
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

Eliminar plantilla de correo

Parámetros

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

Respuesta

Devuelve: DeleteEmailTemplateResponse

Ejemplo

Ejemplo deleteEmailTemplate

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // Ejemplo de acceso a una propiedad opcional de la respuesta
  const statusCode: number | undefined = response.status?.code;
}();

Eliminar error de renderizado de plantilla de correo

Parámetros

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

Respuesta

Devuelve: DeleteEmailTemplateRenderErrorResponse

Ejemplo

Ejemplo deleteEmailTemplateRenderError

Copy

async function executeDelete() {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_001";
  const errorId: string = "render_err_2023";
  const result: DeleteEmailTemplateRenderErrorResponse = await deleteEmailTemplateRenderError(
    tenantId,
    templateId,
    errorId
  );
  console.log(result);
}
executeDelete();

Obtener plantilla de correo

Parámetros

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

Respuesta

Devuelve: GetEmailTemplateResponse1

Ejemplo

getEmailTemplate Ejemplo

Copy

async function fetchTemplate(): Promise<void> {
    const tenantId: string = "tenant-12345";
    const templateId: string = "order-confirmation";
    const response: GetEmailTemplateResponse1 = await getEmailTemplate(tenantId, templateId);
    const emailTemplate: CustomEmailTemplate | undefined = response.customEmailTemplate;
    const configParams: CustomConfigParameters | undefined = response.customConfigParameters;
}

Obtener definiciones de plantillas de correo

Parámetros

Nombre	Tipo	Obligatorio	Descripción
tenantId	string	Sí

Respuesta

Devuelve: GetEmailTemplateDefinitionsResponse1

Ejemplo

getEmailTemplateDefinitions Ejemplo

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const emailTemplateDefs: GetEmailTemplateDefinitionsResponse1 = await getEmailTemplateDefinitions(tenantId);
  console.log(emailTemplateDefs);
})();

Obtener errores de renderizado de plantillas de correo

Parámetros

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

Respuesta

Devuelve: GetEmailTemplateRenderErrorsResponse1

Ejemplo

Ejemplo getEmailTemplateRenderErrors

Copy

const tenantId: string = "c2f5a8d9-4b3e-4f6a-9e1b-2d5c6f7a8b9c";
const templateId: string = "welcome-email-template";
const skip: number = 20;
const result: GetEmailTemplateRenderErrorsResponse1 = await getEmailTemplateRenderErrors(
  tenantId,
  templateId,
  skip
);

Obtener plantillas de correo

Parámetros

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

Respuesta

Devuelve: GetEmailTemplatesResponse1

Ejemplo

Ejemplo getEmailTemplates

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Llamada sin el opcional 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Llamada con el parámetro opcional 'skip'
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

Renderizar plantilla de correo

Parámetros

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

Respuesta

Devuelve: RenderEmailTemplateResponse1

Ejemplo

renderEmailTemplate Ejemplo

Copy

(async () => {
  const tenantId: string = "acme-corp-01";
  const templateBody: RenderEmailTemplateBody = {
    templateId: "welcome-email",
    placeholders: {
      userName: "John Doe",
      signupDate: "2024-04-01"
    }
  };
  const locale: string = "en-US";
  const result: RenderEmailTemplateResponse1 = await renderEmailTemplate(tenantId, templateBody, locale);
  console.log(result);
})();

Actualizar plantilla de correo

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
updateEmailTemplateBody	UpdateEmailTemplateBody	Yes

Respuesta

Devuelve: UpdateEmailTemplateResponse

Ejemplo

Ejemplo de updateEmailTemplate

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "Comment reply notification",
    htmlContent: "<p>Someone replied to your comment.</p>",
    plainTextContent: "Someone replied to your comment.",
    // ejemplo de campo opcional
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

Obtener registro de eventos

req 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: GetEventLogResponse1

Ejemplo

Ejemplo de getEventLog

Copy

(async () => {
    const tenantId: string = "tenant_9876";
    const urlId: string = "page_54321";
    const userIdWS: string = "ws_user_1122";
    const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // hace una semana
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

Obtener registro global de eventos

req tenantId urlId userIdWS

Parámetros

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

Respuesta

Devuelve: GetGlobalEventLogResponse

Ejemplo

Ejemplo getGlobalEventLog

Copy

(async () => {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const urlId: string = 'article-2023-09-15';
  const userIdWS: string = 'ws_987654321';
  const startTime: number = Date.now() - 86400000;
  const endTime: number = Date.now();
  const fullLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
  const recentLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);
  console.log(fullLog, recentLog);
})();

Crear publicación de feed

Parámetros

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

Respuesta

Devuelve: CreateFeedPostResponse1

Ejemplo

Ejemplo de createFeedPost

Copy

async function run() {
  const tenantId = "tenant-12345";
  const feedParams: CreateFeedPostParams = {
    text: "New product launch!",
    mediaItems: [{ type: "image", asset: { url: "https://cdn.example.com/img.jpg", width: 800, height: 600 } as FeedPostMediaItemAsset } as FeedPostMediaItem],
    link: { url: "https://example.com/product", title: "Product" } as FeedPostLink
  };
  const result: CreateFeedPostResponse1 = await createFeedPost(tenantId, feedParams, "broadcast-987", true, false, true);
  console.log(result);
}
run();

Crear publicación de feed pública

Parámetros

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

Respuesta

Devuelve: CreateFeedPostPublicResponse

Ejemplo

Ejemplo createFeedPostPublic

Copy

async function submitPost() {
  const tenantId: string = "tenant_12345";
  const mediaItem: FeedPostMediaItem = {
    asset: {
      url: "https://cdn.example.com/image.jpg",
      mimeType: "image/jpeg",
      size: 104857,
    },
    type: "image",
  };
  const link: FeedPostLink = {
    url: "https://example.com/blog/new-feature",
    title: "New Feature Release",
    description: "Details about our latest product update.",
  };
  const createFeedPostParams: CreateFeedPostParams = {
    content: "Check out our new feature!",
    media: [mediaItem],
    link: link,
  };
  const broadcastId: string = "broadcast_9876";
  const sso: string = "sso_token_abc123";
  const response: CreateFeedPostPublicResponse = await createFeedPostPublic(
    tenantId,
    createFeedPostParams,
    broadcastId,
    sso
  );
}

Eliminar publicación de feed pública

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: DeleteFeedPostPublicResponse

Ejemplo

deleteFeedPostPublic Ejemplo

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const postId: string = "post_987654321";
  const broadcastId: string = "broadcast_2024Q1";
  const sso: string = "sso_4fa3b9c2";
  const response1: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId);
  const response2: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId);
  const response3: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
})();

Obtener publicaciones de feed

solicitud
tenantId
afterId

Parámetros

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

Respuesta

Devuelve: GetFeedPostsResponse1

Ejemplo

Ejemplo getFeedPosts

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const afterId: string = 'post_9876';
  const limit: number = 20;
  const tags: string[] = ['news', 'sports'];
  const feedResult: GetFeedPostsResponse1 = await getFeedPosts(tenantId, afterId, limit, tags);
})();

Obtener publicaciones de feed públicas

req tenantId afterId

Parámetros

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

Respuesta

Devuelve: GetFeedPostsPublicResponse

Ejemplo

Ejemplo de getFeedPostsPublic

Copy

async function example() {
  const tenantId: string = "tenant_12345";
  const afterId: string = "post_9876";
  const limit: number = 20;
  const tags: string[] = ["news", "tech"];
  const sso: string = "userToken123";
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublicResponse = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
}
example();

Obtener estadísticas de publicaciones de feed

Parámetros

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

Respuesta

Devuelve: GetFeedPostsStatsResponse

Ejemplo

Ejemplo getFeedPostsStats

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
    const ssoToken: string = "sso_abcdef123456";
    const statsWithoutSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds);
    const statsWithSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds, ssoToken);
}
runExample();

Obtener reacciones de usuario públicas

Parámetros

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

Respuesta

Devuelve: GetUserReactsPublicResponse

Ejemplo

Ejemplo getUserReactsPublic

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const postIds: string[] = ["post_1a2b3c", "post_4d5e6f"];
  const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
  const fullResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId, postIds, ssoToken);
  const minimalResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId);
}
demo();

Reaccionar a publicación de feed pública

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

Ejemplo

Ejemplo reactFeedPostPublic

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const postId: string = 'post_98765';
  const reactBodyParams: ReactBodyParams = { reaction: 'thumbs_up' };
  const isUndo: boolean = false;
  const broadcastId: string = 'broadcast_abcde';
  const sso: string = 'sso_token_xyz';
  const response: ReactFeedPostPublicResponse = await reactFeedPostPublic(
    tenantId,
    postId,
    reactBodyParams,
    isUndo,
    broadcastId,
    sso
  );
  console.log(response);
})();

Actualizar publicación de feed

Parámetros

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

Respuesta

Devuelve: UpdateFeedPostResponse

Ejemplo

Ejemplo updateFeedPost

Copy

const tenantId: string = "tenant_3421";
const postId: string = "feedpost_a9b8c7";
const feedPost: FeedPost = {
  content: "We've refreshed the announcement with the latest project milestones.",
  media: [
    {
      type: "image",
      url: "https://assets.example.com/images/milestone.png",
      caption: "Project Milestones"
    } as FeedPostMediaItem
  ],
  link: {
    url: "https://example.com/project-updates",
    title: "Project Updates",
    description: "Read about the recent progress and upcoming goals."
  } as FeedPostLink
};
const result: UpdateFeedPostResponse = await updateFeedPost(tenantId, postId, feedPost);

Actualizar publicación de feed pública

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
postId	string	Yes
updateFeedPostParams	UpdateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Respuesta

Devuelve: UpdateFeedPostPublicResponse

Ejemplo

Ejemplo de updateFeedPostPublic

Copy

async function updatePostExample() {
  const tenantId: string = 'tenant-9f8b7c';
  const postId: string = 'post-3a4d5e';
  const updateParams: UpdateFeedPostParams = {
    title: 'New Announcement',
    content: 'We have updated our terms of service.',
    media: [
      {
        url: 'https://cdn.example.com/assets/image.png',
        type: 'image',
        asset: {
          width: 800,
          height: 600,
          size: 124000
        } as FeedPostMediaItemAsset
      } as FeedPostMediaItem
    ],
    link: {
      url: 'https://example.com/terms',
      title: 'Read the new TOS'
    } as FeedPostLink
  };
  const broadcastId: string = 'broadcast-2023-09';
  const sso: string = 'sso-abc123xyz';
  const result: UpdateFeedPostPublicResponse = await updateFeedPostPublic(
    tenantId,
    postId,
    updateParams,
    broadcastId,
    sso
  );
}

Marcar comentario público

Parámetros

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

Respuesta

Devuelve: FlagCommentPublicResponse

Ejemplo

Ejemplo flagCommentPublic

Copy

async function demoFlagComment() {
    const tenantId: string = "acme-tenant-123";
    const commentId: string = "comment-987654";
    const isFlagged: boolean = true;
    const sso: string = "sso-token-abc123";
    const result: FlagCommentPublicResponse = await flagCommentPublic(
        tenantId,
        commentId,
        isFlagged,
        sso
    );
    console.log(result);
}
demoFlagComment();

Obtener GIF grande

Parámetros

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

Respuesta

Devuelve: GetGifLargeResponse

Ejemplo

getGifLarge Ejemplo

Copy

(async () => {
  const tenantId: string = 'c9f4a1b2-3d5e-4f6a-8b9c-0d1e2f3a4b5c';
  const largeInternalURLSanitized: string = 'https://cdn.fastcomments.com/gifs/awesome-cat-large.gif';
  const result: GetGifLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
  console.log(result);
})();

Buscar GIFs

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 demo() {
  const tenantId: string = "tenant_9f8b7c";
  const search: string = "funny cats";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 1;
  const result: GetGifsSearchResponse = await getGifsSearch(
    tenantId,
    search,
    locale,
    rating,
    page
  );
  console.log(result);
}
demo();

Obtener GIFs en tendencia

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

Agregar hashtag

Parámetros

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

Respuesta

Devuelve: AddHashTagResponse

Ejemplo

addHashTag Ejemplo

Copy

const tenantId: string = "tenant_9876";
const newHashTag: CreateHashTagBody = {
  tag: "typescript",
  description: "Discussions about TypeScript"
};
const responseWithTenant: AddHashTagResponse = await addHashTag(tenantId, newHashTag);
const responseWithoutTenant: AddHashTagResponse = await addHashTag(undefined, newHashTag);

Agregar hashtags en bloque

Parámetros

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

Respuesta

Devuelve: AddHashTagsBulkResponse

Ejemplo

Ejemplo addHashTagsBulk

Copy

async () => {
    const tenantId: string | undefined = "tenant_9f8b7c6d";
    const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
        tags: [
            {
                name: "typescript",
                description: "Discussions about TypeScript",
                color: "#3178c6"
            },
            {
                name: "fastcomments",
                description: "Tags for FastComments integration",
                color: "#00aaff"
            }
        ]
    };
    const result: AddHashTagsBulkResponse = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    console.log(result);
}();

Eliminar hashtag

Parámetros

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

Respuesta

Devuelve: DeleteHashTagResponse

Ejemplo

Ejemplo deleteHashTag

Copy

(async () => {
  const tag: string = "announcement";
  const tenantId: string = "tenant_9876";
  const requestBody: DeleteHashTagRequestBody = {
    confirmDeletion: true
  };
  const response: DeleteHashTagResponse = await deleteHashTag(tag, tenantId, requestBody);
  console.log(response);
})();

Obtener hashtags

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
page	number	No

Respuesta

Returns: GetHashTagsResponse1

Ejemplo

Ejemplo getHashTags

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const responseWithPage: GetHashTagsResponse1 = await getHashTags(tenantId, 1);
  const responseDefault: GetHashTagsResponse1 = await getHashTags(tenantId);
  console.log(responseWithPage, responseDefault);
})();

Actualizar parcialmente hashtag

Parámetros

Nombre	Tipo	Requerido
tag	string	Yes
tenantId	string	No
updateHashTagBody	UpdateHashTagBody	No

Respuesta

Devuelve: PatchHashTagResponse

Ejemplo

patchHashTag Ejemplo

Copy

const response1: PatchHashTagResponse = await patchHashTag("new-feature");
const response2: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c"
);
const updateBody: UpdateHashTagBody = {
  description: "Mark comments related to the upcoming beta release",
  color: "#1e90ff"
};
const response3: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c",
  updateBody
);

Eliminar voto de moderación

Parámetros

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

Respuesta

Devuelve: DeleteModerationVoteResponse

Ejemplo

Ejemplo de deleteModerationVote

Copy

const commentId: string = "cmt_12345";
const voteId: string = "vote_9876";
const broadcastId: string = "brd_001";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc";
const result: DeleteModerationVoteResponse = await deleteModerationVote(
  commentId,
  voteId,
  broadcastId,
  tenantId,
  sso
);

Obtener comentarios (API)

Parámetros

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

Respuesta

Devuelve: GetApiCommentsResponse

Ejemplo

Ejemplo getApiComments

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // page
    25,                    // count
    "feedback",           // textSearch
    "192.168.1.100",      // byIPFromComment
    "approved",           // filters
    "hasReplies",         // searchFilters
    "dateDesc",           // sorts
    false,                // demo
    "tenant-abc123",      // tenantId
    "sso-token-xyz"       // sso
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

Obtener estado de exportación (API)

Parámetros

Nombre	Tipo	Requerido
batchJobId	string	No
tenantId	string	No
sso	string	No

Respuesta

Devuelve: GetApiExportStatusResponse

Ejemplo

Ejemplo getApiExportStatus

Copy

async function demoExportStatus() {
    const batchJobId: string = "exportBatch-20231101-001";
    const tenantId: string = "tenant-abc123";
    const ssoToken: string = "sso-xyz789";
    const fullStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId, tenantId, ssoToken);
    const simpleStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId);
    console.log(fullStatus, simpleStatus);
}

Obtener IDs (API)

Parámetros

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

Respuesta

Devuelve: GetApiIdsResponse

Ejemplo

Ejemplo getApiIds

Copy

const textSearch: string = "urgent feedback";
const byIPFromComment: string = "203.0.113.42";
const filters: string = "status:approved";
const afterId: string = "comment-789";
const demo: boolean = true;
const tenantId: string = "tenant-001";
const apiIds: GetApiIdsResponse = await getApiIds({
  textSearch,
  byIPFromComment,
  filters,
  afterId,
  demo,
  tenantId,
});

Obtener usuarios baneados por comentario

Parámetros

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

Respuesta

Devuelve: GetBanUsersFromCommentResponse

Ejemplo

Ejemplo getBanUsersFromComment

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // Llamada con todos los parámetros
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // Llamada con solo el parámetro requerido
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

Obtener estado de baneo de comentario

Parámetros

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

Respuesta

Devuelve: GetCommentBanStatusResponse1

Ejemplo

getCommentBanStatus Ejemplo

Copy

async function checkCommentBanStatus() {
  const banStatus: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654321', 'tenant_42', 'sso_token_abc123');
  const banStatusNoTenant: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654322', undefined, 'sso_token_def456');
}

Obtener respuestas del comentario

Parámetros

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

Respuesta

Devuelve: GetCommentChildrenResponse

Ejemplo

Ejemplo getCommentChildren

Copy

const commentId: string = "cmt_12345";
const tenantId: string = "tenant_xyz";
const sso: string = "sso_987654";
const fullResponse: GetCommentChildrenResponse = await getCommentChildren(commentId, tenantId, sso);
const minimalResponse: GetCommentChildrenResponse = await getCommentChildren(commentId);

Obtener recuento

Parámetros

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

Respuesta

Devuelve: GetCountResponse

Ejemplo

Ejemplo de getCount

Copy

async function main(): Promise<void> {
  const count: GetCountResponse = await getCount({
    textSearch: "order issue",
    byIPFromComment: "198.51.100.23",
    filter: "pending",
    demo: true,
    tenantId: "acme_corp",
    sso: "sso_abcdef123456"
  });
  console.log(count);
}
main();

Obtener recuentos

Parámetros

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

Respuesta

Devuelve: GetCountsResponse

Ejemplo

Ejemplo de getCounts

Copy

async function runExample() {
    const tenantId: string = "acme-corp";
    const ssoToken: string = "sso-token-2024";
    const withBoth: GetCountsResponse = await getCounts(tenantId, ssoToken);
    const withTenantOnly: GetCountsResponse = await getCounts(tenantId);
    const withoutParams: GetCountsResponse = await getCounts();
    console.log(withBoth, withTenantOnly, withoutParams);
}
runExample();

Obtener registros

Parámetros

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

Respuesta

Devuelve: GetLogsResponse

Ejemplo

Ejemplo getLogs

Copy

async function fetchLogs() {
    const commentId: string = "cmt_9a8b7c6d5e4f3a2b";
    const tenantId: string = "tenant_9876";
    const sso: string = "sso_abcdef123456";

    const fullResponse: GetLogsResponse = await getLogs(commentId, tenantId, sso);
    const minimalResponse: GetLogsResponse = await getLogs(commentId);
}

Obtener insignias manuales

Parámetros

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

Respuesta

Devuelve: GetManualBadgesResponse

Ejemplo

Ejemplo de getManualBadges

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // Llamada con ambos parámetros opcionales
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // Llamada solo con tenantId
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

Obtener insignias manuales para usuario

Parámetros

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

Respuesta

Devuelve: GetManualBadgesForUserResponse

Ejemplo

Ejemplo de getManualBadgesForUser

Copy

(async () => {
  const userId: string = "user_42";
  const commentId: string = "comment_1001";
  const tenantId: string = "tenant_acme";
  const ssoToken: string = "sso_5f6g7h8i9j";
  const badges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId, commentId, tenantId, ssoToken);
  const limitedBadges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId);
})();

Obtener comentario de moderación

Parámetros

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

Respuesta

Devuelve: GetModerationCommentResponse

Ejemplo

Ejemplo getModerationComment

Copy

async function fetchCommentDetails() {
  // Conjunto completo de parámetros
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // Llamada mínima usando solo el argumento requerido
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // Utilice los resultados según sea necesario...
}

Obtener texto de comentario de moderación

Parámetros

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

Respuesta

Devuelve: GetModerationCommentTextResponse

Ejemplo

getModerationCommentText Ejemplo

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // Llamar sólo con el parámetro requerido
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // Llamar con parámetros opcionales
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

Obtener resumen previo al baneo

Parámetros

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

Respuesta

Devuelve: GetPreBanSummaryResponse

Ejemplo

Ejemplo getPreBanSummary

Copy

const commentId: string = "5f8d0c2e4b1a2c3d4e5f6a7b";
const includeByUserIdAndEmail: boolean = true;
const includeByIP: boolean = true;
const includeByEmailDomain: boolean = false;
const tenantId: string = "tenant-001";
const sso: string = "sso-xyz-123";
const preBanSummary: GetPreBanSummaryResponse = await getPreBanSummary(
  commentId,
  includeByUserIdAndEmail,
  includeByIP,
  includeByEmailDomain,
  tenantId,
  sso
);

Obtener resumen de búsqueda de comentarios

Parámetros

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

Respuesta

Returns: GetSearchCommentsSummaryResponse

Ejemplo

Ejemplo getSearchCommentsSummary

Copy

async function runExample(): Promise<void> {
    const searchTerm: string = "fastcomments integration";
    const filterString: string = "status:approved";
    const searchFilterString: string = "author:jane";
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
    const summary: GetSearchCommentsSummaryResponse = await getSearchCommentsSummary(
        searchTerm,
        filterString,
        searchFilterString,
        tenantId,
        ssoToken
    );
    console.log(summary);
}
runExample();

Obtener páginas de búsqueda

Parámetros

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

Respuesta

Devuelve: GetSearchPagesResponse

Ejemplo

Ejemplo getSearchPages

Copy

(async () => {
  const query: string = "network outage";
  const tenantId: string = "tenant-9876";
  const ssoToken: string = "sso-abc123def456";
  const searchResult: GetSearchPagesResponse = await getSearchPages(query, tenantId, ssoToken);
  const searchResultNoSso: GetSearchPagesResponse = await getSearchPages(query, tenantId);
})();

Obtener sitios de búsqueda

Parámetros

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

Respuesta

Devuelve: GetSearchSitesResponse

Ejemplo

Ejemplo getSearchSites

Copy

async function fetchSites() {
  const value: string = "customer support"
  const tenantId: string = "tenant-9876"
  const sso: string = "sso-abc123"
  const sites: GetSearchSitesResponse = await getSearchSites(value, tenantId, sso)
  const sitesOnlyTenant: GetSearchSitesResponse = await getSearchSites(undefined, tenantId)
}

Obtener sugerencias de búsqueda

Parámetros

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

Respuesta

Devuelve: GetSearchSuggestResponse

Ejemplo

Ejemplo getSearchSuggest

Copy

async function example(): Promise<void> {
    const term: string = "fastcomments api";
    const tenant: string = "tenant_001";
    const sso: string = "sso_9a8b7c";
    const fullResult: GetSearchSuggestResponse = await getSearchSuggest(term, tenant, sso);
    const partialResult: GetSearchSuggestResponse = await getSearchSuggest(term);
}
example();

Obtener usuarios de búsqueda

Parámetros

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

Respuesta

Devuelve: GetSearchUsersResponse

Ejemplo

Ejemplo getSearchUsers

Copy

async function demoSearch() {
    const query: string = "john.doe@example.com";
    const tenantId: string = "tenant_12345";
    const ssoToken: string = "sso_token_abc";
    const resultWithSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId, ssoToken);
    const resultWithoutSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId);
}

Obtener factor de confianza

Parámetros

Nombre	Tipo	Requerido
userId	string	No
tenantId	string	No
sso	string	No

Respuesta

Devuelve: GetTrustFactorResponse

Ejemplo

Ejemplo de getTrustFactor

Copy

async function runDemo(): Promise<void> {
    const trustFull: GetTrustFactorResponse = await getTrustFactor("user_12345", "tenant_abc", "sso_token_987");
    const trustUserOnly: GetTrustFactorResponse = await getTrustFactor("user_12345");
    console.log(trustFull, trustUserOnly);
}
runDemo();

Obtener preferencia de baneo de usuario

Parámetros

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

Respuesta

Devuelve: GetUserBanPreferenceResponse

Ejemplo

Ejemplo de getUserBanPreference

Copy

async function demoGetUserBanPreference(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-2024";
  const sso: string = "sso-token-9f8b7a6c";
  const result: GetUserBanPreferenceResponse = await getUserBanPreference(tenantId, sso);
  console.log(result);
}
demoGetUserBanPreference();

Obtener perfil interno de usuario

Parámetros

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

Respuesta

Devuelve: GetUserInternalProfileResponse1

Ejemplo

Ejemplo getUserInternalProfile

Copy

(async () => {
  const fullProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_12345",
    tenantId: "tenant_67890",
    sso: "sso_token_abcdef"
  });
  const partialProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_98765"
  });
})();

Ajustar votos de comentario

Parámetros

Nombre	Tipo	Requerido
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Respuesta

Devuelve: PostAdjustCommentVotesResponse

Ejemplo

Ejemplo de postAdjustCommentVotes

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // campos adicionales según lo requiera AdjustCommentVotesParams
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

Exportar (API)

Parámetros

Nombre	Tipo	Obligatorio
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
tenantId	string	No
sso	string	No

Respuesta

Devuelve: PostApiExportResponse

Ejemplo

postApiExport Ejemplo

Copy

(async () => {
  const textSearch: string = "keyword:feedback"
  const byIPFromComment: string = "203.0.113.45"
  const filters: string = "status:pending,category:support"
  const searchFilters: string = "createdAt>2023-01-01"
  const sorts: string = "createdAt:desc"
  const tenantId: string = "tenant_9876"
  const sso: string = "sso_7e2a9b"
  const exportResult: PostApiExportResponse = await postApiExport(
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    sorts,
    tenantId,
    sso
  )
  console.log(exportResult)
})()

Banear usuario por comentario

Parámetros

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

Respuesta

Devuelve: PostBanUserFromCommentResponse

Ejemplo

Ejemplo de postBanUserFromComment

Copy

async function runBan() {
  const commentId: string = "cmt_5f8a2b3c";
  const banEmail: boolean = true;
  const banIP: boolean = false;
  const deleteAllUsersComments: boolean = true;
  const bannedUntil: string = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString();
  const isShadowBan: boolean = false;
  const banReason: string = "Repeated spam posting";
  const tenantId: string = "tenant_12345";
  const response: PostBanUserFromCommentResponse = await postBanUserFromComment(
    commentId,
    banEmail,
    undefined,
    banIP,
    deleteAllUsersComments,
    bannedUntil,
    isShadowBan,
    undefined,
    banReason,
    tenantId
  );
  console.log(response);
}
runBan();

Deshacer baneo de usuario

Parámetros

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

Respuesta

Devuelve: PostBanUserUndoResponse

Ejemplo

postBanUserUndo Ejemplo

Copy

const undoParams: BanUserUndoParams = {
  userId: "user-8421",
  commentId: "comment-6702",
  reason: "Accidental ban"
};
const tenantId: string = "tenant-7f9e";
const ssoToken: string = "sso-4b2c1d";
async function runUndo() {
  const resultAll: PostBanUserUndoResponse = await postBanUserUndo(undoParams, tenantId, ssoToken);
  console.log(resultAll);
  const resultMinimal: PostBanUserUndoResponse = await postBanUserUndo(undoParams);
  console.log(resultMinimal);
}
runUndo();

Enviar resumen previo al baneo en bloque

Parámetros

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

Respuesta

Devuelve: PostBulkPreBanSummaryResponse

Ejemplo

Ejemplo postBulkPreBanSummary

Copy

async function runExample() {
  const bulkPreBanParams: BulkPreBanParams = {
    userIds: [10234, 56789],
    emails: ["spam_user@example.com", "abuse@badsite.org"],
    ips: ["203.0.113.45", "198.51.100.22"],
    emailDomains: ["maliciousdomain.com"]
  };
  const includeByUserIdAndEmail: boolean = true;
  const includeByIP: boolean = false;
  const includeByEmailDomain: boolean = true;
  const tenantId: string = "tenant_8f4b2c1a";
  const sso: string = "sso-3948abf0";
  const summary: PostBulkPreBanSummaryResponse = await postBulkPreBanSummary(
    bulkPreBanParams,
    includeByUserIdAndEmail,
    includeByIP,
    includeByEmailDomain,
    tenantId,
    sso
  );
  console.log(summary);
}
runExample();

Publicar comentarios por IDs

Parámetros

Nombre	Tipo	Requerido
commentsByIdsParams	CommentsByIdsParams	Sí
tenantId	string	No
sso	string	No

Respuesta

Devuelve: PostCommentsByIdsResponse

Ejemplo

Ejemplo postCommentsByIds

Copy

const commentsByIdsParams: CommentsByIdsParams = {
  commentIds: ['cmt001', 'cmt002'],
  includeUserInfo: true,
  includeThreadInfo: false,
} as CommentsByIdsParams;
const fullResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams,
  'tenant-12345',
  'sso-token-xyz'
);
const minimalResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams
);

Marcar comentario (moderación)

Parámetros

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

Respuesta

Devuelve: PostFlagCommentResponse

Ejemplo

postFlagComment Ejemplo

Copy

const commentId: string = "cmt_20230915_001";
const broadcastId: string = "brd_20230915_live";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc123";
const flaggedResponse: PostFlagCommentResponse = await postFlagComment(
  commentId,
  broadcastId,
  tenantId,
  sso
);

Eliminar comentario (moderación)

Parámetros

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

Respuesta

Devuelve: PostRemoveCommentResponse

Ejemplo

Ejemplo postRemoveComment

Copy

async function removeCommentExample(): Promise<void> {
  const commentId: string = "cmt_7f9a3e2b";
  const result1: PostRemoveCommentResponse = await postRemoveComment(commentId);
  const broadcastId: string = "brd_12ab34cd";
  const tenantId: string = "tenant_5678efgh";
  const sso: string = "sso_XYZ12345";
  const result2: PostRemoveCommentResponse = await postRemoveComment(commentId, broadcastId, tenantId, sso);
  console.log(result1, result2);
}

Restaurar comentario eliminado

Parámetros

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

Respuesta

Devuelve: PostRestoreDeletedCommentResponse

Ejemplo

postRestoreDeletedComment Ejemplo

Copy

async function restoreCommentDemo(): Promise<void> {
    const commentId: string = "cmt_5f2a9b7e1234567890abcd";
    const broadcastId: string | undefined = "brd_2023_09";
    const tenantId: string | undefined = "tenant_42";
    const sso: string | undefined = "sso_token_abcdef123456";
    const response: PostRestoreDeletedCommentResponse = await postRestoreDeletedComment(
        commentId,
        broadcastId,
        tenantId,
        sso
    );
    console.log(response);
}
restoreCommentDemo();

Establecer estado de aprobación del comentario

Parámetros

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

Respuesta

Devuelve: PostSetCommentApprovalStatusResponse

Ejemplo

postSetCommentApprovalStatus Ejemplo

Copy

async function main() {
  const commentIdOnly: string = "cmt_1001";
  const resultOnly: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(commentIdOnly);
  const commentIdFull: string = "cmt_2002";
  const approvedFull: boolean = true;
  const broadcastIdFull: string = "brd_3003";
  const tenantIdFull: string = "tenant_abc";
  const ssoFull: string = "sso_token_xyz";
  const resultFull: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(
    commentIdFull,
    approvedFull,
    broadcastIdFull,
    tenantIdFull,
    ssoFull
  );
  console.log(resultOnly, resultFull);
}
main();

Establecer estado de revisión del comentario

Parámetros

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

Respuesta

Devuelve: PostSetCommentReviewStatusResponse

Ejemplo

Ejemplo postSetCommentReviewStatus

Copy

async function updateCommentReviewStatus(): Promise<void> {
  const commentId: string = "cmt_9f8a7b6c5d4e3f2a1b0c";
  const reviewed: boolean = true;
  const broadcastId: string = "broadcast_2024Q1";
  const tenantId: string = "tenant_1001";
  const sso: string = "alice@example.com";
  const response: PostSetCommentReviewStatusResponse = await postSetCommentReviewStatus(
    commentId,
    reviewed,
    broadcastId,
    tenantId,
    sso
  );
  console.log(response);
}

Establecer estado de spam del comentario

Parámetros

Name	Type	Required
commentId	string	Yes
spam	boolean	No
permNotSpam	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Respuesta

Returns: PostSetCommentSpamStatusResponse

Ejemplo

Ejemplo postSetCommentSpamStatus

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // Sólo el parámetro requerido
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // Todos los parámetros opcionales provistos
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

Establecer texto del comentario (moderación)

Parámetros

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

Respuesta

Devuelve: PostSetCommentTextResponse

Ejemplo

postSetCommentText Ejemplo

Copy

(async () => {
  const commentId: string = "cmt_9f8b7a6d5e4c3b2a1";
  const setParams: SetCommentTextParams = {
    text: "Edited comment to correct a typo and add clarification."
  };
  const broadcastId: string = "brd_1a2b3c4d5e6f7g8h9";
  const tenantId: string = "tenant_xyz123";
  const sso: string = "sso_user_456def";
  const fullResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams,
    broadcastId,
    tenantId,
    sso
  );
  const minimalResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams
  );
  console.log(fullResult, minimalResult);
})();

Desmarcar comentario

Parámetros

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

Respuesta

Devuelve: PostUnFlagCommentResponse

Ejemplo

Ejemplo postUnFlagComment

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId (opcional)
    "tenant_abc",         // tenantId (opcional)
    "sso_user_token_789"  // sso (opcional)
  );
};

Votar (moderación)

Parámetros

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

Respuesta

Devuelve: PostVoteResponse

Ejemplo

Ejemplo postVote

Copy

let commentId: string = 'cmt_12345';
let direction: string = 'up';
let broadcastId: string = 'brd_67890';
let tenantId: string = 'tenant_abc';
let sso: string = 'sso_token_xyz';
const fullVote: PostVoteResponse = await postVote(
  commentId,
  direction,
  broadcastId,
  tenantId,
  sso
);
const simpleVote: PostVoteResponse = await postVote('cmt_67890');

Conceder insignia

Parámetros

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

Respuesta

Devuelve: PutAwardBadgeResponse

Ejemplo

Ejemplo putAwardBadge

Copy

(async () => {
    const badgeId: string = "badge-superstar"
    const userId: string = "user-42"
    const commentId: string = "comment-7f9c3"
    const broadcastId: string = "broadcast-2023-09"
    const result: PutAwardBadgeResponse = await putAwardBadge(badgeId, userId, commentId, broadcastId)
    console.log(result)
})()

Cerrar hilo

Parámetros

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

Respuesta

Devuelve: PutCloseThreadResponse

Ejemplo

Ejemplo putCloseThread

Copy

async function closeThreadDemo(): Promise<void> {
  const urlId: string = "article-2023-09-15";
  const tenantId: string = "tenant-42";
  const sso: string = "sso-token-xyz";
  const response: PutCloseThreadResponse = await putCloseThread(urlId, tenantId, sso);
  console.log(response);
}
closeThreadDemo();

Quitar insignia

Parámetros

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

Respuesta

Devuelve: PutRemoveBadgeResponse

Ejemplo

putRemoveBadge Ejemplo

Copy

const badgeId: string = "badge-12345";
const userId: string = "user-9876";
const commentId: string = "comment-5555";
const broadcastId: string = "broadcast-001";
const result: PutRemoveBadgeResponse = await putRemoveBadge(
  badgeId,
  userId,
  commentId,
  broadcastId
);

Reabrir hilo

Parámetros

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

Respuesta

Devuelve: PutReopenThreadResponse

Ejemplo

Ejemplo putReopenThread

Copy

async function exampleUsage() {
  const urlId: string = "thread-9f8b7c6a";
  const tenantId: string = "tenant-001";
  const sso: string = "sso-3f9d2e1a";
  const resultAll: PutReopenThreadResponse = await putReopenThread(urlId, tenantId, sso);
  console.log(resultAll);
  const resultMinimal: PutReopenThreadResponse = await putReopenThread(urlId);
  console.log(resultMinimal);
}

Establecer factor de confianza

Parámetros

Nombre	Tipo	Obligatorio
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

Respuesta

Devuelve: SetTrustFactorResponse

Ejemplo

Ejemplo setTrustFactor

Copy

(async () => {
  const userId: string = "user_8421";
  const trustFactor: string = "high";
  const tenantId: string = "tenant_33";
  const ssoToken: string = "sso_7d9f";
  const fullResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor, tenantId, ssoToken);
  const minimalResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor);
})();

Crear moderador

Parámetros

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

Respuesta

Devuelve: CreateModeratorResponse1

Ejemplo

Ejemplo de createModerator

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // los campos opcionales como descripción se omiten
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

Eliminar moderador

Parámetros

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

Respuesta

Devuelve: DeleteModeratorResponse

Ejemplo

Ejemplo deleteModerator

Copy

async function runDeleteModeratorExample() {
  const tenantId: string = "tenant_2023";
  const moderatorId: string = "mod_001";
  const notificationEmail: string = "admin@mycompany.com";
  const resultWithEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId, notificationEmail);
  const resultWithoutEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId);
}

Obtener moderador

Parámetros

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

Respuesta

Devuelve: GetModeratorResponse1

Ejemplo

Ejemplo getModerator

Copy

(async () => {
  const tenantId: string = "acme-corp-001";
  const id: string = "mod-12345";
  const result: GetModeratorResponse1 = await getModerator(tenantId, id);
  const moderatorName: string | undefined = result.moderator?.name;
  console.log(moderatorName);
})();

Obtener moderadores

Parámetros

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

Respuesta

Devuelve: GetModeratorsResponse1

Ejemplo

Ejemplo getModerators

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // desplazamiento de paginación opcional
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // Ejemplo sin paginación:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

Enviar invitación

Parámetros

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

Respuesta

Devuelve: SendInviteResponse

Ejemplo

Ejemplo de sendInvite

Copy

const tenantId: string = "acme-corp-tenant";
const inviteId: string = "invite-12345";
const fromName: string = "John Doe";
const inviteResult: SendInviteResponse = await sendInvite(tenantId, inviteId, fromName);

Actualizar moderador

Parámetros

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

Respuesta

Devuelve: UpdateModeratorResponse

Ejemplo

Ejemplo de updateModerator

Copy

async function demoUpdateModerator(): Promise<void> {
    const tenantId: string = "tenant_42abc";
    const moderatorId: string = "moderator_8f9e";
    const updateBody: UpdateModeratorBody = {
        isActive: true,
        role: "admin",
        // campo opcional
        notes: "Promoted to senior moderator"
    };
    const result: UpdateModeratorResponse = await updateModerator(tenantId, moderatorId, updateBody);
    console.log(result);
}
demoUpdateModerator();

Eliminar conteo de notificaciones

Parámetros

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

Respuesta

Devuelve: DeleteNotificationCountResponse

Ejemplo

deleteNotificationCount Ejemplo

Copy

async function run() {
  const tenantId: string = "tenant_12345";
  const notificationId: string = "notif_98765";
  const result: DeleteNotificationCountResponse = await deleteNotificationCount(tenantId, notificationId);
  console.log(result);
}
run();

Obtener conteo de notificaciones en caché

Parámetros

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

Respuesta

Devuelve: GetCachedNotificationCountResponse1

Ejemplo

Ejemplo getCachedNotificationCount

Copy

const tenantId: string = "e3f1a9b2-4c5d-6e7f-8a9b-0c1d2e3f4a5b";
const userId: string = "u-20231101-001";
const notificationResult: GetCachedNotificationCountResponse1 = await getCachedNotificationCount(tenantId, userId);
console.log(notificationResult);

Obtener conteo de notificaciones

Parámetros

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

Respuesta

Devuelve: GetNotificationCountResponse1

Ejemplo

Ejemplo getNotificationCount

Copy

async function demoNotificationCount() {
    const tenantId: string = "tenant_001";
    const userId: string = "user_42";
    const urlId: string = "url_9f8e7d";
    const fromCommentId: string = "comment_12345";
    const viewed: boolean = false;
    const type: string = "mention";
    const result: GetNotificationCountResponse1 = await getNotificationCount(
        tenantId,
        userId,
        urlId,
        fromCommentId,
        viewed,
        type
    );
    console.log(result);
}
demoNotificationCount();

Obtener notificaciones

Parámetros

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

Respuesta

Devuelve: GetNotificationsResponse1

Ejemplo

Ejemplo getNotifications

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const notifications: GetNotificationsResponse1 = await getNotifications(tenantId, userId);
  console.log(notifications);
  const more: GetNotificationsResponse1 = await getNotifications(
    tenantId,
    undefined,
    "article-5678",
    undefined,
    true,
    "reply",
    10
  );
  console.log(more);
}
demo();

Actualizar notificación

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

Respuesta

Devuelve: UpdateNotificationResponse

Ejemplo

Ejemplo de updateNotification

Copy

const tenantId: string = "tenant_5f4d2c";
const notificationId: string = "notif_9b8a7c";
const updateBody: UpdateNotificationBody = {
  enabled: false,
  sendEmail: true,
  schedule: "2023-12-01T08:00:00Z"
};
const userId: string = "user_123e4567";
const responseWithUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody,
  userId
);
const responseWithoutUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody
);

Crear reacción de página V1

Parámetros

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

Respuesta

Devuelve: CreateV1PageReactResponse

Ejemplo

createV1PageReact Ejemplo

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "article-2024-06-improvements";
const title: string = "FastComments API Integration Guide";
const responseWithTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId, title);
const responseWithoutTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId);

Crear reacción de página V2

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
urlId	string	Yes
id	string	Yes
title	string	No

Respuesta

Devuelve: CreateV2PageReactResponse

Ejemplo

Ejemplo de createV2PageReact

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const urlId: string = "blog/posts/fastcomments-integration";
  const pageId: string = "page-12345";
  const title: string = "FastComments API Integration Guide";
  const responseWithoutTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId);
  const responseWithTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId, title);
  console.log(responseWithoutTitle, responseWithTitle);
})();

Eliminar reacción de página V1

Parámetros

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

Respuesta

Devuelve: DeleteV1PageReactResponse

Ejemplo

deleteV1PageReact Ejemplo

Copy

const tenantId: string = "acme-corp";
const urlId: string = "article-2024-06-01";
const response: DeleteV1PageReactResponse = await deleteV1PageReact(tenantId, urlId);
console.log(response);

Eliminar reacción de página V2

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Respuesta

Devuelve: DeleteV2PageReactResponse

Ejemplo

deleteV2PageReact Ejemplo

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "page_98765";
const reactionId: string = "react_abcde";
const deleteResult: DeleteV2PageReactResponse = await deleteV2PageReact(tenantId, urlId, reactionId);

Obtener me gusta de página V1

Parámetros

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

Respuesta

Devuelve: GetV1PageLikesResponse

Ejemplo

Ejemplo de getV1PageLikes

Copy

async function fetchPageLikes() {
  const tenantId: string = "acme-corp-tenant-42";
  const urlId: string = "blog-post-2024-06-typescript-best-practices";
  const likes: GetV1PageLikesResponse = await getV1PageLikes(tenantId, urlId);
  console.log(likes);
}

Obtener reacciones de página V2

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Respuesta

Devuelve: GetV2PageReactsResponse

Ejemplo

Ejemplo getV2PageReacts

Copy

async function demoGetPageReacts(): Promise<void> {
    const tenantId: string = "acme-corp-tenant";
    const urlId: string = "article-2024-06-01";
    const reacts: GetV2PageReactsResponse = await getV2PageReacts(tenantId, urlId);
    // ejemplo de acceso a propiedad opcional
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

Obtener usuarios que reaccionaron en página V2

Parámetros

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Respuesta

Devuelve: GetV2PageReactUsersResponse1

Ejemplo

Ejemplo getV2PageReactUsers

Copy

async function fetchReactUsers() {
  const tenantId: string = 'tenant_12345';
  const urlId: string = 'article-9876';
  const id: string = 'user_abcde';
  const response: GetV2PageReactUsersResponse1 = await getV2PageReactUsers(tenantId, urlId, id);
  console.log(response);
}
fetchReactUsers();

Agregar página

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

Eliminar página

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

Obtener usuarios desconectados

Past commenters on the page who are NOT currently online. Sorted by displayName.
Utilícelo después de agotar /users/online para renderizar una sección de "Members".
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Response

Returns: GetOfflineUsersResponse

Example

Ejemplo getOfflineUsers

Copy

async function fetchOfflineUsers(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "thread_9876";
    const afterName: string = "Jane Smith";
    const afterUserId: string = "user_7f9b3c";
    const offlineUsers: GetOfflineUsersResponse = await getOfflineUsers(
        tenantId,
        urlId,
        afterName,
        afterUserId
    );
    console.log(offlineUsers);
}

Obtener usuarios en línea

Actualmente, los espectadores 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: GetOnlineUsersResponse

Ejemplo

Ejemplo getOnlineUsers

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // Con parámetros de paginación opcionales
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // Sin parámetros de paginación opcionales
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

Obtener página por URL/ID

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

Obtener páginas

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

Obtener páginas públicas

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parameters

Nombre	Tipo	Obligatorio
tenantId	string	Sí
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

Response

Returns: GetPagesPublicResponse

Example

Ejemplo getPagesPublic

Copy

async function fetchPages() {
  const tenantId: string = "tenant_12345";
  const cursor: string = "nextPageToken";
  const limit: number = 20;
  const q: string = "blog";
  const sortBy: PagesSortBy = "createdAt";
  const hasComments: boolean = true;
  const response: GetPagesPublicResponse = await getPagesPublic(
    tenantId,
    cursor,
    limit,
    q,
    sortBy,
    hasComments
  );
  console.log(response);
}

Obtener información de usuarios

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

Parameters

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

Response

Returns: GetUsersInfoResponse

Example

Ejemplo getUsersInfo

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Los campos opcionales en la respuesta pueden ser undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

Actualizar parcialmente página

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

Eliminar evento webhook pendiente

Parámetros

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

Respuesta

Devuelve: DeletePendingWebhookEventResponse

Ejemplo

Ejemplo deletePendingWebhookEvent

Copy

async function runDemo() {
  const tenantId: string = 'c3f5e9d2-1a2b-4c3d-9e7f-1234567890ab';
  const eventId: string = 'event_987654321';
  const response: DeletePendingWebhookEventResponse = await deletePendingWebhookEvent(tenantId, eventId);
  console.log(response);
}
runDemo();

Obtener conteo de eventos webhook pendientes

Parámetros

Name	Type	Required
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Respuesta

Devuelve: GetPendingWebhookEventCountResponse1

Ejemplo

getPendingWebhookEventCount Ejemplo

Copy

(async () => {
  const tenantId: string = "tenant_001";
  const responseAll: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(
    tenantId,
    "comment_456",
    "ext_789",
    "comment.updated",
    "webhook",
    "mydomain.com",
    3
  );
  const responseMinimal: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(tenantId);
  console.log(responseAll, responseMinimal);
})();

Obtener eventos webhook pendientes

Parámetros

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

Respuesta

Devuelve: GetPendingWebhookEventsResponse1

Ejemplo

Ejemplo de getPendingWebhookEvents

Copy

async function fetchPendingEvents(): Promise<void> {
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const commentId: string = "cmt-987654321";
    const externalId: string = "ext-abc-123";
    const eventType: string = "comment_created";
    const type: string = "outbound";
    const domain: string = "myblog.com";
    const attemptCountGT: number = 3;
    const skip: number = 0;
    const pending: GetPendingWebhookEventsResponse1 = await getPendingWebhookEvents(
        tenantId,
        commentId,
        externalId,
        eventType,
        type,
        domain,
        attemptCountGT,
        skip
    );
    console.log(pending);
}
fetchPendingEvents();

Crear configuración de pregunta

Parámetros

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

Respuesta

Devuelve: CreateQuestionConfigResponse1

Ejemplo

Ejemplo createQuestionConfig

Copy

const tenantId: string = "tenant_12345";
const customOption: QuestionConfigCustomOptionsInner = {
  label: "Option A",
  value: "a",
};
const createQuestionConfigBody: CreateQuestionConfigBody = {
  questionText: "What is your favorite color?",
  isActive: true,
  // los campos opcionales pueden omitirse
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

Eliminar configuración de pregunta

Parámetros

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

Respuesta

Devuelve: DeleteQuestionConfigResponse

Ejemplo

Ejemplo de deleteQuestionConfig

Copy

async function runDeletion(): Promise<void> {
  const tenantId: string = "tenant_8f5a2c9d";
  const configId: string = "questionConfig_4b7e1f";
  const deleteResult: DeleteQuestionConfigResponse = await deleteQuestionConfig(tenantId, configId);
  console.log(deleteResult);
}
void runDeletion();

Obtener configuración de pregunta

Parámetros

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

Respuesta

Devuelve: GetQuestionConfigResponse1

Ejemplo

getQuestionConfig Ejemplo

Copy

const tenantId: string = "acme-corp-tenant-42";
const questionId: string = "question-7f9b3e";
const response: GetQuestionConfigResponse1 = await getQuestionConfig(tenantId, questionId);

Obtener configuraciones de preguntas

Parámetros

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

Respuesta

Devuelve: GetQuestionConfigsResponse1

Ejemplo

Ejemplo getQuestionConfigs

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // Llamada sin el parámetro opcional 'skip'
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // Llamada con el parámetro opcional 'skip'
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

Actualizar configuración de pregunta

Parámetros

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

Respuesta

Devuelve: UpdateQuestionConfigResponse

Ejemplo

Ejemplo de updateQuestionConfig

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // campos opcionales demostrados
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

Crear resultado de pregunta

Parámetros

Nombre	Tipo	Requerido	Descripción
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

Respuesta

Devuelve: CreateQuestionResultResponse1

Ejemplo

Ejemplo createQuestionResult

Copy

const tenantId: string = "acme-corp-tenant";
const metaItem: MetaItem = {
  key: "campaign",
  value: "spring-launch"
};
const questionResultBody: CreateQuestionResultBody = {
  questionId: "question-42",
  answer: "Positive",
  metadata: [metaItem]
  // los campos opcionales como notas se omiten
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

Eliminar resultado de pregunta

Parámetros

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

Respuesta

Devuelve: DeleteQuestionResultResponse

Ejemplo

Ejemplo de deleteQuestionResult

Copy

async function runDeletion(): Promise<void> {
    const tenantId: string = "tenant-001";
    const resultId: string = "c9f2a5b3-7e6d-4c9a-8b1f-2d3e4f5a6b7c";
    const result: DeleteQuestionResultResponse = await deleteQuestionResult(tenantId, resultId);
    console.log(result);
}
runDeletion();

Obtener resultado de pregunta

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Respuesta

Devuelve: GetQuestionResultResponse1

Ejemplo

Ejemplo getQuestionResult

Copy

async function fetchQuestionResult(): Promise<void> {
    const tenantId: string = "acme-corp-001";
    const questionId: string = "question-7a9b8c";
    const result: GetQuestionResultResponse1 = await getQuestionResult(tenantId, questionId);
    const question: QuestionResult | undefined = result.questionResult;
    const firstMeta: MetaItem | undefined = result.meta?.[0];
    console.log(question?.id, firstMeta?.key);
}

Obtener resultados de preguntas

Parámetros

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

Respuesta

Devuelve: GetQuestionResultsResponse1

Ejemplo

Ejemplo getQuestionResults

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const urlId: string = "post-456";
  const userId: string = "user-789";
  const startDate: string = "2023-09-01T00:00:00Z";
  const questionId: string = "q-101";
  const questionIds: string = "q-102,q-103";
  const skip: number = 20;
  const results: GetQuestionResultsResponse1 = await getQuestionResults(
    tenantId,
    urlId,
    userId,
    startDate,
    questionId,
    questionIds,
    skip
  );
  console.log(results);
})();

Actualizar resultado de pregunta

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

Respuesta

Devuelve: UpdateQuestionResultResponse

Ejemplo

Ejemplo de updateQuestionResult

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // campos requeridos
        answer: "No",
        // campos opcionales
        comment: "User clarified their response",
        // anotherOptionalField?: value,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

Agregación de resultados de preguntas

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

Ejemplo

aggregateQuestionResults Ejemplo

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const questionId: string = "feedback-rating";
  const questionIds: string[] = ["feedback-rating", "recommendation"];
  const urlId: string = "https://myblog.com/articles/42";
  const timeBucket: AggregateTimeBucket = "month";
  const startDate: Date = new Date("2023-01-01T00:00:00Z");
  const forceRecalculate: boolean = true;
  const result: AggregateQuestionResultsResponse1 = await aggregateQuestionResults(
    tenantId,
    questionId,
    questionIds,
    urlId,
    timeBucket,
    startDate,
    forceRecalculate
  );
  console.log(result);
})();

Agregación en bloque de resultados de preguntas

Parámetros

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

Respuesta

Devuelve: BulkAggregateQuestionResultsResponse1

Ejemplo

Ejemplo bulkAggregateQuestionResults

Copy

const tenantId: string = "acme-corp";
const request: BulkAggregateQuestionResultsRequest = {
  questionIds: ["product-satisfaction", "feature-usage"],
  startDate: "2024-01-01T00:00:00Z",
  endDate: "2024-01-31T23:59:59Z",
  timeBucket: "day"
};
const result: BulkAggregateQuestionResultsResponse1 = await bulkAggregateQuestionResults(
  tenantId,
  request,
  true
);

Combinar comentarios con resultados de preguntas

Parámetros

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

Ejemplo

Ejemplo combineCommentsWithQuestionResults

Copy

const tenantId: string = "tenant_12345";
const questionIds: string[] = ["question_1", "question_2"];
const urlId: string = "article-9876";
const startDate: Date = new Date("2023-01-01T00:00:00Z");
const forceRecalculate: boolean = false;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResultsResponse = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

Agregar usuario SSO

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

Eliminar usuario SSO

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

Obtener usuario SSO por correo

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

Obtener usuario SSO por ID

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

Obtener usuarios SSO

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

Actualizar parcialmente usuario SSO

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

Reemplazar usuario SSO

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

Crear suscripción

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

Eliminar suscripción

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

Obtener suscripciones

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

Actualizar suscripción

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

Obtener usos diarios del tenant

Parámetros

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

Respuesta

Devuelve: GetTenantDailyUsagesResponse1

Ejemplo

Ejemplo getTenantDailyUsages

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // Mayo
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // Usando solo el parámetro requerido y uno opcional
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

Crear paquete de tenant

Parámetros

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

Respuesta

Devuelve: CreateTenantPackageResponse1

Ejemplo

Ejemplo createTenantPackage

Copy

(async () => {
  const tenantId: string = "tenant-9876";
  const body: CreateTenantPackageBody = {
    packageName: "Standard",
    quota: 5000,
    // campo opcional
    description: "Standard package for medium traffic",
  };
  const result: CreateTenantPackageResponse1 = await createTenantPackage(tenantId, body);
  console.log(result);
})();

Eliminar paquete de tenant

Parámetros

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

Respuesta

Devuelve: DeleteTenantPackageResponse

Ejemplo

deleteTenantPackage Ejemplo

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // usar el resultado según sea necesario
}
removeTenantPackage();

Obtener paquete de tenant

Parámetros

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

Respuesta

Devuelve: GetTenantPackageResponse1

Ejemplo

Ejemplo getTenantPackage

Copy

async function fetchTenantPackage(): Promise<void> {
    const tenantId: string = "acme-tenant-2024";
    const packageId: string = "premium-package-01";
    const response: GetTenantPackageResponse1 = await getTenantPackage(tenantId, packageId);
    // Campos opcionales en la respuesta
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

Obtener paquetes de tenant

Parámetros

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

Respuesta

Devuelve: GetTenantPackagesResponse1

Ejemplo

Ejemplo getTenantPackages

Copy

(async () => {
  const tenantId: string = 'tenant_67890';
  const skip: number = 30;
  const packagesWithSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId, skip);
  const packagesWithoutSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId);
  console.log(packagesWithSkip, packagesWithoutSkip);
})();

Reemplazar paquete de tenant

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
id	string	Sí
replaceTenantPackageBody	ReplaceTenantPackageBody	Sí

Respuesta

Devuelve: ReplaceTenantPackageResponse

Ejemplo

Ejemplo replaceTenantPackage

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // campos de configuración personalizados aquí
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // configuración personalizada opcional
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

Actualizar paquete de tenant

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
id	string	Yes
updateTenantPackageBody	UpdateTenantPackageBody	Yes

Respuesta

Devuelve: UpdateTenantPackageResponse

Ejemplo

updateTenantPackage Ejemplo

Copy

const tenantId: string = "tenant-9876";
const packageId: string = "pkg-2023";
const customConfig: CustomConfigParameters = {
  enableSpamFilter: true,
  spamRatingThreshold: 4,
};
const updateBody: UpdateTenantPackageBody = {
  displayName: "Enterprise Pro",
  customConfig,
};
const response: UpdateTenantPackageResponse = await updateTenantPackage(
  tenantId,
  packageId,
  updateBody
);

Crear usuario de tenant

Parámetros

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

Respuesta

Devuelve: CreateTenantUserResponse1

Ejemplo

Ejemplo createTenantUser

Copy

const tenantId: string = "a1b2c3d4-5678-90ab-cdef-1234567890ab";
const newUser: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "admin",
  // parámetros opcionales
  phoneNumber: "+15551234567",
  isActive: true,
};
const result: CreateTenantUserResponse1 = await createTenantUser(tenantId, newUser);

Eliminar usuario de tenant

Parámetros

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

Respuesta

Devuelve: DeleteTenantUserResponse

Ejemplo

Ejemplo deleteTenantUser

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // Eliminar al usuario y todos sus comentarios, usando modo de eliminación dura
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // Eliminar al usuario sin eliminar los comentarios (comportamiento predeterminado)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

Obtener usuario de tenant

Parámetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Respuesta

Devuelve: GetTenantUserResponse1

Ejemplo

Ejemplo getTenantUser

Copy

async function fetchUser(): Promise<void> {
  const tenantId: string = "tenant-01a2b3c";
  const userId: string = "user-7890";
  const result: GetTenantUserResponse1 = await getTenantUser(tenantId, userId);
  console.log(result);
}

Obtener usuarios de tenant

Parámetros

Name	Type	Required	Description
tenantId	string	Sí
skip	number	No

Respuesta

Devuelve: GetTenantUsersResponse1

Ejemplo

Ejemplo getTenantUsers

Copy

(async () => {
  const tenantId: string = "tenant_9f7a2c";
  const skip: number = 25;
  const usersPage: GetTenantUsersResponse1 = await getTenantUsers(tenantId, skip);
  const allUsers: GetTenantUsersResponse1 = await getTenantUsers(tenantId);
})();

Reemplazar usuario de tenant

Parámetros

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

Respuesta

Devuelve: ReplaceTenantUserResponse

Ejemplo

replaceTenantUser Ejemplo

Copy

async function updateUser() {
  const tenantId: string = "c3d1f2e4-5b6a-4c7d-9f2e-1234567890ab";
  const userId: string = "u-654321";
  const replaceBody: ReplaceTenantUserBody = {
    email: "newuser@example.com",
    username: "newusername"
  };
  const response: ReplaceTenantUserResponse = await replaceTenantUser(
    tenantId,
    userId,
    replaceBody,
    "true"
  );
  console.log(response);
}
updateUser();

Enviar enlace de inicio de sesión

Parámetros

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

Respuesta

Devuelve: SendLoginLinkResponse

Ejemplo

Ejemplo de sendLoginLink

Copy

async function demoSendLoginLink() {
  const tenantId: string = "acme-corp";
  const userId: string = "user-9876";
  const redirectURL: string = "https://app.acme-corp.com/auth/callback";
  const resultWithRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId, redirectURL);
  const resultWithoutRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId);
}

Actualizar usuario de tenant

Parámetros

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

Respuesta

Devuelve: UpdateTenantUserResponse

Ejemplo

Ejemplo de updateTenantUser

Copy

let tenantId: string = "5f8f8c1a2e9b3c001c2a9b2d";
let userId: string = "user_98765";
let updateBody: UpdateTenantUserBody = {
  email: "jane.smith@example.com",
  role: "moderator",
  isActive: false,
};
let updateComments: string = "Deactivated user due to policy violation.";
let result: UpdateTenantUserResponse = await updateTenantUser(tenantId, userId, updateBody, updateComments);

Crear tenant

Parámetros

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

Respuesta

Devuelve: CreateTenantResponse1

Ejemplo

Ejemplo createTenant

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // campos requeridos
    name: 'Acme International',
    // los campos opcionales pueden añadirse según sea necesario, p. ej.:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

Eliminar tenant

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
id	string	Yes
sure	string	No

Respuesta

Devuelve: DeleteTenantResponse

Ejemplo

Ejemplo deleteTenant

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // Llamada con el parámetro opcional 'sure'
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // Llamada sin el parámetro opcional 'sure'
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

Obtener tenant

Parámetros

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

Respuesta

Devuelve: GetTenantResponse1

Ejemplo

Ejemplo getTenant

Copy

async function fetchTenant(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const id: string = "user_9876";
  const tenantInfo: GetTenantResponse1 = await getTenant(tenantId, id);
  console.log(tenantInfo);
}
fetchTenant();

Obtener tenants

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
meta	string	No
skip	number	No

Respuesta

Devuelve: GetTenantsResponse1

Ejemplo

Ejemplo getTenants

Copy

(async () => {
  const tenantId: string = "tenant-9f8e7d6c";
  const resultOnlyId: GetTenantsResponse1 = await getTenants(tenantId);
  const resultWithMeta: GetTenantsResponse1 = await getTenants(tenantId, "full");
  const resultAllParams: GetTenantsResponse1 = await getTenants(tenantId, "full", 15);
  console.log(resultOnlyId, resultWithMeta, resultAllParams);
})();

Actualizar tenant

Parámetros

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

Respuesta

Devuelve: UpdateTenantResponse

Ejemplo

Ejemplo de updateTenant

Copy

const tenantId: string = "c8f9e3d2-4b6a-11ee-8c99-0242ac130003";
const id: string = "tenant-config-01";
const updateBody: UpdateTenantBody = {
  domain: "mytenant.fastcomments.io",
  branding: {
    logoUrl: "https://cdn.mytenant.com/assets/logo.png"
  },
  description: "Branding update for Q3"
};
const response: UpdateTenantResponse = await updateTenant(tenantId, id, updateBody);
console.log(response);

Cambiar estado del ticket

Parámetros

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

Respuesta

Devuelve: ChangeTicketStateResponse1

Ejemplo

Ejemplo de changeTicketState

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // campo opcional en el cuerpo
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

Crear ticket

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

Respuesta

Devuelve: CreateTicketResponse1

Ejemplo

Ejemplo de createTicket

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string es opcional y se omite
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// Ejemplo de uso de un campo opcional de la respuesta
// console.log(response.ticket?.id);

Obtener ticket

Parámetros

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

Respuesta

Devuelve: GetTicketResponse1

Ejemplo

Ejemplo getTicket

Copy

const tenantId: string = "acme-inc";
const ticketId: string = "ticket-3421";
const userId: string = "alice.smith";
const ticketWithUser: GetTicketResponse1 = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicketResponse1 = await getTicket(tenantId, ticketId);

Obtener tickets

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
userId	string	No
state	number	No
skip	number	No
limit	number	No

Respuesta

Devuelve: GetTicketsResponse1

Ejemplo

Ejemplo getTickets

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // p.ej., cerrado
  const skip: number = 10;
  const limit: number = 5;
  const ticketsFull: GetTicketsResponse1 = await getTickets(tenantId, userId, state, skip, limit);
  const ticketsPartial: GetTicketsResponse1 = await getTickets(tenantId);
}
loadTickets();

Obtener traducciones

Parámetros

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

Respuesta

Devuelve: GetTranslationsResponse1

Ejemplo

Ejemplo de getTranslations

Copy

(async () => {
  const namespace: string = 'blog';
  const component: string = 'comment-editor';
  const locale: string = 'fr-FR';
  const useFullTranslationIds: boolean = true;
  const basicTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component);
  const fullTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component, locale, useFullTranslationIds);
})();

Subir imagen

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

Obtener progreso de insignia de usuario por ID

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressByIdResponse

Ejemplo

Ejemplo getUserBadgeProgressById

Copy

async function demo(): Promise<void> {
    const tenantId: string = "acme-corp";
    const userId: string = "user-42";
    const result: GetUserBadgeProgressByIdResponse = await getUserBadgeProgressById(tenantId, userId);
    const progress: UserBadgeProgress | undefined = result.progress;
    const earnedAt: Date | undefined = progress?.earnedAt;
    console.log(`Badge earned at: ${earnedAt?.toISOString() ?? "not earned yet"}`);
}
demo();

Obtener progreso de insignia por ID de usuario

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressByUserIdResponse

Ejemplo

getUserBadgeProgressByUserId Ejemplo

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "user-12345";
  const badgeProgress: GetUserBadgeProgressByUserIdResponse = await getUserBadgeProgressByUserId(tenantId, userId);
  console.log(badgeProgress);
})();

Obtener lista de progreso de insignias de usuario

Parámetros

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

Respuesta

Devuelve: GetUserBadgeProgressListResponse

Ejemplo

getUserBadgeProgressList Ejemplo

Copy

async function fetchBadgeProgress() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe@example.com";
  const limit: number = 10;
  const skip: number = 5;
  const fullList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(
    tenantId,
    userId,
    limit,
    skip
  );
  const simpleList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(tenantId);
}
fetchBadgeProgress();

Crear insignia de usuario

Parámetros

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

Respuesta

Devuelve: CreateUserBadgeResponse

Ejemplo

Ejemplo de createUserBadge

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // la descripción es opcional y se omite aquí
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

Eliminar insignia de usuario

Parámetros

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

Respuesta

Devuelve: DeleteUserBadgeResponse

Ejemplo

deleteUserBadge Ejemplo

Copy

async function exampleDeleteBadge(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6a";
  const badgeId: string = "badge_4e3d2c1b";
  const result: DeleteUserBadgeResponse = await deleteUserBadge(tenantId, badgeId);
  console.log(result);
}
exampleDeleteBadge();

Obtener insignia de usuario

Parámetros

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

Respuesta

Devuelve: GetUserBadgeResponse

Ejemplo

Ejemplo de getUserBadge

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-001";
  const badgeId: string = "badge-5f9d3a2b";
  const badgeResponse: GetUserBadgeResponse = await getUserBadge(tenantId, badgeId);
  // Acceder de forma segura a los campos opcionales
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

Obtener insignias de usuario

Parámetros

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

Respuesta

Devuelve: GetUserBadgesResponse

Ejemplo

getUserBadges Ejemplo

Copy

async function example() {
  const tenantId: string = "tenant-01";
  const userId: string = "user-42";
  const badgeId: string = "badge-gold";
  const type: number = 1;
  const displayedOnComments: boolean = true;
  const limit: number = 10;
  const skip: number = 5;
  const fullResult: GetUserBadgesResponse = await getUserBadges(
    tenantId,
    userId,
    badgeId,
    type,
    displayedOnComments,
    limit,
    skip
  );
  const minimalResult: GetUserBadgesResponse = await getUserBadges(tenantId);
}
example();

Actualizar insignia de usuario

Parámetros

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

Respuesta

Devuelve: UpdateUserBadgeResponse

Ejemplo

Ejemplo de updateUserBadge

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // ejemplo de campo opcional
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

Obtener conteo de notificaciones de usuario

Parámetros

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

Respuesta

Devuelve: GetUserNotificationCountResponse1

Ejemplo

Ejemplo de getUserNotificationCount

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // Llamar con token SSO opcional
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // Llamar sin token SSO
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

Obtener notificaciones de usuario

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Sí
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: GetUserNotificationsResponse

Ejemplo

Ejemplo getUserNotifications

Copy

async function fetchUserNotifications() {
    const tenantId: string = "tenant_9f4b2c";
    const urlId: string = "post_1234";
    const pageSize: number = 25;
    const afterId: string = "notif_5678";
    const includeContext: boolean = true;
    const unreadOnly: boolean = false;
    const dmOnly: boolean = false;
    const includeTranslations: boolean = true;
    const notifications: GetUserNotificationsResponse = await getUserNotifications(
        tenantId,
        urlId,
        pageSize,
        afterId,
        includeContext,
        undefined,
        unreadOnly,
        dmOnly,
        undefined,
        includeTranslations,
        undefined,
        undefined
    );
    console.log(notifications);
}

Restablecer conteo de notificaciones de usuario

Parameters

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

Response

Devuelve: ResetUserNotificationCountResponse

Example

Ejemplo de resetUserNotificationCount

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // Llamada con el parámetro sso opcional
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // Llamada sin el parámetro sso opcional
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

Restablecer notificaciones de usuario

Parámetros

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

Respuesta

Devuelve: ResetUserNotificationsResponse1

Ejemplo

resetUserNotifications Ejemplo

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // ejemplo de marca de tiempo UNIX
  const unreadOnly: boolean = true;
  const dmOnly: boolean = false;
  const noDm: boolean = false;
  const sso: string = "sso-token-xyz";
  const result: ResetUserNotificationsResponse1 = await resetUserNotifications(
    tenantId,
    afterId,
    afterCreatedAt,
    unreadOnly,
    dmOnly,
    noDm,
    sso
  );
  console.log(result);
})();

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

Enable or disable notifications for a specific comment.

Parámetros

Nombre	Tipo	Obligatorio
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Respuesta

Devuelve: UpdateUserNotificationCommentSubscriptionStatusResponse

Ejemplo

updateUserNotificationCommentSubscriptionStatus Ejemplo

Copy

const tenantId: string = "tenant_12345";
const notificationId: string = "notif_9876";
const commentId: string = "comment_abc123";
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum =
  UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = "ssoTokenXYZ";
const responseWithSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId,
    sso
  );
const responseWithoutSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId
  );

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

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

Parámetros

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

Respuesta

Devuelve: UpdateUserNotificationPageSubscriptionStatusResponse

Ejemplo

Ejemplo de updateUserNotificationPageSubscriptionStatus

Copy

(async () => {
  const tenantId: string = "tenant-2024";
  const urlId: string = "page-5678";
  const url: string = "https://example.com/articles/typescript-tips";
  const pageTitle: string = "Top TypeScript Tips";
  const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
    UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
  const sso: string = "sso-token-xyz";
  const resultWithSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed,
    sso
  );
  const resultWithoutSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed
  );
})();

Actualizar estado de notificación de usuario

Parámetros

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
newStatus	UpdateUserNotificationStatusNewStatusEnum	Yes
sso	string	No

Respuesta

Devuelve: UpdateUserNotificationStatusResponse

Ejemplo

Ejemplo de updateUserNotificationStatus

Copy

const tenantId: string = "acme-corp";
const notificationId: string = "notif-20231101-001";
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Dismissed;
const ssoToken: string = "sso-9f8e7d6c5b4a";
const result: UpdateUserNotificationStatusResponse = await updateUserNotificationStatus(
  tenantId,
  notificationId,
  newStatus,
  ssoToken
);

Obtener estados de presencia de usuario

Parámetros

Nombre	Tipo	Requerido
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

Respuesta

Devuelve: GetUserPresenceStatusesResponse1

Ejemplo

Ejemplo getUserPresenceStatuses

Copy

async function fetchUserPresences() {
  const tenantId: string = "tenant_9f8e2d";
  const urlIdWS: string = "blog.mycompany.com/thread/12345";
  const userIds: string = "alice,bob,carol";
  const result: GetUserPresenceStatusesResponse1 = await getUserPresenceStatuses(
    tenantId,
    urlIdWS,
    userIds
  );
  console.log(result);
}

Buscar usuarios

Parámetros

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

Respuesta

Devuelve: SearchUsersResponse1

Ejemplo

Ejemplo de searchUsers

Copy

async function demoSearch(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "article-9876";
    const usernameStartsWith: string = "john";
    const mentionGroupIds: string[] = ["groupA", "groupB"];
    const sso: string = "sso_abc123";
    const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Users;
    const response: SearchUsersResponse1 = await searchUsers(
        tenantId,
        urlId,
        usernameStartsWith,
        mentionGroupIds,
        sso,
        searchSection
    );
    console.log(response);
}
demoSearch();

Obtener usuario

Parámetros

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

Respuesta

Devuelve: GetUserResponse1

Ejemplo

Ejemplo getUser

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_98765";
  const result: GetUserResponse1 = await getUser(tenantId, userId);
})();

Crear voto

Parámetros

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

Respuesta

Devuelve: CreateVoteResponse

Ejemplo

Ejemplo createVote

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "comment_987654";
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Upvote;
const userId: string = "user_7f9a2b";
const voteResult: CreateVoteResponse = await createVote(
  tenantId,
  commentId,
  direction,
  userId
);

Eliminar voto

Parámetros

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

Respuesta

Devuelve: DeleteVoteResponse

Ejemplo

Ejemplo de deleteVote

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-9876";
  const editKey: string = "edit-key-123";
  const resultWithEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId, editKey);
  const resultWithoutEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId);
})();

Obtener votos

Parámetros

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

Respuesta

Devuelve: GetVotesResponse1

Ejemplo

Ejemplo getVotes

Copy

async function fetchVotes(): Promise<void> {
  const tenantId: string = "acme-corp-01";
  const urlId: string = "article-2024-05-15";
  const response: GetVotesResponse1 = await getVotes(tenantId, urlId);
  // Ejemplo de acceso a un campo opcional en la respuesta
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

Obtener votos para usuario

Parámetros

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

Respuesta

Devuelve: GetVotesForUserResponse1

Ejemplo

Ejemplo getVotesForUser

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const urlId: string = "post-9f8b7c";
  const userId: string = "user-42";
  const anonUserId: string = "anon-123";
  const votesRequiredOnly: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId);
  const votesWithUserId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, userId);
  const votesWithAnonId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, undefined, anonUserId);
}
demo();

¿Necesitas ayuda?

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

Contribuciones

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

Idioma 🇪🇸 Español

Primeros pasos

Referencia de la API

Documentación

Uso

Agregación

Registros de auditoría

Bloquear desde comentario

Comprobar comentarios bloqueados

Comentarios

Comentarios para usuario

Configuraciones de dominio

Plantillas de correo

Registro de eventos

Publicaciones de feed

Marcar comentario

Gifs

Hashtags

Moderación

Moderadores

Conteo de notificaciones

Notificaciones

Reacciones de página

Páginas

Eventos webhook pendientes

Configuraciones de preguntas

Resultados de preguntas

Agregación de resultados de preguntas

Usuarios SSO

Suscripciones

Uso diario del tenant

Paquetes de tenant

Usuarios de tenant

Tenants

Tickets

Traducciones

Subir imagen

Progreso de insignias de usuario

Insignias de usuario

Notificaciones de usuario

Estado de presencia de usuario

Búsqueda de usuarios

Usuarios

Votos

SDK de FastComments para JavaScript/TypeScript

Repositorio

Instalación

Documentación de la API

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

Compatibilidad navegador vs servidor

Uso

Browser Usage (Client-Side)

Server Usage (Node.js)

Types Only Import

Using Individual API Classes

Browser Environment

Server Environment

APIs públicas vs seguras

Ejemplo: Uso de la API pública (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

Suscribirse a eventos de usuario

Obtener userIdWS

IDs de transmisión

Manejo de errores

Agregación

Parámetros

Respuesta