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

Agregação

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

Obter registros de auditoria

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
limit	number	Não
skip	number	Não
order	SORTDIR	Não
after	number	Não
before	number	Não

Resposta

Retorna: GetAuditLogs200Response

Bloquear por comentário (público)

Parâmetros

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

Resposta

Retorna: BlockFromCommentPublic200Response

Desbloquear comentário (público)

Parâmetros

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

Resposta

Retorna: UnBlockCommentPublic200Response

Verificar comentários bloqueados

Parâmetros

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

Resposta

Retorna: CheckedCommentsForBlocked200Response

Bloquear usuário por comentário

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

Criar comentário (público)

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

Excluir comentário

Parâmetros

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

Resposta

Retorna: DeleteComment200Response

Excluir comentário (público)

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

Remover voto de comentário

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

Denunciar comentário

Parâmetros

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

Resposta

Retorna: FlagComment200Response

Obter comentário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetComment200Response

Obter comentários

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
page	number	Não
limit	number	Não
skip	number	Não
asTree	boolean	Não
skipChildren	number	Não
limitChildren	number	Não
maxTreeDepth	number	Não
urlId	string	Não
userId	string	Não
anonUserId	string	Não
contextUserId	string	Não
hashTag	string	Não
parentId	string	Não
direction	SortDirections	Não

Resposta

Retorna: GetComments200Response

Obter comentários (públicos)

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

Obter texto do comentário

Parâmetros

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

Resposta

Retorna: GetCommentText200Response

Obter nomes de usuários de votos do comentário

Parâmetros

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

Resposta

Retorna: GetCommentVoteUserNames200Response

Travar comentário

Parâmetros

Name	Type	Obrigatório
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
sso	string	Não

Resposta

Retorna: LockComment200Response

Fixar comentário

Parâmetros

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

Resposta

Retorna: PinComment200Response

Salvar comentário

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

Salvar comentários em massa

Parâmetros

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

Definir texto do comentário

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

Desbloquear usuário por comentário

Parâmetros

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

Resposta

Retorna: UnBlockCommentPublic200Response

Remover denúncia de comentário

Parâmetros

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

Resposta

Retorna: FlagComment200Response

Destravar comentário

Parâmetros

Name	Type	Required
tenantId	string	Sim
commentId	string	Sim
broadcastId	string	Sim
sso	string	Não

Resposta

Retorna: LockComment200Response

Remover fixação do comentário

Parâmetros

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

Resposta

Retorna: PinComment200Response

Atualizar comentário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Votar em comentário

Parâmetros

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

Adicionar configuração de domínio

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
addDomainConfigParams	AddDomainConfigParams	Sim

Resposta

Retorna: AddDomainConfig200Response

Excluir configuração de domínio

Parâmetros

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

Resposta

Retorna: DeleteDomainConfig200Response

Obter configuração de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfig200Response

Obter configurações de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfigs200Response

Atualizar parcialmente configuração de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfig200Response

Substituir configuração de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfig200Response

Criar modelo de e-mail

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
createEmailTemplateBody	CreateEmailTemplateBody	Sim

Resposta

Retorna: CreateEmailTemplate200Response

Exemplo

Exemplo de createEmailTemplate

Copy

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

Excluir modelo de e-mail

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_4b2f6a-4b2f6a2d";
const templateId: string = "email_template_9f8b7c3e";
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);
const status: APIStatus | undefined = result?.status

Excluir erro de renderização do modelo de e-mail

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_8f3b2a9c";
const id: string = "template_4a1c9f7e";
const errorId: string = "err_20260112_abc123";
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

Obter modelo de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplate200Response

Exemplo

Exemplo de getEmailTemplate

Copy

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

Obter definições de modelos de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplateDefinitions200Response

Exemplo

Exemplo de getEmailTemplateDefinitions

Copy

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

Obter erros de renderização de modelos de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplateRenderErrors200Response

Exemplo

Exemplo de getEmailTemplateRenderErrors

Copy

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

Obter modelos de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplates200Response

Exemplo

Exemplo de getEmailTemplates

Copy

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

Renderizar modelo de e-mail

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

Atualizar modelo de e-mail

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateEmailTemplate

Copy

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

Obter registro de eventos

req tenantId urlId userIdWS

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Sim
startTime	number	Sim
endTime	number	Sim

Resposta

Retorna: GetEventLog200Response

Obter registro de eventos global

req tenantId urlId userIdWS

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Sim
startTime	number	Sim
endTime	number	Sim

Resposta

Retorna: GetEventLog200Response

Criar publicação de feed

Parâmetros

Name	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

Criar publicação de feed (pública)

Parâmetros

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

Resposta

Retorna: CreateFeedPostPublic200Response

Excluir publicação de feed (pública)

Parâmetros

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

Resposta

Retorna: DeleteFeedPostPublic200Response

Obter publicações do feed

req tenantId afterId

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
afterId	string	Não
limit	number	Não
tags	Array	Não

Resposta

Retorna: GetFeedPosts200Response

Obter publicações do feed (públicas)

req tenantId afterId

Parâmetros

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

Obter estatísticas de publicações do feed

Parâmetros

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

Resposta

Retorna: GetFeedPostsStats200Response

Obter reações de usuário (públicas)

Parâmetros

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

Resposta

Retorna: GetUserReactsPublic200Response

Reagir à publicação do feed (pública)

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
postId	string	Sim
reactBodyParams	ReactBodyParams	Sim
isUndo	boolean	Não
broadcastId	string	Não
sso	string	Não

Resposta

Retorna: ReactFeedPostPublic200Response

Atualizar publicação do feed

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
feedPost	FeedPost	Sim

Resposta

Retorna: FlagCommentPublic200Response

Atualizar publicação do feed (pública)

Parâmetros

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

Resposta

Retorna: CreateFeedPostPublic200Response

Denunciar comentário (público)

Parâmetros

Name	Type	Obrigatório
tenantId	string	Sim
commentId	string	Sim
isFlagged	boolean	Sim
sso	string	Não

Resposta

Retorna: FlagCommentPublic200Response

Adicionar hashtag

Parâmetros

Nome	Tipo	Obrigatório	Descrição
tenantId	string	Não
createHashTagBody	CreateHashTagBody	Não

Resposta

Retorna: AddHashTag200Response

Exemplo

Exemplo de addHashTag

Copy

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

Adicionar hashtags em massa

Parâmetros

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

Resposta

Retorna: AddHashTagsBulk200Response

Exemplo

Exemplo de addHashTagsBulk

Copy

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

Excluir hashtag

Parâmetros

Name	Type	Required
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_42';
const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);

Obter hashtags

Parâmetros

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

Resposta

Retorna: GetHashTags200Response

Exemplo

Exemplo de getHashTags

Copy

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

Atualizar parcialmente hashtag

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

Criar moderador

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

Excluir moderador

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteModerator

Copy

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

Obter moderador

Parâmetros

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

Resposta

Retorna: GetModerator200Response

Exemplo

Exemplo de getModerator

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // origem opcional (pode ser undefined)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

Obter moderadores

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_corp_7f9b2a";
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const skip: number = 50;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

Enviar convite

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de sendInvite

Copy

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

Atualizar moderador

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateModeratorBody	UpdateModeratorBody	Sim

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateModerator

Copy

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

Excluir contagem de notificações

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteNotificationCount

Copy

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

Obter contagem de notificações em cache

Parâmetros

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

Resposta

Retorna: GetCachedNotificationCount200Response

Exemplo

Exemplo de getCachedNotificationCount

Copy

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

Obter contagem de notificações

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

Obter notificações

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Resposta

Retorna: GetNotifications200Response

Exemplo

Exemplo de getNotifications

Copy

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

Atualizar notificação

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

Adicionar página

Parâmetros

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

Resposta

Retorna: AddPageAPIResponse

Excluir página

Parâmetros

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

Resposta

Retorna: DeletePageAPIResponse

Obter página por ID de URL

Parâmetros

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

Resposta

Retorna: GetPageByURLIdAPIResponse

Obter páginas

Parâmetros

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

Resposta

Retorna: GetPagesAPIResponse

Atualizar parcialmente página

Parâmetros

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

Resposta

Retorna: PatchPageAPIResponse

Excluir evento de webhook pendente

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deletePendingWebhookEvent

Copy

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

Obter contagem de eventos de webhook pendentes

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

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

Obter eventos de webhook pendentes

Parâmetros

Name	Type	Required
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_78b2f1";
const commentId: string = "cmt_0042";
const eventType: string = "comment.created";
const domain: string = "blog.example.com";
const attemptCountGT: number = 1;
const skip: number = 0;
const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined, // externalId (não definido)
  eventType,
  undefined, // type (não definido)
  domain,
  attemptCountGT,
  skip
);

Criar configuração de pergunta

Parâmetros

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

Resposta

Retorna: CreateQuestionConfig200Response

Exemplo

createQuestionConfig Exemplo

Copy

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

Excluir configuração de pergunta

Parameters

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteQuestionConfig

Copy

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

Obter configuração de pergunta

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-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata é opcional; implementação omitida por brevidade
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

Obter configurações de pergunta

Parameters

Name	Type	Required	Description
tenantId	string	Sim
skip	number	Não

Response

Retorna: GetQuestionConfigs200Response

Example

Exemplo de getQuestionConfigs

Copy

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

Atualizar configuração de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de updateQuestionConfig

Copy

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

Criar resultado de pergunta

Parâmetros

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

Resposta

Retorna: CreateQuestionResult200Response

Exemplo

Exemplo de createQuestionResult

Copy

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

Excluir resultado de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de deleteQuestionResult

Copy

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

Obter resultado de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionResult200Response

Exemplo

Exemplo de getQuestionResult

Copy

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

Obter resultados de perguntas

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_42';
const urlId: string = 'news/2025/fastcomments-release';
const userId: string = 'user_8b7f3c';
const startDate: string = '2025-01-01T00:00:00Z';
const questionIds: string = 'q123,q124';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

Atualizar resultado de pergunta

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_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // parâmetro opcional incluído
};
const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Agregação de resultados de perguntas

Parâmetros

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

Agregação em massa de resultados de perguntas

Parâmetros

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

Resposta

Retorna: BulkAggregateQuestionResults200Response

Combinar comentários com resultados de perguntas

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

Adicionar usuário SSO

Parâmetros

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

Resposta

Retorna: AddSSOUserAPIResponse

Excluir usuário SSO

Parâmetros

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

Resposta

Retorna: DeleteSSOUserAPIResponse

Obter usuário SSO por e-mail

Parâmetros

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

Resposta

Retorna: GetSSOUserByEmailAPIResponse

Obter usuário SSO por ID

Parâmetros

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

Resposta

Retorna: GetSSOUserByIdAPIResponse

Obter usuários SSO

Parâmetros

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

Resposta

Retorna: GetSSOUsers200Response

Atualizar parcialmente usuário SSO

Parâmetros

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

Resposta

Retorna: PatchSSOUserAPIResponse

Substituir usuário SSO

Parâmetros

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

Resposta

Retorna: PutSSOUserAPIResponse

Criar assinatura

Parâmetros

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

Resposta

Retorna: CreateSubscriptionAPIResponse

Excluir assinatura

Parâmetros

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

Resposta

Retorna: DeleteSubscriptionAPIResponse

Obter assinaturas

Parâmetros

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

Resposta

Retorna: GetSubscriptionsAPIResponse

Obter usos diários do locatário

Parâmetros

Name	Type	Required
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_89f3c2-prod";
const yearNumber: number = 2026;
const monthNumber: number = 1;
const skip: number = 0;
const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

Criar pacote do locatário

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_7f3b1a9c";
const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };
const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Premium Plus",
  tenantPackage,
  customConfig,
  notes: "Enable advanced moderation and image uploads" // parâmetro opcional demonstrado
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

Excluir pacote do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo deleteTenantPackage

Copy

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

Obter pacote do locatário

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_westus_01';
const packageId: string = 'pkg_premium_annual_2026';
interface FetchOptions { includeArchived?: boolean }
const options: FetchOptions = { includeArchived: false };
const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

Obter pacotes do locatário

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_4f3a9c2d';
const skip: number = 25;
const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);
const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

Substituir pacote do locatário

Parameters

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

Response

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de replaceTenantPackage

Copy

const tenantId: string = 'tenant-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // campos opcionais como "notes" ou "trialExpiry" foram intencionalmente omitidos aqui
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

Atualizar pacote do locatário

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

Criar usuário do locatário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
createTenantUserBody	CreateTenantUserBody	Sim

Resposta

Retorna: CreateTenantUser200Response

Exemplo

Exemplo de createTenantUser

Copy

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

Excluir usuário do locatário

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 = 'tenant_8f3b2a9c';
const id: string = 'user_4e5f6a7b';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'hard';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

Obter usuário do locatário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetTenantUser200Response

Exemplo

Exemplo de getTenantUser

Copy

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

Obter usuários do locatário

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_8f3b2c1a';
const skip: number = 50;
const firstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
const nextPage: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

Substituir usuário do locatário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	Yes
replaceTenantUserBody	ReplaceTenantUserBody	Yes
updateComments	string	No

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de replaceTenantUser

Copy

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

Enviar link de login

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_acme_01';
const id: string = 'user_9f3b2a';
const redirectURL: string = 'https://app.example.com/onboard?source=login-email';
const result: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

Atualizar usuário do locatário

Parâmetros

Nome	Tipo	Obrigatório
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_84f3b2';
const id: string = 'user_7a9d1c';
const updateComments: string = 'Promoted to moderator and updated contact email';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe+mod@example.com',
  displayName: 'Jane D.',
  roles: ['moderator'],
  isBanned: false,
  metadata: { department: 'community' }
};
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

Criar locatário

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

Excluir locatário

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_7b3f1a9e";
const id: string = "flag_9c4d2b1a";
const sure: string = "yes_confirm_delete";
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);
console.log(result);

Obter locatário

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_acme_corp";
const id: string = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
interface GetOptions { includeDeleted?: boolean; locale?: string; }
const options: GetOptions = { locale: "en-US" };
const result: GetTenant200Response = await getTenant(tenantId, id);

Obter locatários

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

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

Atualizar locatário

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_01H4ZQ7KABCD";
const id: string = "site_9f8e7d6c";
const apiDomainConfiguration: APIDomainConfiguration = {
  primaryDomain: "comments.acme.com",
  allowSubdomains: true
};
const billingInfo: BillingInfo = {
  planName: "Business",
  billingContactEmail: "billing@acme.com",
  seats: 25
};
const updateTenantBody: UpdateTenantBody = {
  displayName: "Acme Corporation Comments",
  apiDomainConfiguration,
  billingInfo, // parâmetro opcional demonstrado
  enableModeration: true
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Enviar imagem

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

Obter progresso de insígnia do usuário por ID

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressById200Response

Obter progresso de insígnia do usuário por ID do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressById200Response

Obter lista de progresso de insígnias do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressList200Response

Criar insígnia do usuário

Parâmetros

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

Resposta

Retorna: CreateUserBadge200Response

Excluir insígnia do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserBadge200Response

Obter insígnia do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadge200Response

Obter insígnias do usuário

Parâmetros

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

Atualizar insígnia do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserBadge200Response

Obter contagem de notificações do usuário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
sso	string	Não

Resposta

Retorna: GetUserNotificationCount200Response

Obter notificações do usuário

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

Redefinir contagem de notificações do usuário

Parâmetros

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

Resposta

Retorna: ResetUserNotifications200Response

Redefinir notificações do usuário

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

Atualizar status de assinatura de notificações por comentários do usuário

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

Atualizar status de assinatura de notificações por página do usuário

Ativa ou desativa notificações para uma página. Quando 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

Atualizar status de notificação do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserNotificationStatus200Response

Obter status de presença do usuário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlIdWS	string	Sim
userIds	string	Sim

Resposta

Retorna: GetUserPresenceStatuses200Response

Pesquisar usuários

Parâmetros

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

Resposta

Retorna: SearchUsers200Response

Obter usuário

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
id	string	Sim

Resposta

Retorna: GetUser200Response

Exemplo

Exemplo de getUser

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // pode ser indefinido em alguns fluxos (opcional)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

Criar voto

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

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

Excluir voto

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_7f3b21c9';
const id: string = 'vote_4a2d9f1b';
const editKey: string = 'edit_92b7c6a1';
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);

Obter votos

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 = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// Se existisse um parâmetro opcional, por exemplo includeHidden, ele poderia ser usado assim:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

Obter votos do usuário

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

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

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

Registros de Auditoria

Bloquear a partir do comentário

Verificar comentários bloqueados

Comentários

Configurações de Domínio

Modelos de E-mail

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 Pergunta

Resultados de Pergunta

Agregação de Resultados de Pergunta

Usuários SSO

Assinaturas

Uso diário do locatário

Pacotes do Locatário

Usuários do Locatário

Locatários

Enviar Imagem

Progresso de Insígnia do Usuário

Insígnias do 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

Agregação

Parâmetros

Resposta

Obter registros de auditoria

Parâmetros

Resposta

Bloquear por comentário (público)

Parâmetros

Resposta

Desbloquear comentário (público)

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

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