FastComments JavaScript/TypeScript SDK

Este é o SDK oficial JavaScript/TypeScript para o FastComments.

SDK oficial JavaScript/TypeScript para a API do FastComments

Repositório

Instalação

npm install fastcomments-sdk

Documentação da API

Referência completa da API: docs/api/README.md

Compatibilidade Navegador vs Servidor

Este SDK usa dois pontos de entrada para garantir compatibilidade ideal e prevenir erros em tempo de execução:

fastcomments-sdk/browser - Versão segura para navegador com fetch nativo
fastcomments-sdk/server - Versão completa para Node.js com suporte a SSO
fastcomments-sdk (padrão) - Apenas tipos, seguro para importar em qualquer lugar

Uso

Este SDK fornece pontos de entrada separados para ambientes de navegador e servidor para garantir compatibilidade e segurança ideais:

Uso no Navegador (Lado do Cliente)

Para aplicações de frontend/navegador, use a exportação segura para navegador que exclui dependências do Node.js:

// Import seguro para navegador (sem dependências do Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Criar instância do SDK para navegador
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // opcional, padrão https://fastcomments.com
});

// Usar APIs públicas (sem necessidade de chave de API - seguro para navegadores)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Uso no Servidor (Node.js)

Para aplicações de servidor/backend, use o SDK completo com recursos de SSO e autenticação:

// Import para servidor (inclui SSO e foi projetado para funcionar com NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Criar instância do SDK para servidor
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Mantenha isto em segredo no servidor!
  basePath: 'https://fastcomments.com' // opcional, padrão https://fastcomments.com
});

// Use APIs seguras com sua chave de API
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Import apenas de Tipos

Se você precisa apenas dos tipos TypeScript (sem código em tempo de execução), use o import padrão:

// Somente tipos (sem dependências em tempo de execução - seguro em qualquer lugar)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Usando Classes de API Individuais

Ambiente do Navegador

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

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

const publicApi = new PublicApi(config);

Ambiente do Servidor

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

O SDK fornece três classes principais de API:

DefaultApi - Endpoints protegidos que exigem sua chave de API para autenticação. Use-os para operações do lado do servidor.
PublicApi - Endpoints públicos que podem ser acessados sem uma chave de API. Podem ser chamados diretamente de navegadores/dispositivos móveis/etc.
HiddenApi - Endpoints internos/administrador para casos de uso avançados.

Exemplo: Usando a `PublicApi` (seguro para navegador)

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

const publicApi = new PublicApi();

// Obter comentários de uma página (sem necessidade de chave de API)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Exemplo: Usando a `DefaultApi` (somente no servidor)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Mantenha esta chave em segredo!
});
const defaultApi = new DefaultApi(config);

// Obter comentários com acesso administrativo completo
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Integração SSO (Single Sign-On)

FastComments oferece suporte a SSO para integrar com seu sistema de autenticação de usuários existente. A funcionalidade SSO está disponível apenas na exportação do servidor já que requer recursos de crypto do Node.js.

SSO Simples (Apenas no Lado do Servidor)

O SSO simples deve ser gerado no servidor e enviado ao cliente:

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

// Crie um SSO simples usando o helper embutido  
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();

// Envie ssoToken para o código do cliente
// O código do lado do cliente pode então usar este token com o SDK para navegador

SSO Seguro (Lado do Servidor, Recomendado)

O SSO seguro deve ser implementado no servidor e oferece maior segurança:

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

// Crie um SSO seguro usando o helper embutido
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();

// Use com chamadas de API no servidor
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Ou envie ssoConfig para o cliente para uso no navegador

Usando SSO a partir do Navegador (com Token Gerado pelo Servidor)

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

// Obtenha o token SSO do endpoint do seu 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 // Use o token SSO gerado no servidor
});

SSO com Criação de Comentário

// Lado do servidor: Crie SSO e comentário
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 Comuns

Obtendo Comentários de uma Página

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

Criando um Comentário

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

Votando em um Comentário

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

Gerenciamento de Usuários (Requer Chave de API)

// Pesquisar usuários (requer DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Eventos ao Vivo (Atualizações em Tempo Real)

Inscreva-se em eventos ao vivo para receber atualizações em tempo real sobre comentários, votos e outras atividades.

Eventos por página

Ouça eventos ao vivo em uma página específica (comentários, votos, etc.):

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

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

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

Inscreva-se em eventos do usuário

Ouça eventos específicos do usuário (notificações, menções, etc.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Show notification in your 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');
  }
);

// Close when done
userSubscription.close();

Obtendo userIdWS

O parâmetro userIdWS é necessário para eventos ao vivo e pode ser obtido nas respostas da API:

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

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

IDs de Transmissão

Você verá que deve passar um broadcastId em algumas chamadas de API. Quando você receber eventos, receberá esse ID de volta, então saberá ignorar o evento se planejar aplicar mudanças de forma otimista no cliente (o que você provavelmente desejará fazer, pois oferece a melhor experiência). Passe um UUID aqui. O ID deve ser suficientemente único para não ocorrer duas vezes em uma sessão do 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 operação
  }
});

Tratamento de Erros

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

aggregate

Agrega documentos agrupando-os (se groupBy for fornecido) e aplicando múltiplas operações. Diferentes operações (por exemplo, sum, countDistinct, avg, etc.) são suportadas.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
aggregationRequest	AggregationRequest	Sim
parentTenantId	string	Não
includeStats	boolean	Não

Resposta

Retorna: AggregationResponse

getAuditLogs

Parâmetros

Name	Type	Required
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Resposta

Retorna: GetAuditLogs200Response

Exemplo

Exemplo de getAuditLogs

Copy

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

blockFromCommentPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
publicBlockFromCommentParams	PublicBlockFromCommentParams	Sim
sso	string	Não

Resposta

Retorna: BlockFromCommentPublic200Response

Exemplo

Exemplo de blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parâmetros

Name	Type	Required
tenantId	string	Sim
commentId	string	Sim
publicBlockFromCommentParams	PublicBlockFromCommentParams	Sim
sso	string	Não

Resposta

Retorna: UnBlockCommentPublic200Response

Exemplo

Exemplo de unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentIds	string	Sim
sso	string	Não

Resposta

Retorna: CheckedCommentsForBlocked200Response

Exemplo

Exemplo de checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
blockFromCommentParams	BlockFromCommentParams	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: BlockFromCommentPublic200Response

Exemplo

Exemplo de blockUserFromComment

Copy

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

createCommentPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
broadcastId	string	Sim
commentData	CommentData	Sim
sessionId	string	Não
sso	string	Não

Resposta

Retorna: CreateCommentPublic200Response

Exemplo

Exemplo de createCommentPublic

Copy

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

deleteComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
contextUserId	string	Não
isLive	boolean	Não

Resposta

Retorna: DeleteComment200Response

Exemplo

Exemplo de deleteComment

Copy

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

deleteCommentPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
editKey	string	Não
sso	string	Não

Resposta

Retorna: DeleteCommentPublic200Response

Exemplo

Exemplo de deleteCommentPublic

Copy

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

deleteCommentVote

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
voteId	string	Sim
urlId	string	Sim
broadcastId	string	Sim
editKey	string	Não
sso	string	Não

Resposta

Retorna: DeleteCommentVote200Response

Exemplo

Exemplo de deleteCommentVote

Copy

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

flagComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: FlagComment200Response

Exemplo

Exemplo de flagComment

Copy

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

getComment

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetComment200Response

Exemplo

Exemplo de getComment

Copy

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

getComments

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
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

Resposta

Retorna: GetComments200Response

Exemplo

Exemplo de getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // page
  20, // limit
  0, // skip
  true, // asTree
  1, // skipChildren
  3, // limitChildren
  4, // maxTreeDepth
  'articles/2026/new-product-launch', // urlId
  'user_7890', // userId
  'anon_4f3b2', // anonUserId
  undefined, // contextUserId
  '#launch', // hashTag
  undefined // parentId
);

getCommentsPublic

req tenantId urlId

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
page	number	Não
direction	SortDirections	Não
sso	string	Não
skip	number	Não
skipChildren	number	Não
limit	number	Não
limitChildren	number	Não
countChildren	boolean	Não
fetchPageForCommentId	string	Não
includeConfig	boolean	Não
countAll	boolean	Não
includei10n	boolean	Não
locale	string	Não
modules	string	Não
isCrawler	boolean	Não
includeNotificationCount	boolean	Não
asTree	boolean	Não
maxTreeDepth	number	Não
useFullTranslationIds	boolean	Não
parentId	string	Não
searchText	string	Não
hashTags	Array	Não
userId	string	Não
customConfigStr	string	Não
afterCommentId	string	Não
beforeCommentId	string	Não

Resposta

Retorna: GetCommentsPublic200Response

Exemplo

Exemplo de getCommentsPublic

Copy

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

getCommentText

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
editKey	string	Não
sso	string	Não

Resposta

Retorna: GetCommentText200Response

Exemplo

Exemplo de getCommentText

Copy

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

getCommentVoteUserNames

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
dir	number	Sim
sso	string	Não

Resposta

Retorna: GetCommentVoteUserNames200Response

Exemplo

Exemplo de getCommentVoteUserNames

Copy

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

lockComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
sso	string	Não

Resposta

Retorna: LockComment200Response

Exemplo

Exemplo de lockComment

Copy

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

pinComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
sso	string	Não

Resposta

Retorna: PinComment200Response

Exemplo

Exemplo de pinComment

Copy

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

saveComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createCommentParams	CreateCommentParams	Sim
isLive	boolean	Não
doSpamCheck	boolean	Não
sendEmails	boolean	Não
populateNotifications	boolean	Não

Resposta

Retorna: SaveComment200Response

Exemplo

Exemplo de saveComment

Copy

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

saveCommentsBulk

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createCommentParams	Array	Sim
isLive	boolean	Não
doSpamCheck	boolean	Não
sendEmails	boolean	Não
populateNotifications	boolean	Não

Resposta

Retorna: Array<SaveComment200Response

Exemplo

Exemplo de saveCommentsBulk

Copy

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

setCommentText

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
commentTextUpdateRequest	CommentTextUpdateRequest	Sim
editKey	string	Não
sso	string	Não

Resposta

Retorna: SetCommentText200Response

Exemplo

Exemplo de setCommentText

Copy

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

unBlockUserFromComment

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
unBlockFromCommentParams	UnBlockFromCommentParams	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: UnBlockCommentPublic200Response

Exemplo

Exemplo unBlockUserFromComment

Copy

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

unFlagComment

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: FlagComment200Response

Exemplo

Exemplo de unFlagComment

Copy

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

unLockComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Resposta

Retorna: LockComment200Response

Exemplo

Exemplo de unLockComment

Copy

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

unPinComment

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
sso	string	Não

Resposta

Retorna: PinComment200Response

Exemplo

Exemplo de unPinComment

Copy

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

updateComment

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
updatableCommentParams	UpdatableCommentParams	Sim
contextUserId	string	Não
doSpamCheck	boolean	Não
isLive	boolean	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateComment

Copy

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

voteComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
urlId	string	Sim
broadcastId	string	Sim
voteBodyParams	VoteBodyParams	Sim
sessionId	string	Não
sso	string	Não

Resposta

Retorna: VoteComment200Response

Exemplo

Exemplo de voteComment

Copy

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

addDomainConfig

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
addDomainConfigParams	AddDomainConfigParams	Sim

Resposta

Retorna: AddDomainConfig200Response

deleteDomainConfig

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
domain	string	Sim

Resposta

Retorna: DeleteDomainConfig200Response

getDomainConfig

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
domain	string	Sim

Resposta

Retorna: GetDomainConfig200Response

getDomainConfigs

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim

Resposta

Retorna: GetDomainConfigs200Response

patchDomainConfig

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
domainToUpdate	string	Sim
patchDomainConfigParams	PatchDomainConfigParams	Sim

Resposta

Retorna: GetDomainConfig200Response

putDomainConfig

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
domainToUpdate	string	Sim
updateDomainConfigParams	UpdateDomainConfigParams	Sim

Resposta

Retorna: GetDomainConfig200Response

createEmailTemplate

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createEmailTemplateBody	CreateEmailTemplateBody	Sim

Resposta

Retorna: CreateEmailTemplate200Response

Exemplo

Exemplo de createEmailTemplate

Copy

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

deleteEmailTemplate

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
errorId	string	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetEmailTemplate200Response

Exemplo

Exemplo de getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim

Resposta

Retorna: GetEmailTemplateDefinitions200Response

Exemplo

Exemplo de getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
skip	number	Não

Resposta

Retorna: GetEmailTemplateRenderErrors200Response

Exemplo

Exemplo de getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	number	Não

Resposta

Retorna: GetEmailTemplates200Response

Exemplo

Exemplo de getEmailTemplates

Copy

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

renderEmailTemplate

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
renderEmailTemplateBody	RenderEmailTemplateBody	Sim
locale	string	Não

Resposta

Retorna: RenderEmailTemplate200Response

Exemplo

Exemplo de renderEmailTemplate

Copy

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

updateEmailTemplate

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateEmailTemplateBody	UpdateEmailTemplateBody	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Sim
startTime	number	Sim
endTime	number	Sim

Resposta

Retorna: GetEventLog200Response

Exemplo

Exemplo de getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Sim
startTime	number	Sim
endTime	number	Sim

Resposta

Retorna: GetEventLog200Response

Exemplo

Exemplo de getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 dias atrás
const endTimeOptional: number | undefined = undefined; // fim opcional do intervalo de tempo
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createFeedPostParams	CreateFeedPostParams	Sim
broadcastId	string	Não
isLive	boolean	Não
doSpamCheck	boolean	Não
skipDupCheck	boolean	Não

Resposta

Retorna: CreateFeedPost200Response

Exemplo

Exemplo de createFeedPost

Copy

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

createFeedPostPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
createFeedPostParams	CreateFeedPostParams	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: CreateFeedPostPublic200Response

Exemplo

Exemplo de createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: DeleteFeedPostPublic200Response

Exemplo

Exemplo de deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parâmetros

Name	Type	Required
tenantId	string	Sim
afterId	string	Não
limit	number	Não
tags	Array	Não

Resposta

Retorna: GetFeedPosts200Response

Exemplo

Exemplo de getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parâmetros

Name	Type	Required
tenantId	string	Sim
afterId	string	Não
limit	number	Não
tags	Array	Não
sso	string	Não
isCrawler	boolean	Não
includeUserInfo	boolean	Não

Resposta

Retorna: GetFeedPostsPublic200Response

Exemplo

Exemplo de getFeedPostsPublic

Copy

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

getFeedPostsStats

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
postIds	Array	Sim
sso	string	Não

Resposta

Retorna: GetFeedPostsStats200Response

Exemplo

Exemplo de getFeedPostsStats

Copy

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

getUserReactsPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postIds	Array	Não
sso	string	Não

Resposta

Retorna: GetUserReactsPublic200Response

Exemplo

Exemplo de getUserReactsPublic

Copy

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

reactFeedPostPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
sso	string	No

Resposta

Retorna: ReactFeedPostPublic200Response

Exemplo

Exemplo de reactFeedPostPublic

Copy

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

updateFeedPost

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateFeedPost

Copy

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

updateFeedPostPublic

Parâmetros

Name	Type	Required
tenantId	string	Sim
postId	string	Sim
updateFeedPostParams	UpdateFeedPostParams	Sim
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: CreateFeedPostPublic200Response

Exemplo

Exemplo de updateFeedPostPublic

Copy

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

flagCommentPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
isFlagged	boolean	Sim
sso	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de flagCommentPublic

Copy

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

addHashTag

Parâmetros

Name	Type	Required	Description
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Resposta

Retorna: AddHashTag200Response

Exemplo

Exemplo de addHashTag

Copy

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

addHashTagsBulk

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Não
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Não

Resposta

Retorna: AddHashTagsBulk200Response

Exemplo

Exemplo de addHashTagsBulk

Copy

// Cria identificador do tenant (parâmetro opcional)
const tenantId: string = "tenant_9f8c2b7a";
// Prepara entradas individuais de tags
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Corpo para criação em lote (parâmetro opcional)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Chama a função assíncrona global e atribui o resultado tipado
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

deleteHashTag

Parâmetros

Nome	Tipo	Obrigatório
tag	string	Sim
tenantId	string	Não
deleteHashTagRequest	DeleteHashTagRequest	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteHashTag

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_12345";
const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

getHashTags

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
page	number	Não

Resposta

Retorna: GetHashTags200Response

Exemplo

Exemplo de getHashTags

Copy

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

patchHashTag

Parâmetros

Nome	Tipo	Obrigatório
tag	string	Sim
tenantId	string	Não
updateHashTagBody	UpdateHashTagBody	Não

Resposta

Retorna: PatchHashTag200Response

Exemplo

Exemplo de patchHashTag

Copy

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

createModerator

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createModeratorBody	CreateModeratorBody	Sim

Resposta

Retorna: CreateModerator200Response

Exemplo

Exemplo de createModerator

Copy

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

deleteModerator

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
sendEmail	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteModerator

Copy

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

getModerator

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetModerator200Response

Exemplo

Exemplo de getModerator

Copy

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

getModerators

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	number	Não

Resposta

Retorna: GetModerators200Response

Exemplo

Exemplo de getModerators

Copy

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

sendInvite

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	Yes
fromName	string	Yes

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de sendInvite

Copy

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

updateModerator

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
updateModeratorBody	UpdateModeratorBody	Sim

Response

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateModerator

Copy

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

deleteNotificationCount

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteNotificationCount

Copy

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

getCachedNotificationCount

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetCachedNotificationCount200Response

Exemplo

Exemplo de getCachedNotificationCount

Copy

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

getNotificationCount

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
urlId	string	Não
fromCommentId	string	Não
viewed	boolean	Não
type	string	Não

Resposta

Retorna: GetNotificationCount200Response

Exemplo

Exemplo de getNotificationCount

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

getNotifications

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
urlId	string	Não
fromCommentId	string	Não
viewed	boolean	Não
type	string	Não
skip	number	Não

Resposta

Retorna: GetNotifications200Response

Exemplo

Exemplo de getNotifications

Copy

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

updateNotification

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateNotificationBody	UpdateNotificationBody	Sim
userId	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateNotification

Copy

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

addPage

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createAPIPageData	CreateAPIPageData	Sim

Resposta

Retorna: AddPageAPIResponse

deletePage

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: DeletePageAPIResponse

getPageByURLId

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
urlId	string	Sim

Resposta

Retorna: GetPageByURLIdAPIResponse

getPages

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim

Resposta

Retorna: GetPagesAPIResponse

patchPage

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
updateAPIPageData	UpdateAPIPageData	Sim

Resposta

Retorna: PatchPageAPIResponse

deletePendingWebhookEvent

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Yes
id	string	Yes

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deletePendingWebhookEvent

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // exemplo de parâmetro opcional (não exigido pela função)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Não
externalId	string	Não
eventType	string	Não
type	string	Não
domain	string	Não
attemptCountGT	number	Não

Resposta

Retorna: GetPendingWebhookEventCount200Response

Exemplo

Exemplo de getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Não
externalId	string	Não
eventType	string	Não
type	string	Não
domain	string	Não
attemptCountGT	number	Não
skip	number	Não

Resposta

Retorna: GetPendingWebhookEvents200Response

Exemplo

Exemplo de getPendingWebhookEvents

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createQuestionConfigBody	CreateQuestionConfigBody	Sim

Resposta

Retorna: CreateQuestionConfig200Response

Exemplo

Exemplo de createQuestionConfig

Copy

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

deleteQuestionConfig

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteQuestionConfig

Copy

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

getQuestionConfig

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetQuestionConfig200Response

Exemplo

Exemplo de getQuestionConfig

Copy

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

getQuestionConfigs

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	number	Não

Resposta

Retorna: GetQuestionConfigs200Response

Exemplo

Exemplo de getQuestionConfigs

Copy

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

updateQuestionConfig

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateQuestionConfig

Copy

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

createQuestionResult

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

Resposta

Retorna: CreateQuestionResult200Response

Exemplo

Exemplo de createQuestionResult

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // metadados opcionais
  note: "Follow-up requested" // parâmetro opcional demonstrado
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteQuestionResult

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // parâmetro opcional demonstrando seleção alternativa de destino
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

getQuestionResult

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetQuestionResult200Response

Exemplo

Exemplo de getQuestionResult

Copy

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

getQuestionResults

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Não
userId	string	Não
startDate	string	Não
questionId	string	Não
questionIds	string	Não
skip	number	Não

Resposta

Retorna: GetQuestionResults200Response

Exemplo

Exemplo de getQuestionResults

Copy

const tenantId: string = "tenant_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

updateQuestionResult

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
updateQuestionResultBody	UpdateQuestionResultBody	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateQuestionResult

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // metadados opcionais
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parâmetros

Nome	Type	Obrigatório
tenantId	string	Sim
questionId	string	Não
questionIds	Array	Não
urlId	string	Não
timeBucket	AggregateTimeBucket	Não
startDate	Date	Não
forceRecalculate	boolean	Não

Resposta

Retorna: AggregateQuestionResults200Response

Exemplo

Exemplo de aggregateQuestionResults

Copy

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

bulkAggregateQuestionResults

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Sim
forceRecalculate	boolean	Não

Resposta

Retorna: BulkAggregateQuestionResults200Response

Exemplo

Exemplo de bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
questionId	string	Não
questionIds	Array	Não
urlId	string	Não
startDate	Date	Não
forceRecalculate	boolean	Não
minValue	number	Não
maxValue	number	Não
limit	number	Não

Resposta

Retorna: CombineCommentsWithQuestionResults200Response

Exemplo

Exemplo de combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createAPISSOUserData	CreateAPISSOUserData	Sim

Resposta

Retorna: AddSSOUserAPIResponse

deleteSSOUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
deleteComments	boolean	Não
commentDeleteMode	string	Não

Resposta

Retorna: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
email	string	Sim

Resposta

Retorna: GetSSOUserByEmailAPIResponse

getSSOUserById

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetSSOUserByIdAPIResponse

getSSOUsers

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	number	Não

Resposta

Retorna: GetSSOUsers200Response

patchSSOUser

Parâmetros

Name	Type	Obrigatório
tenantId	string	Sim
id	string	Sim
updateAPISSOUserData	UpdateAPISSOUserData	Sim
updateComments	boolean	Não

Resposta

Retorna: PatchSSOUserAPIResponse

putSSOUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateAPISSOUserData	UpdateAPISSOUserData	Sim
updateComments	boolean	Não

Resposta

Retorna: PutSSOUserAPIResponse

createSubscription

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Sim

Resposta

Retorna: CreateSubscriptionAPIResponse

Exemplo

Exemplo de createSubscription

Copy

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

deleteSubscription

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
userId	string	Não

Resposta

Retorna: DeleteSubscriptionAPIResponse

getSubscriptions

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
userId	string	Não

Resposta

Retorna: GetSubscriptionsAPIResponse

Exemplo

Exemplo de getSubscriptions

Copy

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

updateSubscription

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Sim
userId	string	Não

Resposta

Retorna: UpdateSubscriptionAPIResponse

Exemplo

Exemplo de updateSubscription

Copy

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

getTenantDailyUsages

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
yearNumber	number	Não
monthNumber	number	Não
dayNumber	number	Não
skip	number	Não

Resposta

Retorna: GetTenantDailyUsages200Response

Exemplo

Exemplo de getTenantDailyUsages

Copy

const tenantId: string = 'tenant_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

createTenantPackage

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createTenantPackageBody	CreateTenantPackageBody	Sim

Resposta

Retorna: CreateTenantPackage200Response

Exemplo

Exemplo de createTenantPackage

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // parâmetro opcional fornecido
  // campos opcionais omitidos: por exemplo, regras de moderação avançadas, CSS personalizado
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // valor ilustrativo; usa a forma CustomConfigParameters
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteTenantPackage

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // optional parameters demonstrated
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetTenantPackage200Response

Exemplo

Exemplo de getTenantPackage

Copy

const tenantId: string = 'tenant_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	number	Não

Resposta

Retorna: GetTenantPackages200Response

Exemplo

Exemplo de getTenantPackages

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

replaceTenantPackage

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
replaceTenantPackageBody	ReplaceTenantPackageBody	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de replaceTenantPackage

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

updateTenantPackage

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateTenantPackageBody	UpdateTenantPackageBody	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // campos opcionais omitidos intencionalmente (por exemplo, description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createTenantUserBody	CreateTenantUserBody	Sim

Resposta

Retorna: CreateTenantUser200Response

Exemplo

Exemplo de createTenantUser

Copy

const tenantId: string = 'tenant_6f4b2c';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'sara.kim@example.com',
  displayName: 'Sara Kim',
  role: 'moderator',
  notifyOnMentions: true
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

deleteTenantUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
deleteComments	string	Não
commentDeleteMode	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteTenantUser

Copy

const tenantId: string = '4f3a9b2e-1c6a-4f7b-9e2a-0b8d6f1c2a3e';
const userId: string = '9d2f7b3a-5c4e-48a2-b1f0-6c7d8e9f0a12';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'permanent';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, userId, deleteComments, commentDeleteMode);

getTenantUser

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetTenantUser200Response

Exemplo

Exemplo de getTenantUser

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // acessando o payload
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

getTenantUsers

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
skip	number	Não

Resposta

Retorna: GetTenantUsers200Response

Exemplo

Exemplo de getTenantUsers

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

replaceTenantUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
replaceTenantUserBody	ReplaceTenantUserBody	Sim
updateComments	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de replaceTenantUser

Copy

const tenantId: string = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
redirectURL	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de sendLoginLink

Copy

const tenantId: string = "tenant_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

updateTenantUser

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
updateTenantUserBody	UpdateTenantUserBody	Sim
updateComments	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateTenantUser

Copy

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

createTenant

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createTenantBody	CreateTenantBody	Sim

Resposta

Retorna: CreateTenant200Response

Exemplo

Exemplo de createTenant

Copy

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

deleteTenant

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
sure	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteTenant

Copy

const tenantId: string = "tenant_7f3d2c";
const id: string = "flag_8392b1a7";
const sure: string = "confirmed";
const responseWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const responseWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

getTenant

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetTenant200Response

Exemplo

Exemplo de getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // sobrescrita opcional, se disponível
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

getTenants

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
meta	string	Não
skip	number	Não

Resposta

Retorna: GetTenants200Response

Exemplo

Exemplo de getTenants

Copy

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

updateTenant

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateTenantBody	UpdateTenantBody	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // opcional, omita para manter a cobrança atual
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Sim
id	string	Sim
changeTicketStateBody	ChangeTicketStateBody	Sim

Resposta

Retorna: ChangeTicketState200Response

Exemplo

Exemplo de changeTicketState

Copy

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

createTicket

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Sim
createTicketBody	CreateTicketBody	Sim

Resposta

Retorna: CreateTicket200Response

Exemplo

Exemplo de createTicket

Copy

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

getTicket

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
userId	string	Não

Resposta

Retorna: GetTicket200Response

Exemplo

Exemplo de getTicket

Copy

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

getTickets

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
state	number	Não
skip	number	Não
limit	number	Não

Resposta

Retorna: GetTickets200Response

Exemplo

Exemplo de getTickets

Copy

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

uploadImage

Enviar e redimensionar uma imagem

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
file	Blob	Sim
sizePreset	SizePreset	Não
urlId	string	Não

Resposta

Retorna: UploadImageResponse

getUserBadgeProgressById

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetUserBadgeProgressById200Response

Exemplo

Exemplo de getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
userId	string	Sim

Resposta

Retorna: GetUserBadgeProgressById200Response

Exemplo

Exemplo de getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
limit	number	Não
skip	number	Não

Resposta

Retorna: GetUserBadgeProgressList200Response

Exemplo

Exemplo de getUserBadgeProgressList

Copy

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

createUserBadge

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
createUserBadgeParams	CreateUserBadgeParams	Sim

Resposta

Retorna: CreateUserBadge200Response

Exemplo

Exemplo de createUserBadge

Copy

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

deleteUserBadge

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: UpdateUserBadge200Response

Exemplo

Exemplo de deleteUserBadge

Copy

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

getUserBadge

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetUserBadge200Response

Exemplo

Exemplo de getUserBadge

Copy

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

getUserBadges

Parâmetros

Name	Type	Required
tenantId	string	Sim
userId	string	Não
badgeId	string	Não
type	number	Não
displayedOnComments	boolean	Não
limit	number	Não
skip	number	Não

Resposta

Retorna: GetUserBadges200Response

Exemplo

Exemplo de getUserBadges

Copy

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

updateUserBadge

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateUserBadgeParams	UpdateUserBadgeParams	Sim

Resposta

Retorna: UpdateUserBadge200Response

Exemplo

Exemplo de updateUserBadge

Copy

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

getUserNotificationCount

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
sso	string	Não

Resposta

Retorna: GetUserNotificationCount200Response

Exemplo

Exemplo de getUserNotificationCount

Copy

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

getUserNotifications

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
pageSize	number	Não
afterId	string	Não
includeContext	boolean	Não
afterCreatedAt	number	Não
unreadOnly	boolean	Não
dmOnly	boolean	Não
noDm	boolean	Não
includeTranslations	boolean	Não
sso	string	Não

Resposta

Retorna: GetUserNotifications200Response

Exemplo

Exemplo de getUserNotifications

Copy

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

resetUserNotificationCount

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
sso	string	Não

Resposta

Retorna: ResetUserNotifications200Response

Exemplo

Exemplo de resetUserNotificationCount

Copy

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

resetUserNotifications

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
afterId	string	Não
afterCreatedAt	number	Não
unreadOnly	boolean	Não
dmOnly	boolean	Não
noDm	boolean	Não
sso	string	Não

Resposta

Retorna: ResetUserNotifications200Response

Exemplo

Exemplo de resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Ativar ou desativar notificações para um comentário específico.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
notificationId	string	Sim
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Sim
commentId	string	Sim
sso	string	Não

Resposta

Retorna: UpdateUserNotificationStatus200Response

Exemplo

Exemplo de updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

Ativar ou desativar notificações para uma página. Quando os usuários estão inscritos em uma página, notificações são criadas para novos comentários raiz, e também

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
url	string	Sim
pageTitle	string	Sim
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Sim
sso	string	Não

Resposta

Retorna: UpdateUserNotificationStatus200Response

Exemplo

updateUserNotificationPageSubscriptionStatus Exemplo

Copy

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

updateUserNotificationStatus

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
notificationId	string	Sim
newStatus	UpdateUserNotificationStatusNewStatusEnum	Sim
sso	string	Não

Resposta

Retorna: UpdateUserNotificationStatus200Response

Exemplo

Exemplo de updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlIdWS	string	Sim
userIds	string	Sim

Resposta

Retorna: GetUserPresenceStatuses200Response

Exemplo

Exemplo getUserPresenceStatuses

Copy

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

searchUsers

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
usernameStartsWith	string	Não
mentionGroupIds	Array	Não
sso	string	Não
searchSection	SearchUsersSearchSectionEnum	Não

Resposta

Retorna: SearchUsers200Response

Exemplo

Exemplo de searchUsers

Copy

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

getUser

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetUser200Response

Exemplo

Exemplo de getUser

Copy

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

createVote

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
direction	CreateVoteDirectionEnum	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: VoteComment200Response

Exemplo

Exemplo de createVote

Copy

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

deleteVote

Parâmetros

Name	Type	Required
tenantId	string	Sim
id	string	Sim
editKey	string	Não

Resposta

Retorna: DeleteCommentVote200Response

Exemplo

Exemplo de deleteVote

Copy

const tenantId: string = "tenant_7c3f2b4a";
const voteId: string = "vote_4f8d9a11";
const editKey: string = "edit_2b9f8c";
const resultWithoutKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId);
const resultWithKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId, editKey);

getVotes

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Sim
urlId	string	Sim

Resposta

Retorna: GetVotes200Response

Exemplo

Exemplo de getVotes

Copy

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

getVotesForUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
userId	string	Não
anonUserId	string	Não

Resposta

Retorna: GetVotesForUser200Response

Exemplo

Exemplo de getVotesForUser

Copy

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

Precisa de ajuda?

Se você encontrar algum problema ou tiver dúvidas sobre o JavaScript/TypeScript SDK, por favor:

Contribuindo

Contribuições são bem-vindas! Por favor, visite o repositório no GitHub para diretrizes de contribuição.

Idioma 🇧🇷 Português (Brasil)

Primeiros Passos

Referência da API

Documentação

Uso

Agregação

Logs de Auditoria

Bloquear a partir do comentário

Verificar comentários bloqueados

Comentários

Configurações de Domínio

Modelos de Email

Registro de Eventos

Publicações do Feed

Denunciar Comentário

Hashtags

Moderadores

Contagem de Notificações

Notificações

Páginas

Eventos de Webhook Pendentes

Configurações de Perguntas

Resultados de Perguntas

Agregação de Resultados de Perguntas

Usuários SSO

Assinaturas

Uso Diário do Tenant

Pacotes do Tenant

Usuários do Tenant

Tenants

Tickets

Enviar Imagem

Progresso do Emblema do Usuário

Emblemas de Usuário

Notificações do Usuário

Status de Presença do Usuário

Busca de Usuários

Usuários

Votos

FastComments JavaScript/TypeScript SDK

Repositório

Instalação

Documentação da API

Referência completa da API: docs/api/README.md

Compatibilidade Navegador vs Servidor

Uso

Uso no Navegador (Lado do Cliente)

Uso no Servidor (Node.js)

Import apenas de Tipos

Usando Classes de API Individuais

Ambiente do Navegador

Ambiente do Servidor

APIs Públicas vs Seguras

Exemplo: Usando a PublicApi (seguro para navegador)

Exemplo: Usando a DefaultApi (somente no servidor)

Integração SSO (Single Sign-On)

SSO Simples (Apenas no Lado do Servidor)

SSO Seguro (Lado do Servidor, Recomendado)

Usando SSO a partir do Navegador (com Token Gerado pelo Servidor)

SSO com Criação de Comentário

Casos de Uso Comuns

Obtendo Comentários de uma Página

Criando um Comentário

Votando em um Comentário

Gerenciamento de Usuários (Requer Chave de API)

Eventos ao Vivo (Atualizações em Tempo Real)

Eventos por página

Inscreva-se em eventos do usuário

Obtendo userIdWS

IDs de Transmissão

Tratamento de Erros

aggregate

Parâmetros

Resposta

getAuditLogs

Parâmetros

Resposta

Exemplo

blockFromCommentPublic

Parâmetros

Exemplo: Usando a `PublicApi` (seguro para navegador)

Exemplo: Usando a `DefaultApi` (somente no servidor)