FastComments SDK JavaScript/TypeScript

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

Gerencie comentários, usuários, SSO e moderação a partir do Node.js ou do navegador.

Repositório

Agentes de codificação IA

Forneça ao seu agente de codificação o contexto do FastComments que ele precisa - widgets, configuração, Secure SSO, a REST API e os SDKs:

npx skills add fastcomments/skills

Funciona com Claude Code, Codex, Cursor, Copilot, Gemini e todos os outros agentes que o skills CLI suporta.

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 as seguintes classes de API:

DefaultApi - Endpoints seguros 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.
ModerationApi - Endpoints do painel de moderação (moderação de comentários, banimentos, badges, fator de confiança, busca). Autenticados pela sessão do moderador; passe o parâmetro de consulta sso para moderadores autenticados via SSO.
HiddenApi - Endpoints internos/administrativos para casos de uso avançados.

Exemplo: Usando a Public API (compatível com navegador)

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

const publicApi = new PublicApi();

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

Exemplo: Usando a Default API (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'
});

Exemplo: Usando a Moderation API

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

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

// Chamadas autenticadas por moderador (cookie de sessão, ou passe `sso` para um moderador autenticado via SSO).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

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

Integração SSO (Login Único)

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

createAgentTenant

Cria uma nova conta de teste para um agente de IA sem um cadastro humano. Não é necessária uma chave de API para chamar isso.

A resposta contém o ID do locatário, uma chave de API que funciona imediatamente contra a API REST e o servidor MCP, e uma URL de reivindicação. Forneça a URL de reivindicação ao humano para quem você está trabalhando: abri‑la enquanto estiver conectado ao FastComments associa a conta a ele. Contas não reivindicadas, e suas chaves, são excluídas 72 horas após a criação. Até serem reivindicadas, a conta tem os limites padrão de teste.

Parameters

Name	Type	Required	Description
createAgentTenantBody	CreateAgentTenantBody	Yes

Response

Returns: CreateAgentTenantResponse

Example

Exemplo createAgentTenant

Copy

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

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.

Parameters

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

Response

Retorna: AggregateResponse

Example

Exemplo de agregação

Copy

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

getAuditLogs

Parâmetros

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
username	string	Não
ip	string	Não
crudType	string	Não
resourceName	string	Não
targetId	string	Não
target	string	Não
includeManagedTenants	boolean	Não

Resposta

Retorna: GetAuditLogsResponse

Exemplo

Exemplo getAuditLogs

Copy

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

blockFromCommentPublic

Parâmetros

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

Resposta

Retorna: BlockSuccess

Exemplo

Exemplo blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parâmetros

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

Resposta

Retorna: UnblockSuccess

Exemplo

Exemplo unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Parâmetros

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

Resposta

Retorna: CheckBlockedCommentsResponse

Exemplo

checkedCommentsForBlocked Exemplo

Copy

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

blockUserFromComment

Parâmetros

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

Resposta

Retorna: BlockSuccess

Exemplo

Exemplo de blockUserFromComment

Copy

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

createCommentPublic

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
commentData	CommentData	Yes
sessionId	string	No
sso	string	No

Resposta

Returns: SaveCommentsResponseWithPresence

Exemplo

Exemplo createCommentPublic

Copy

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

deleteComment

Parâmetros

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

Resposta

Retorna: DeleteCommentResult

Exemplo

Exemplo deleteComment

Copy

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

deleteCommentPublic

Parâmetros

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

Resposta

Retorna: PublicAPIDeleteCommentResponse

Exemplo

Exemplo deleteCommentPublic

Copy

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

deleteCommentVote

Parâmetros

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

Exemplo

Exemplo deleteCommentVote

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const voteId: string = "vote_555";
const urlId: string = "url_abcde";
const broadcastId: string = "brd_2023";
const editKey: string = "edit_abc123"; // opcional
const ssoToken: string = "sso_token_xyz"; // opcional
// Chamada com apenas os parâmetros obrigatórios e um opcional
const deleteResult: VoteDeleteResponse = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey
);
// Chamada com ambos os parâmetros opcionais
const deleteResultWithSSO: VoteDeleteResponse = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  ssoToken
);

flagComment

Parâmetros

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

Resposta

Retorna: FlagCommentResponse

Exemplo

Exemplo de flagComment

Copy

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

getComment

Parâmetros

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

Resposta

Retorna: APIGetCommentResponse

Exemplo

Exemplo getComment

Copy

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

getComments

Parâmetros

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
fromDate	number	Não
toDate	number	Não

Resposta

Retorna: APIGetCommentsResponse

Exemplo

Exemplo getComments

Copy

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

getCommentsPublic

req tenantId urlId

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

Exemplo

Exemplo getCommentsPublic

Copy

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

getCommentText

Parâmetros

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

Resposta

Retorna: PublicAPIGetCommentTextResponse

Exemplo

Exemplo getCommentText

Copy

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

getCommentVoteUserNames

Parâmetros

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

Resposta

Retorna: GetCommentVoteUserNamesSuccessResponse

Exemplo

Exemplo getCommentVoteUserNames

Copy

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

lockComment

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

lockComment Exemplo

Copy

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

pinComment

Parâmetros

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

Resposta

Retorna: ChangeCommentPinStatusResponse

Exemplo

Exemplo pinComment

Copy

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

saveComment

Parâmetros

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

Exemplo

Exemplo saveComment

Copy

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

saveCommentsBulk

Parameters

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<SaveCommentsBulkResponse

Exemplo

saveCommentsBulk Exemplo

Copy

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

setCommentText

Parâmetros

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

Exemplo

Exemplo setCommentText

Copy

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

unBlockUserFromComment

Parâmetros

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

Resposta

Retorna: UnblockSuccess

Exemplo

Exemplo de unBlockUserFromComment

Copy

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

unFlagComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Resposta

Retorna: FlagCommentResponse

Exemplo

Exemplo unFlagComment

Copy

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

unLockComment

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de unLockComment

Copy

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

unPinComment

Parâmetros

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

Resposta

Retorna: ChangeCommentPinStatusResponse

Exemplo

Exemplo unPinComment

Copy

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

updateComment

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de updateComment

Copy

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

voteComment

Parâmetros

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

Exemplo

Exemplo voteComment

Copy

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

getCommentsForUser

Parâmetros

Nome	Tipo	Obrigatório
userId	string	Não
direction	SortDirections	Não
repliesToUserId	string	Não
page	number	Não
includei10n	boolean	Não
locale	string	Não
isCrawler	boolean	Não

Resposta

Retorna: GetCommentsForUserResponse

Exemplo

Exemplo getCommentsForUser

Copy

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

addDomainConfig

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

Resposta

Retorna: AddDomainConfigResponse

Exemplo

addDomainConfig Exemplo

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // a descrição é opcional e omitida aqui
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

deleteDomainConfig

Parâmetros

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

Resposta

Retorna: DeleteDomainConfigResponse

Exemplo

Exemplo deleteDomainConfig

Copy

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

getDomainConfig

Parâmetros

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

Resposta

Retorna: GetDomainConfigResponse

Exemplo

Exemplo getDomainConfig

Copy

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

getDomainConfigs

Parâmetros

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

Resposta

Retorna: GetDomainConfigsResponse

Exemplo

Exemplo getDomainConfigs

Copy

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

patchDomainConfig

Parameters

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

Response

Retorna: PatchDomainConfigResponse

Exemplo

patchDomainConfig Exemplo

Copy

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

putDomainConfig

Parâmetros

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

Resposta

Retorna: PutDomainConfigResponse

Exemplo

Exemplo putDomainConfig

Copy

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

createEmailTemplate

Parâmetros

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

Resposta

Retorna: CreateEmailTemplateResponse

Exemplo

Exemplo createEmailTemplate

Copy

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

deleteEmailTemplate

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

deleteEmailTemplateRenderError Exemplo

Copy

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

getEmailTemplate

Parâmetros

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

Resposta

Retorna: GetEmailTemplateResponse

Exemplo

Exemplo getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parâmetros

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

Resposta

Retorna: GetEmailTemplateDefinitionsResponse

Exemplo

Exemplo getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parâmetros

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

Resposta

Retorna: GetEmailTemplateRenderErrorsResponse

Exemplo

Exemplo getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Resposta

Retorna: GetEmailTemplatesResponse

Exemplo

Exemplo getEmailTemplates

Copy

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

renderEmailTemplate

Parâmetros

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

Resposta

Retorna: RenderEmailTemplateResponse

Exemplo

Exemplo renderEmailTemplate

Copy

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

updateEmailTemplate

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	No

Response

Returns: GetEventLogResponse

Example

Exemplo getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parâmetros

Name	Type	Required
tenantId	string	Sim
urlId	string	Sim
userIdWS	string	Sim
startTime	number	Sim
endTime	number	Não

Resposta

Retorna: GetEventLogResponse

Exemplo

Exemplo getGlobalEventLog

Copy

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

createFeedPost

Parâmetros

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

Exemplo

Exemplo createFeedPost

Copy

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

createFeedPostPublic

Parâmetros

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

Resposta

Retorna: CreateFeedPostResponse

Exemplo

Exemplo createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parâmetros

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

Resposta

Retorna: DeleteFeedPostPublicResponse

Exemplo

Exemplo deleteFeedPostPublic

Copy

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

getFeedPosts

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

Exemplo

getFeedPosts Exemplo

Copy

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

getFeedPostsPublic

req tenantId afterId

Parâmetros

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

Exemplo

Exemplo getFeedPostsPublic

Copy

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

getFeedPostsStats

Parameters

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

Response

Retorna: FeedPostsStatsResponse

Example

Exemplo getFeedPostsStats

Copy

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

getUserReactsPublic

Parâmetros

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

Resposta

Retorna: UserReactsResponse

Exemplo

Exemplo getUserReactsPublic

Copy

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

reactFeedPostPublic

Parâmetros

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

Exemplo

Exemplo reactFeedPostPublic

Copy

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

updateFeedPost

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateFeedPost

Copy

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

updateFeedPostPublic

Parâmetros

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

Resposta

Retorna: CreateFeedPostResponse

Exemplo

Exemplo updateFeedPostPublic

Copy

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

flagCommentPublic

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo flagCommentPublic

Copy

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

getGifLarge

Parameters

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

Response

Retorna: GifGetLargeResponse

Example

Exemplo getGifLarge

Copy

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

getGifsSearch

Parâmetros

Name	Type	Required
tenantId	string	Sim
search	string	Sim
locale	string	Não
rating	string	Não
page	number	Não

Resposta

Retorna: GetGifsSearchResponse

Exemplo

Exemplo getGifsSearch

Copy

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

getGifsTrending

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
locale	string	Não
rating	string	Não
page	number	Não

Response

Retorna: GetGifsTrendingResponse

Example

Exemplo getGifsTrending

Copy

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

addHashTag

Parâmetros

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

Resposta

Retorna: CreateHashTagResponse

Exemplo

Exemplo addHashTag

Copy

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

addHashTagsBulk

Parâmetros

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

Resposta

Retorna: BulkCreateHashTagsResponse

Exemplo

addHashTagsBulk Exemplo

Copy

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

deleteHashTag

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
tag	string	Sim
deleteHashTagRequestBody	DeleteHashTagRequestBody	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

deleteHashTag Exemplo

Copy

const tenantId: string = "tenant_42";
const tag: string = "high-priority";
const requestBody: DeleteHashTagRequestBody = {
  // preencha os campos conforme necessário
};
const resultWithBody: APIEmptyResponse = await deleteHashTag(tenantId, tag, requestBody);
const resultWithoutBody: APIEmptyResponse = await deleteHashTag(tenantId, tag);

getHashTags

Parâmetros

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

Resposta

Retorna: GetHashTagsResponse

Exemplo

Exemplo getHashTags

Copy

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

patchHashTag

Parâmetros

Name	Type	Required
tenantId	string	Yes
tag	string	Yes
updateHashTagBody	UpdateHashTagBody	No

Resposta

Retorna: UpdateHashTagResponse

Exemplo

patchHashTag Exemplo

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const tag: string = "news";
  // Chamada sem corpo opcional
  const responseWithoutBody: UpdateHashTagResponse = await patchHashTag(tenantId, tag);
  // Preparar corpo para atualização
  const updateBody: UpdateHashTagBody = {
    name: "Latest News",
    description: "Tag for the most recent news articles"
  };
  const responseWithBody: UpdateHashTagResponse = await patchHashTag(tenantId, tag, updateBody);
})();

getMe

Identifica a credencial em uso: o tenant ao qual pertence e, para tokens OAuth, o usuário que a autorizou.
Integrações usam isso para testar uma conexão e rotulá‑la.

Parâmetros

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

Resposta

Retorna: GetMeResponse

Exemplo

Exemplo getMe

Copy

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

deleteModerationVote

Parâmetros

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

Resposta

Retorna: VoteDeleteResponse

Exemplo

deleteModerationVote Exemplo

Copy

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

getApiComments

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
sso	string	No

Resposta

Retorna: ModerationAPIGetCommentsResponse

Exemplo

Exemplo getApiComments

Copy

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

getApiExportStatus

Parâmetros

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

Resposta

Retorna: ModerationExportStatusResponse

Exemplo

Exemplo getApiExportStatus

Copy

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

getApiIds

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
textSearch	string	Não
byIPFromComment	string	Não
filters	string	Não
searchFilters	string	Não
afterId	string	Não
demo	boolean	Não
sso	string	Não

Resposta

Retorna: ModerationAPIGetCommentIdsResponse

Exemplo

Exemplo getApiIds

Copy

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

getBanUsersFromComment

Parâmetros

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

Resposta

Retorna: GetBannedUsersFromCommentResponse

Exemplo

Exemplo getBanUsersFromComment

Copy

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

getCommentBanStatus

Parâmetros

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

Resposta

Retorna: GetCommentBanStatusResponse

Exemplo

Exemplo getCommentBanStatus

Copy

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

getCommentChildren

Parâmetros

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

Resposta

Retorna: ModerationAPIChildCommentsResponse

Exemplo

Exemplo getCommentChildren

Copy

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

getCount

Parâmetros

Name	Type	Required
tenantId	string	Sim
textSearch	string	Não
byIPFromComment	string	Não
filter	string	Não
searchFilters	string	Não
demo	boolean	Não
sso	string	Não

Resposta

Retorna: ModerationAPICountCommentsResponse

Exemplo

Exemplo getCount

Copy

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

getCounts

Parâmetros

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

Resposta

Retorna: GetBannedUsersCountResponse

Exemplo

Exemplo getCounts

Copy

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

getLogs

Parâmetros

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

Resposta

Retorna: ModerationAPIGetLogsResponse

Exemplo

Exemplo getLogs

Copy

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

getManualBadges

Parâmetros

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

Resposta

Retorna: GetTenantManualBadgesResponse

Exemplo

Exemplo getManualBadges

Copy

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

getManualBadgesForUser

Parâmetros

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

Resposta

Returns: GetUserManualBadgesResponse

Exemplo

Exemplo getManualBadgesForUser

Copy

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

getModerationComment

Parâmetros

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

Resposta

Retorna: ModerationAPICommentResponse

Exemplo

Exemplo getModerationComment

Copy

async function fetchComments() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_1234567890";
  // Chamada com apenas os parâmetros obrigatórios
  const basicResponse: ModerationAPICommentResponse = await getModerationComment(tenantId, commentId);
  // Chamada com parâmetros opcionais
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const sso: string = "sso-token-abc123";
  const detailedResponse: ModerationAPICommentResponse = await getModerationComment(
    tenantId,
    commentId,
    includeEmail,
    includeIP,
    sso
  );
}

getModerationCommentText

Parâmetros

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

Resposta

Retorna: GetCommentTextResponse

Exemplo

Exemplo getModerationCommentText

Copy

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

getPreBanSummary

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
includeByUserIdAndEmail	boolean	Não
includeByIP	boolean	Não
includeByEmailDomain	boolean	Não
sso	string	Não

Resposta

Retorna: PreBanSummary

Exemplo

Exemplo getPreBanSummary

Copy

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

getSearchCommentsSummary

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
value	string	Não
filters	string	Não
searchFilters	string	Não
sso	string	Não

Resposta

Retorna: ModerationCommentSearchResponse

Exemplo

Exemplo getSearchCommentsSummary

Copy

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

getSearchPages

Parâmetros

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

Resposta

Retorna: ModerationPageSearchResponse

Exemplo

Exemplo getSearchPages

Copy

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

getSearchSites

Parâmetros

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

Resposta

Retorna: ModerationSiteSearchResponse

Exemplo

Exemplo getSearchSites

Copy

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

getSearchSuggest

Parâmetros

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

Resposta

Retorna: ModerationSuggestResponse

Exemplo

Exemplo getSearchSuggest

Copy

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

getSearchUsers

Parâmetros

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

Resposta

Retorna: ModerationUserSearchResponse

Exemplo

Exemplo getSearchUsers

Copy

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

getTrustFactor

Parâmetros

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

Resposta

Retorna: GetUserTrustFactorResponse

Exemplo

Exemplo getTrustFactor

Copy

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

getUserBanPreference

Parâmetros

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

Resposta

Retorna: APIModerateGetUserBanPreferencesResponse

Exemplo

Exemplo getUserBanPreference

Copy

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

getUserInternalProfile

Parâmetros

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

Resposta

Retorna: GetUserInternalProfileResponse

Exemplo

Exemplo getUserInternalProfile

Copy

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

postAdjustCommentVotes

Parâmetros

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

Resposta

Retorna: AdjustVotesResponse

Exemplo

Exemplo postAdjustCommentVotes

Copy

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

postApiExport

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
textSearch	string	Não
byIPFromComment	string	Não
filters	string	Não
searchFilters	string	Não
sorts	string	Não
sso	string	Não

Resposta

Retorna: ModerationExportResponse

Exemplo

postApiExport Exemplo

Copy

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

postBanUserFromComment

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
banEmail	boolean	No
banEmailDomain	boolean	No
banIP	boolean	No
deleteAllUsersComments	boolean	No
bannedUntil	string	No
isShadowBan	boolean	No
updateId	string	No
banReason	string	No
sso	string	No

Resposta

Retorna: BanUserFromCommentResult

Exemplo

Exemplo postBanUserFromComment

Copy

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

postBanUserUndo

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postBanUserUndo

Copy

const tenantId: string = "tenant_9876";
const undoParams: BanUserUndoParams = {
  userId: "user_12345",
  // campos adicionais obrigatórios podem ser adicionados aqui
};
const resultWithoutSSO: APIEmptyResponse = await postBanUserUndo(tenantId, undoParams);
const ssoToken: string = "sso_abcdef123456";
const resultWithSSO: APIEmptyResponse = await postBanUserUndo(tenantId, undoParams, ssoToken);

postBulkPreBanSummary

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
bulkPreBanParams	BulkPreBanParams	Sim
includeByUserIdAndEmail	boolean	Não
includeByIP	boolean	Não
includeByEmailDomain	boolean	Não
sso	string	Não

Resposta

Retorna: BulkPreBanSummary

Exemplo

postBulkPreBanSummary Exemplo

Copy

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

postCommentsByIds

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentsByIdsParams	CommentsByIdsParams	Yes
sso	string	No

Resposta

Returns: ModerationAPIChildCommentsResponse

Exemplo

Exemplo postCommentsByIds

Copy

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

postFlagComment

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postFlagComment

Copy

async function runExample() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  // Apenas parâmetros obrigatórios
  const result1: APIEmptyResponse = await postFlagComment(tenantId, commentId);
  // Incluindo parâmetros opcionais
  const broadcastId: string = "brd_54321";
  const sso: string = "user@example.com";
  const result2: APIEmptyResponse = await postFlagComment(tenantId, commentId, broadcastId, sso);
  console.log(result1, result2);
}
runExample();

postRemoveComment

Parâmetros

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

Resposta

Retorna: PostRemoveCommentApiResponse

Exemplo

Exemplo postRemoveComment

Copy

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

postRestoreDeletedComment

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postRestoreDeletedComment

Copy

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

postSetCommentApprovalStatus

Parâmetros

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

Resposta

Retorna: SetCommentApprovedResponse

Exemplo

Exemplo de postSetCommentApprovalStatus

Copy

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

postSetCommentReviewStatus

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

postSetCommentReviewStatus Exemplo

Copy

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

postSetCommentSpamStatus

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postSetCommentSpamStatus

Copy

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

postSetCommentText

Parâmetros

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

Resposta

Returns: SetCommentTextResponse

Exemplo

Exemplo postSetCommentText

Copy

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

postUnFlagComment

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postUnFlagComment

Copy

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

postVote

Parameters

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

Response

Retorna: VoteResponse

Example

postVote Exemplo

Copy

async function runVoteExamples(): Promise<void> {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_1234567890";
  // Chamar apenas com parâmetros obrigatórios
  const simpleVote: VoteResponse = await postVote(tenantId, commentId);
  // Chamar com parâmetros opcionais
  const direction: string = "down";
  const broadcastId: string = "brd_987654321";
  const sso: string = "user-42";
  const detailedVote: VoteResponse = await postVote(tenantId, commentId, direction, broadcastId, sso);
  console.log(simpleVote, detailedVote);
}

putAwardBadge

Parâmetros

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

Resposta

Retorna: AwardUserBadgeResponse

Exemplo

Exemplo putAwardBadge

Copy

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

putCloseThread

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

putCloseThread Exemplo

Copy

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

putRemoveBadge

Parâmetros

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

Resposta

Retorna: RemoveUserBadgeResponse

Exemplo

Exemplo putRemoveBadge

Copy

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

putReopenThread

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

putReopenThread Exemplo

Copy

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

setTrustFactor

Parâmetros

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

Resposta

Retorna: SetUserTrustFactorResponse

Exemplo

Exemplo setTrustFactor

Copy

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

createModerator

Parâmetros

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

Resposta

Retorna: CreateModeratorResponse

Exemplo

Exemplo createModerator

Copy

const tenantId: string = "tenant_12345";
const moderatorPayload: CreateModeratorBody = {
  userId: "user_9876",
  // campo opcional; pode ser omitido se não for necessário
  notes: "Temporary moderator for event"
};
const response: CreateModeratorResponse = await createModerator(tenantId, moderatorPayload);

deleteModerator

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteModerator

Copy

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

getModerator

Parâmetros

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

Resposta

Retorna: GetModeratorResponse

Exemplo

Exemplo getModerator

Copy

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

getModerators

Parâmetros

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

Resposta

Retorna: GetModeratorsResponse

Exemplo

Exemplo getModerators

Copy

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

sendInvite

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo sendInvite

Copy

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

updateModerator

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateModerator

Copy

const tenantId: string = "tenant_9f8b7c6d";
const moderatorId: string = "mod_12345";
const updateBody: UpdateModeratorBody = {
  isActive: true,
  // role?: string é opcional e omitido aqui
};
const result: APIEmptyResponse = await updateModerator(tenantId, moderatorId, updateBody);

deleteNotificationCount

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteNotificationCount

Copy

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

getCachedNotificationCount

Parâmetros

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

Resposta

Retorna: GetCachedNotificationCountResponse

Exemplo

Exemplo getCachedNotificationCount

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const id: string = "user_9876";
  const response: GetCachedNotificationCountResponse = 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: GetNotificationCountResponse

Exemplo

Exemplo getNotificationCount

Copy

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

getNotifications

Parâmetros

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

Exemplo

Exemplo getNotifications

Copy

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

updateNotification

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de updateNotification

Copy

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

createV1PageReact

Parâmetros

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

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo createV1PageReact

Copy

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

createV2PageReact

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
id	string	Sim
title	string	Não
sso	string	Não

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo createV2PageReact

Copy

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

deleteV1PageReact

Parâmetros

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

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo deleteV1PageReact

Copy

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

deleteV2PageReact

Parâmetros

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

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo deleteV2PageReact

Copy

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

getV1PageLikes

Parâmetros

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

Resposta

Retorna: GetV1PageLikes

Exemplo

Exemplo getV1PageLikes

Copy

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

getV2PageReacts

Parâmetros

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

Resposta

Retorna: GetV2PageReacts

Exemplo

Exemplo getV2PageReacts

Copy

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

getV2PageReactUsers

Parâmetros

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

Resposta

Retorna: GetV2PageReactUsersResponse

Exemplo

Exemplo getV2PageReactUsers

Copy

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

addPage

Parâmetros

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

Resposta

Retorna: AddPageAPIResponse

Exemplo

addPage Exemplo

Copy

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

deletePage

Parâmetros

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

Resposta

Retorna: DeletePageAPIResponse

Exemplo

Exemplo deletePage

Copy

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

getOfflineUsers

Comentadores anteriores na página que NÃO estão online no momento. Ordenados por displayName.
Use isso após esgotar /users/online para renderizar uma seção “Members”.
Paginação por cursor em commenterName: o servidor percorre o parcial {tenantId, urlId, commenterName}
índice a partir de afterName avançando via $gt, sem custo de $skip.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Sim
afterName	string	Não
afterUserId	string	Não

Resposta

Retorna: PageUsersOfflineResponse

Exemplo

Exemplo getOfflineUsers

Copy

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

getOnlineUsers

Visualizadores atualmente online de uma página: pessoas cuja sessão websocket está inscrita na página neste momento.
Retorna anonCount + totalCount (assinantes de toda a sala, incluindo visualizadores anônimos que não enumeramos).

Parameters

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

Response

Retorna: PageUsersOnlineResponse

Example

Exemplo getOnlineUsers

Copy

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

getPageByURLId

Parâmetros

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

Resposta

Retorna: GetPageByURLIdAPIResponse

Exemplo

Exemplo getPageByURLId

Copy

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

getPages

Parâmetros

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

Resposta

Retorna: GetPagesAPIResponse

Exemplo

Exemplo getPages

Copy

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

getPagesPublic

Lista páginas para um tenant. Usado pelo cliente desktop FChat para preencher sua lista de salas. Requer que enableFChat seja true na configuração personalizada resolvida para cada página. Páginas que requerem SSO são filtradas de acordo com o acesso ao grupo do usuário solicitante.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
cursor	string	Não
limit	number	Não
q	string	Não
sortBy	PagesSortBy	Não
hasComments	boolean	Não

Resposta

Retorna: GetPublicPagesResponse

Exemplo

Exemplo getPagesPublic

Copy

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

getUsersInfo

Informações de usuário em massa para um locatário. Dado userIds, retorna informações de exibição do User / SSOUser.
Usado pelo widget de comentários para enriquecer usuários que acabaram de aparecer via um evento de presença.
Sem contexto de página: a privacidade é aplicada uniformemente (perfís privados são mascarados).

Parameters

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

Response

Returns: PageUsersInfoResponse

Example

Exemplo getUsersInfo

Copy

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

patchPage

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	Yes
updateAPIPageData	UpdateAPIPageData	Yes

Resposta

Retorna: PatchPageAPIResponse

Exemplo

patchPage Exemplo

Copy

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

deletePendingWebhookEvent

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

deletePendingWebhookEvent Exemplo

Copy

async function runDeletion() {
  const tenantId: string = "tenant-42f7b9c2";
  const eventId: string = "webhook-event-8a7d6c5b";
  const result: APIEmptyResponse = await deletePendingWebhookEvent(tenantId, eventId);
  console.log(result);
}

getPendingWebhookEventCount

Parâmetros

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

Resposta

Retorna: GetPendingWebhookEventCountResponse

Exemplo

Exemplo getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parâmetros

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

Exemplo

Exemplo getPendingWebhookEvents

Copy

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

createPollVote

Registre um voto em uma enquete ou mova um voto existente para uma opção diferente. Um eleitor tem no máximo um voto por enquete, portanto chamar isso novamente para o mesmo eleitor move seu voto em vez de adicionar um novo.

Isso segue as configurações de enquete do site: se a votação estiver configurada apenas para usuários autenticados, um voto com apenas um anonUserId é rejeitado, e votos anônimos são limitados por taxa por IP por enquete.

Parâmetros

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

Resposta

Retorna: CreatePollVoteResponse

Exemplo

Exemplo createPollVote

Copy

(async () => {
  const tenantId: string = "acme-corp-tenant";
  const vote: CreatePollVoteBody = {
    pollId: "poll-2024-09",
    optionId: "option-A"
    // userId é opcional e omitido aqui
  };
  const result: CreatePollVoteResponse = await createPollVote(tenantId, vote);
  console.log(result);
})();

deletePollVote

Retract a vote. The option it was cast on gives its tally back.

Parameters

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

Response

Retorna: DeletePollVoteResponse

Example

Exemplo deletePollVote

Copy

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

getPollVote

Parâmetros

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

Resposta

Retorna: GetPollVoteResponse

Exemplo

Exemplo getPollVote

Copy

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

getPollVotes

Os votos individuais por trás da contagem de uma enquete, do mais antigo ao mais recente.

Uma enquete pertence a um comentário, portanto os votos são sempre lidos uma enquete por vez – commentId é obrigatório. Isso mantém cada consulta nos índices que a coleção já possui.

Obedece à privacidade da enquete: os votos de uma enquete anônima não podem ser lidos (poll-anonymous), aqui ou por ID.

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
voterId	string	Não
optionId	string	Não
skip	number	Não

Response

Retorna: GetPollVotesResponse

Exemplo

Exemplo getPollVotes

Copy

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

deletePoll

Remova uma enquete do seu comentário, juntamente com todos os votos lançados nela. O próprio comentário permanece intacto.

Parameters

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deletePoll

Copy

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

getPoll

Parâmetros

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

Resposta

Retorna: GetPollResponse

Exemplo

Exemplo getPoll

Copy

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

patchPoll

Edite uma enquete no local, mantendo suas contagens: altere a pergunta, renomeie uma opção, feche ou reabra-a, ou altere quem pode ver os votantes. As opções são referenciadas por id – para adicionar, remover ou reordenar, faça PUT da lista completa.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
commentPollPatch	CommentPollPatch	Sim

Resposta

Retorna: SavePollResponse

Exemplo

Exemplo patchPoll

Copy

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

putPoll

Anexe uma enquete a um comentário, ou defina o estado completo da enquete que ele já possui.

As opções são correspondidas por id: uma opção enviada com o id de uma opção existente mantém seus votos (e recebe o novo rótulo e posição), uma opção enviada sem id é adicionada, e opções existentes que não constam na lista são removidas juntamente com os votos lançados nelas.

Manter nenhum id de opção existente em uma enquete que tem votos exclui todas elas, portanto é necessário replaceVotes=true.

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Sim
commentId	string	Sim
commentPollPutInput	CommentPollPutInput	Sim
replaceVotes	boolean	Não

Response

Retorna: SavePollResponse

Exemplo

Exemplo putPoll

Copy

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

createQuestionConfig

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

Resposta

Retorna: CreateQuestionConfigResponse

Exemplo

Exemplo createQuestionConfig

Copy

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

deleteQuestionConfig

Parameters

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

Response

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteQuestionConfig

Copy

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

getQuestionConfig

Parâmetros

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

Resposta

Retorna: GetQuestionConfigResponse

Exemplo

Exemplo getQuestionConfig

Copy

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

getQuestionConfigs

Parâmetros

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

Resposta

Retorna: GetQuestionConfigsResponse

Exemplo

Exemplo getQuestionConfigs

Copy

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

updateQuestionConfig

Parâmetros

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateQuestionConfig

Copy

(async () => {
  const tenantId: string = "acme-corp-tenant";
  const questionId: string = "question-42";
  const updateBody: UpdateQuestionConfigBody = {
    title: "Revised FAQ Question"
    // isActive, customOptions, etc. são opcionais e omitidos
  };
  const response: APIEmptyResponse = await updateQuestionConfig(tenantId, questionId, updateBody);
  console.log(response);
})();

createQuestionResult

Parâmetros

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

Resposta

Retorna: CreateQuestionResultResponse

Exemplo

Exemplo createQuestionResult

Copy

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

deleteQuestionResult

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteQuestionResult

Copy

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

getQuestionResult

Parameters

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

Response

Retorna: GetQuestionResultResponse

Exemplo

Exemplo getQuestionResult

Copy

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

getQuestionResults

Parameters

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

Response

Returns: GetQuestionResultsResponse

Example

Exemplo getQuestionResults

Copy

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

updateQuestionResult

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateQuestionResultBody	UpdateQuestionResultBody	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de updateQuestionResult

Copy

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

aggregateQuestionResults

Parâmetros

Name	Type	Required
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Resposta

Retorna: AggregateQuestionResultsResponse

Exemplo

Exemplo aggregateQuestionResults

Copy

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

bulkAggregateQuestionResults

Parâmetros

Name	Type	Required
tenantId	string	Sim
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Sim
forceRecalculate	boolean	Não

Resposta

Retorna: BulkAggregateQuestionResultsResponse

Exemplo

Exemplo bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

Resposta

Retorna: CombineQuestionResultsWithCommentsResponse

Exemplo

Exemplo combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parâmetros

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

Resposta

Retorna: AddSSOUserAPIResponse

Exemplo

Exemplo addSSOUser

Copy

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

deleteSSOUser

Parâmetros

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

Resposta

Retorna: DeleteSSOUserAPIResponse

Exemplo

Exemplo deleteSSOUser

Copy

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

getSSOUserByEmail

Parâmetros

Name	Type	Required	Description
tenantId	string	Sim
email	string	Sim

Resposta

Retorna: GetSSOUserByEmailAPIResponse

Exemplo

Exemplo getSSOUserByEmail

Copy

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

getSSOUserById

Parâmetros

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

Resposta

Retorna: GetSSOUserByIdAPIResponse

Exemplo

getSSOUserById Exemplo

Copy

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

getSSOUsers

Parâmetros

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

Resposta

Retorna: GetSSOUsersResponse

Exemplo

Exemplo getSSOUsers

Copy

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

patchSSOUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

Resposta

Retorna: PatchSSOUserAPIResponse

Exemplo

Exemplo de patchSSOUser

Copy

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

putSSOUser

Parâmetros

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

Resposta

Retorna: PutSSOUserAPIResponse

Exemplo

putSSOUser Exemplo

Copy

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

createSubscription

Parâmetros

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

Resposta

Retorna: CreateSubscriptionAPIResponse

Exemplo

createSubscription Exemplo

Copy

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

deleteSubscription

Parâmetros

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

Resposta

Retorna: DeleteSubscriptionAPIResponse

Exemplo

Exemplo deleteSubscription

Copy

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

getSubscriptions

Parâmetros

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

Resposta

Retorna: GetSubscriptionsAPIResponse

Exemplo

Exemplo getSubscriptions

Copy

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

updateSubscription

Parâmetros

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

Resposta

Retorna: UpdateSubscriptionAPIResponse

Exemplo

Exemplo updateSubscription

Copy

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

getTenantDailyUsages

Parâmetros

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

Exemplo

Exemplo getTenantDailyUsages

Copy

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

createTenantPackage

Parâmetros

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

Resposta

Retorna: CreateTenantPackageResponse

Exemplo

Exemplo createTenantPackage

Copy

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

deleteTenantPackage

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteTenantPackage

Copy

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

getTenantPackage

Parameters

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

Response

Retorna: GetTenantPackageResponse

Example

Exemplo getTenantPackage

Copy

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

getTenantPackages

Parâmetros

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

Resposta

Retorna: GetTenantPackagesResponse

Exemplo

Exemplo getTenantPackages

Copy

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

replaceTenantPackage

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
replaceTenantPackageBody	ReplaceTenantPackageBody	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo replaceTenantPackage

Copy

async function replacePackageDemo(): Promise<void> {
  const tenantId: string = "acme-corp-001";
  const packageId: string = "basic-plan-2023";
  const replaceBody: ReplaceTenantPackageBody = {
    newPackageId: "enterprise-plan-2024"
    // campos opcionais podem ser adicionados aqui se necessário
  };
  const response: APIEmptyResponse = await replaceTenantPackage(tenantId, packageId, replaceBody);
  console.log(response);
}

updateTenantPackage

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateTenantPackage

Copy

const tenantId: string = "tenant_9f8b7c6d";
const packageId: string = "pkg_3a2b1c";
const updateBody: UpdateTenantPackageBody = {
  // campos opcionais podem ser omitidos ou incluídos conforme necessário
  // newPackageName?: string;
  // renewalDate?: string;
};
const result: APIEmptyResponse = await updateTenantPackage(tenantId, packageId, updateBody);

createTenantUser

Parâmetros

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

Resposta

Retorna: CreateTenantUserResponse

Exemplo

createTenantUser Exemplo

Copy

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

deleteTenantUser

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

deleteTenantUser Exemplo

Copy

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

getTenantUser

Parâmetros

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

Resposta

Retorna: GetTenantUserResponse

Exemplo

Exemplo getTenantUser

Copy

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

getTenantUsers

Parâmetros

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

Resposta

Retorna: GetTenantUsersResponse

Exemplo

Exemplo getTenantUsers

Copy

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

replaceTenantUser

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo replaceTenantUser

Copy

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

sendLoginLink

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo sendLoginLink

Copy

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

updateTenantUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
id	string	Sim
updateTenantUserBody	UpdateTenantUserBody	Sim
updateComments	string	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateTenantUser

Copy

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

createTenant

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

Resposta

Retorna: CreateTenantResponse

Exemplo

Exemplo createTenant

Copy

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

deleteTenant

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteTenant

Copy

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

getTenant

Parâmetros

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

Resposta

Retorna: GetTenantResponse

Exemplo

Exemplo getTenant

Copy

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

getTenants

Parâmetros

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

Resposta

Retorna: GetTenantsResponse

Exemplo

Exemplo getTenants

Copy

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

updateTenant

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateTenant

Copy

async function runUpdateTenant() {
  const tenantId: string = "tenant-abc123";
  const id: string = "config-456def";
  const updateTenantBody: UpdateTenantBody = {
    // campo obrigatório
    name: "Acme International",
    // campos opcionais podem ser omitidos, por exemplo, billingInfo, domainConfiguration
  };
  const response: APIEmptyResponse = await updateTenant(tenantId, id, updateTenantBody);
  console.log(response);
}

changeTicketState

Parâmetros

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

Resposta

Retorna: ChangeTicketStateResponse

Exemplo

Exemplo changeTicketState

Copy

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

createTicket

Parâmetros

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

Resposta

Retorna: CreateTicketResponse

Exemplo

Exemplo createTicket

Copy

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

getTicket

Parâmetros

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

Resposta

Retorna: GetTicketResponse

Exemplo

Exemplo getTicket

Copy

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

getTickets

Parâmetros

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

Exemplo

Exemplo getTickets

Copy

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

getTranslations

Parâmetros

Nome	Tipo	Obrigatório
namespace	string	Sim
component	string	Sim
locale	string	Não
useFullTranslationIds	boolean	Não

Resposta

Retorna: GetTranslationsResponse

Exemplo

Exemplo getTranslations

Copy

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

uploadImage

Carregar 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

Exemplo

Exemplo uploadImage

Copy

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

getUserBadgeProgressById

Parâmetros

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

Resposta

Retorna: APIGetUserBadgeProgressResponse

Exemplo

Exemplo getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parâmetros

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

Resposta

Retorna: APIGetUserBadgeProgressResponse

Exemplo

Exemplo getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parâmetros

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

Resposta

Retorna: APIGetUserBadgeProgressListResponse

Exemplo

Exemplo getUserBadgeProgressList

Copy

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

createUserBadge

Parâmetros

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

Resposta

Retorna: APICreateUserBadgeResponse

Exemplo

Exemplo createUserBadge

Copy

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

deleteUserBadge

Parâmetros

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

Resposta

Retorna: APIEmptySuccessResponse

Exemplo

deleteUserBadge Exemplo

Copy

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

getUserBadge

Parâmetros

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

Resposta

Retorna: APIGetUserBadgeResponse

Exemplo

Exemplo getUserBadge

Copy

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

getUserBadges

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

Resposta

Retorna: APIGetUserBadgesResponse

Exemplo

Exemplo getUserBadges

Copy

(async () => {
  const tenantId: string = "acme-corp";
  // Todos os parâmetros fornecidos
  const fullResponse: APIGetUserBadgesResponse = await getUserBadges(
    tenantId,
    "user-42",
    "badge-premium",
    1,
    true,
    10,
    0
  );
  // Apenas os parâmetros obrigatórios e um opcional (limit)
  const limitedResponse: APIGetUserBadgesResponse = await getUserBadges(
    tenantId,
    undefined,
    undefined,
    undefined,
    undefined,
    5
  );
  console.log(fullResponse, limitedResponse);
})();

updateUserBadge

Parâmetros

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

Resposta

Retorna: APIEmptySuccessResponse

Exemplo

Exemplo updateUserBadge

Copy

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

getUserNotificationCount

Parameters

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

Response

Retorna: GetUserNotificationCountResponse

Exemplo

Exemplo getUserNotificationCount

Copy

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

getUserNotifications

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
urlId	string	Não
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
includeTenantNotifications	boolean	Não
sso	string	Não

Resposta

Retorna: GetMyNotificationsResponse

Exemplo

Exemplo getUserNotifications

Copy

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

resetUserNotificationCount

Parâmetros

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

Resposta

Retorna: ResetUserNotificationsResponse

Exemplo

Exemplo de resetUserNotificationCount

Copy

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

resetUserNotifications

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Resposta

Retorna: ResetUserNotificationsResponse

Exemplo

resetUserNotifications Exemplo

Copy

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

updateUserNotificationCommentSubscriptionStatus

Enable ou desabilite 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: UpdateUserNotificationCommentSubscriptionStatusResponse

Exemplo

Exemplo de updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

Enable ou desabilite 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: UpdateUserNotificationPageSubscriptionStatusResponse

Exemplo

Exemplo de updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parameters

Name	Type	Required
tenantId	string	Sim
notificationId	string	Sim
newStatus	UpdateUserNotificationStatusNewStatusEnum	Sim
sso	string	Não

Response

Retorna: UpdateUserNotificationStatusResponse

Example

Exemplo de updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parâmetros

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

Resposta

Retorna: GetUserPresenceStatusesResponse

Exemplo

Exemplo getUserPresenceStatuses

Copy

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

searchUsers

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

Resposta

Retorna: SearchUsersResult

Exemplo

Exemplo de searchUsers

Copy

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

getUser

Parâmetros

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

Resposta

Retorna: GetUserResponse

Exemplo

Exemplo getUser

Copy

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

createVote

Parâmetros

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

Resposta

Retorna: VoteResponse

Exemplo

createVote Exemplo

Copy

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

deleteVote

Parâmetros

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

Resposta

Retorna: VoteDeleteResponse

Exemplo

Exemplo deleteVote

Copy

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

getVotes

Parâmetros

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

Resposta

Retorna: GetVotesResponse

Exemplo

Exemplo getVotes

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "article-67890";
(async () => {
  const votesResponse: GetVotesResponse = await getVotes(tenantId, urlId);
  // Exemplo de acesso a uma propriedade opcional da resposta
  const firstVote: PublicVote | undefined = votesResponse.votes?.[0];
})();

getVotesForUser

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

Resposta

Retorna: GetVotesForUserResponse

Exemplo

Exemplo getVotesForUser

Copy

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

createWebhook

Inscreve uma URL em um evento de comentário (inscrição de hook REST). Inscrever a mesma URL no mesmo evento e domínio novamente retorna a inscrição existente. As entregas são assinadas com HMAC, veja o guia de webhooks; o cabeçalho legado token nunca é enviado para inscrições de API.

Parameters

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

Response

Retorna: CreateWebhookResponse

Example

Exemplo createWebhook

Copy

const tenantId: string = "tenant_9f8b7c6d";
const webhookParams: CreateWebhookParams = {
  event: "comment.created" as WebhookEventName,
  method: "POST" as WebhookHTTPMethod,
  url: "https://myapp.example.com/webhook",
  source: "comment" as WebhookSource,
  // segredo opcional para verificação da carga útil
  secret: "s3cr3tK3y123",
};
const result: CreateWebhookResponse = await createWebhook(tenantId, webhookParams);
const webhookId: string = result.webhook.id;

deleteWebhook

Cancelamentos de inscrição (REST hook unsubscribe). Apenas assinaturas criadas através desta API podem ser excluídas aqui; webhooks gerenciados pelo painel são editados no painel.

Parameters

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

Response

Returns: APIEmptyResponse

Example

Exemplo deleteWebhook

Copy

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

getWebhooks

Lista os webhooks configurados para o tenant, tanto linhas gerenciadas pelo painel quanto assinaturas de API.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
event	WebhookEventName	Não
domain	string	Não
source	WebhookSource	Não
skip	number	Não

Resposta

Retorna: GetWebhooksResponse

Exemplo

Exemplo getWebhooks

Copy

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

getWebhookSamplePayloads

Recent comments exactly in the shape webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
event	WebhookEventName	Não
limit	number	Não

Resposta

Retorna: GetWebhookSamplePayloadsResponse

Exemplo

Exemplo getWebhookSamplePayloads

Copy

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

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)

Documentação

Começando

Referência da API

Uso

Inquilinos de Agente

Agregação

Logs de Auditoria

Bloqueio de Comentário

Verificar Comentários Bloqueados

Comentários

Comentários para Usuário

Configurações de Domínio

Modelos de Email

Log de Eventos

Publicações no Feed

Denunciar Comentário

GIFs

Hashtags

Eu

Moderação

Moderadores

Contagem de Notificações

Notificações

Reações de Página

Páginas

Eventos de Webhook Pendentes

Votos de Enquete

Enquetes

Configurações de Pergunta

Resultados de Pergunta

Agregação de Resultados de Pergunta

Usuários SSO

Assinaturas

Uso Diário do Inquilino

Pacotes de Inquilino

Usuários de Inquilino

Inquilinos

Tickets

Traduções

Upload de Imagem

Progresso de Badge do Usuário

Badges de Usuário

Notificações do Usuário

Status de Presença do Usuário

Busca de Usuários

Usuários

Votos

Webhooks

FastComments SDK JavaScript/TypeScript

Repositório

Agentes de codificação IA

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 Public API (compatível com navegador)

Exemplo: Usando a Default API (somente no servidor)

Exemplo: Usando a Moderation API

Integração SSO (Login Único)

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