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

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

SSO (Single Sign-On) - Integração

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

SSO Simples (Apenas no Lado do Servidor)

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

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

// Crie um SSO simples usando o helper embutido  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

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

SSO Seguro (Lado do Servidor, Recomendado)

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

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

// Crie um SSO seguro usando o helper embutido
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

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

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

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

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

// Obtenha o token SSO do endpoint do seu servidor
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use o token SSO gerado no servidor
});

SSO com Criação de Comentário

// Lado do servidor: Crie SSO e comentário
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Casos de Uso Comuns

Obtendo Comentários de uma Página

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

Criando um Comentário

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

Votando em um Comentário

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

Gerenciamento de Usuários (Requer Chave de API)

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

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

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

Eventos por página

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

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

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

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

Inscreva-se em eventos do usuário

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

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

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

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Show notification in your UI
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close when done
userSubscription.close();

Obtendo userIdWS

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

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

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

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

IDs de Transmissão

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

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // ID único para esta operação
  }
});

Tratamento de Erros

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

Agregação

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

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

Obter registros de auditoria

Parâmetros

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

Resposta

Retorna: GetAuditLogsResponse1

Exemplo

Exemplo getAuditLogs

Copy

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

Bloquear a partir de comentário (público)

Parâmetros

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

Resposta

Retorna: BlockFromCommentPublicResponse

Exemplo

Exemplo blockFromCommentPublic

Copy

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

Desbloquear comentário (público)

Parâmetros

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

Resposta

Retorna: UnBlockCommentPublicResponse

Exemplo

Exemplo de unBlockCommentPublic

Copy

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

Verificar comentários bloqueados

Parâmetros

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

Resposta

Retorna: CheckedCommentsForBlockedResponse

Exemplo

Exemplo checkedCommentsForBlocked

Copy

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

Bloquear usuário do comentário

Parâmetros

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

Resposta

Retorna: BlockUserFromCommentResponse

Exemplo

Exemplo de blockUserFromComment

Copy

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

Criar comentário (público)

Parâmetros

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

Resposta

Retorna: CreateCommentPublicResponse

Exemplo

Exemplo createCommentPublic

Copy

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

Excluir comentário

Parâmetros

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

Resposta

Retorna: DeleteCommentResponse

Exemplo

Exemplo deleteComment

Copy

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

Excluir comentário (público)

Parâmetros

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

Resposta

Retorna: DeleteCommentPublicResponse

Exemplo

Exemplo deleteCommentPublic

Copy

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

Excluir voto de comentário

Parâmetros

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

Resposta

Retorna: DeleteCommentVoteResponse

Exemplo

Exemplo deleteCommentVote

Copy

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

Denunciar comentário

Parâmetros

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

Resposta

Retorna: FlagCommentResponse1

Exemplo

Exemplo de flagComment

Copy

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

Obter comentário

Parâmetros

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

Resposta

Retorna: GetCommentResponse

Exemplo

Exemplo getComment

Copy

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

Obter comentários

Parâmetros

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

Resposta

Retorna: GetCommentsResponse

Exemplo

Exemplo getComments

Copy

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

Obter comentários (público)

req tenantId urlId

Parâmetros

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

Resposta

Retorna: GetCommentsPublicResponse

Exemplo

Exemplo getCommentsPublic

Copy

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

Obter texto do comentário

Parâmetros

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

Resposta

Retorna: GetCommentTextResponse1

Exemplo

Exemplo getCommentText

Copy

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

Obter nomes de usuários que votaram no comentário

Parâmetros

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

Resposta

Retorna: GetCommentVoteUserNamesResponse

Exemplo

Exemplo getCommentVoteUserNames

Copy

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

---

Bloquear comentário

Parâmetros

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

Resposta

Retorna: LockCommentResponse

Exemplo

Exemplo lockComment

Copy

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

Fixar comentário

Parâmetros

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

Resposta

Retorna: PinCommentResponse

Exemplo

Exemplo pinComment

Copy

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

Salvar comentário

Parâmetros

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

Resposta

Retorna: SaveCommentResponse

Exemplo

saveComment Exemplo

Copy

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

Salvar comentários em massa

Parâmetros

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

Resposta

Retorna: Array<SaveCommentsBulkResponse

Exemplo

Exemplo saveCommentsBulk

Copy

const tenantId: string = "tenant_9f8b7c6d";
const bulkComments: CreateCommentParams[] = [
  {
    content: "Welcome to the new forum thread!",
    authorId: "user_42",
    mentions: [{ userId: "user_84", username: "alice" }],
    hashtags: [{ tag: "intro" }]
  },
  {
    content: "Please review the updated guidelines.",
    authorId: "moderator_1",
    mentions: [],
    hashtags: [{ tag: "guidelines" }, { tag: "update" }]
  }
];
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  bulkComments,
  true,      // isLive
  false,     // doSpamCheck
  true,      // sendEmails
  undefined  // populateNotifications (using default)
);

Definir texto do comentário

Parâmetros

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

Resposta

Retorna: SetCommentTextResponse1

Exemplo

Exemplo setCommentText

Copy

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

Desbloquear usuário do comentário

Parameters

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

Resposta

Retorna: UnBlockUserFromCommentResponse

Exemplo

unBlockUserFromComment Exemplo

Copy

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

Remover denúncia do comentário

Parâmetros

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

Resposta

Retorna: UnFlagCommentResponse

Exemplo

Exemplo unFlagComment

Copy

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

Desbloquear comentário

Parâmetros

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

Resposta

Retorna: UnLockCommentResponse

Exemplo

Exemplo de unLockComment

Copy

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

Remover fixação do comentário

Parâmetros

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

Resposta

Retorna: UnPinCommentResponse

Exemplo

Exemplo unPinComment

Copy

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

Atualizar comentário

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

Exemplo

Exemplo updateComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // campos de exemplo; a forma real depende da definição da API
  // por exemplo, body: "Conteúdo do comentário editado",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

Votar em comentário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
voteBodyParams	VoteBodyParams	Yes
sessionId	string	No
sso	string	No

Resposta

Retorna: VoteCommentResponse

Exemplo

Exemplo voteComment

Copy

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

Obter comentários do usuário

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

Exemplo

Exemplo getCommentsForUser

Copy

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

Adicionar configuração de domínio

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

Excluir configuração de domínio

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

Obter configuração de domínio

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

Obter configurações de domínio

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

Atualizar configuração de domínio (parcial)

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

Substituir configuração de domínio

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

Criar modelo de e-mail

Parâmetros

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

Resposta

Retorna: CreateEmailTemplateResponse1

Exemplo

Exemplo createEmailTemplate

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // campos opcionais como textContent, isActive são omitidos para demonstrar parâmetros opcionais
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

Excluir modelo de e-mail

Parâmetros

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

Resposta

Retorna: DeleteEmailTemplateResponse

Exemplo

Exemplo deleteEmailTemplate

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // Exemplo de acesso a uma propriedade opcional da resposta
  const statusCode: number | undefined = response.status?.code;
}();

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

Parâmetros

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

Resposta

Retorna: DeleteEmailTemplateRenderErrorResponse

Exemplo

Exemplo deleteEmailTemplateRenderError

Copy

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

Obter modelo de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplateResponse1

Exemplo

Exemplo getEmailTemplate

Copy

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

Obter definições de modelos de e-mail

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes

Resposta

Retorna: GetEmailTemplateDefinitionsResponse1

Exemplo

Exemplo getEmailTemplateDefinitions

Copy

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

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

Parâmetros

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

Resposta

Retorna: GetEmailTemplateRenderErrorsResponse1

Exemplo

getEmailTemplateRenderErrors Exemplo

Copy

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

Obter modelos de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplatesResponse1

Exemplo

Exemplo getEmailTemplates

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Chamada sem o parâmetro opcional 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Chamada com o parâmetro opcional 'skip'
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

Renderizar modelo de e-mail

Parâmetros

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

Resposta

Retorna: RenderEmailTemplateResponse1

Exemplo

Exemplo renderEmailTemplate

Copy

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

Atualizar modelo de e-mail

Parâmetros

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

Resposta

Retorna: UpdateEmailTemplateResponse

Exemplo

Exemplo updateEmailTemplate

Copy

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

Obter log de eventos

req tenantId urlId userIdWS

Parâmetros

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

Resposta

Retorna: GetEventLogResponse1

Exemplo

Exemplo getEventLog

Copy

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

Obter log de eventos global

req tenantId urlId userIdWS

Parâmetros

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

Resposta

Retorna: GetGlobalEventLogResponse

Exemplo

Exemplo getGlobalEventLog

Copy

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

Criar publicação do feed

Parameters

Nome	Tipo	Obrigatório
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Response

Retorna: CreateFeedPostResponse1

Example

Exemplo createFeedPost

Copy

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

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

Parâmetros

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

Resposta

Retorna: CreateFeedPostPublicResponse

Exemplo

Exemplo createFeedPostPublic

Copy

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

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

Parâmetros

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

Resposta

Retorna: DeleteFeedPostPublicResponse

Exemplo

Exemplo deleteFeedPostPublic

Copy

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

Obter publicações do feed

req tenantId afterId

Parâmetros

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No

Resposta

Retorna: GetFeedPostsResponse1

Exemplo

Exemplo getFeedPosts

Copy

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

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

req tenantId afterId

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

Resposta

Retorna: GetFeedPostsPublicResponse

Exemplo

Exemplo getFeedPostsPublic

Copy

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

Obter estatísticas das publicações do feed

Parâmetros

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

Resposta

Retorna: GetFeedPostsStatsResponse

Exemplo

Exemplo getFeedPostsStats

Copy

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

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

Parâmetros

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

Resposta

Retorna: GetUserReactsPublicResponse

Exemplo

Exemplo getUserReactsPublic

Copy

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

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

Parâmetros

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

Resposta

Retorna: ReactFeedPostPublicResponse

Exemplo

Exemplo reactFeedPostPublic

Copy

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

Atualizar publicação do feed

Parâmetros

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

Resposta

Retorna: UpdateFeedPostResponse

Exemplo

Exemplo updateFeedPost

Copy

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

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

Parameters

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

Response

Retorna: UpdateFeedPostPublicResponse

Exemplo

updateFeedPostPublic Exemplo

Copy

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

Denunciar comentário (público)

Parâmetros

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

Resposta

Retorna: FlagCommentPublicResponse

Exemplo

Exemplo flagCommentPublic

Copy

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

Obter GIF grande

Parâmetros

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

Resposta

Retorna: GetGifLargeResponse

Exemplo

Exemplo getGifLarge

Copy

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

Pesquisar GIFs

Parâmetros

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

GIFs em alta

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

Adicionar hashtag

Parâmetros

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

Resposta

Retorna: AddHashTagResponse

Exemplo

Exemplo addHashTag

Copy

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

Adicionar hashtags em massa

Parâmetros

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

Resposta

Retorna: AddHashTagsBulkResponse

Exemplo

addHashTagsBulk Exemplo

Copy

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

Excluir hashtag

Parâmetros

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

Resposta

Retorna: DeleteHashTagResponse

Exemplo

Exemplo deleteHashTag

Copy

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

Obter hashtags

Parâmetros

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

Resposta

Retorna: GetHashTagsResponse1

Exemplo

getHashTags Exemplo

Copy

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

Atualizar hashtag (parcial)

Parâmetros

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

Resposta

Retorna: PatchHashTagResponse

Exemplo

Exemplo patchHashTag

Copy

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

Excluir voto de moderação

Parâmetros

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

Resposta

Retorna: DeleteModerationVoteResponse

Exemplo

Exemplo deleteModerationVote

Copy

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

Obter comentários da API

Parâmetros

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

Resposta

Retorna: GetApiCommentsResponse

Exemplo

Exemplo getApiComments

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // página
    25,                    // contagem
    "feedback",           // texto da pesquisa
    "192.168.1.100",      // por IP do comentário
    "approved",           // filtros
    "hasReplies",         // filtros de busca
    "dateDesc",           // ordenação
    false,                // demo
    "tenant-abc123",      // ID do inquilino
    "sso-token-xyz"       // sso
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

Obter status de exportação da API

Parâmetros

Name	Type	Required
batchJobId	string	No
tenantId	string	No
sso	string	No

Resposta

Retorna: GetApiExportStatusResponse

Exemplo

Exemplo getApiExportStatus

Copy

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

Obter IDs da API

Parâmetros

Nome	Tipo	Obrigatório
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Resposta

Retorna: GetApiIdsResponse

Exemplo

Exemplo getApiIds

Copy

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

Obter usuários banidos do comentário

Parâmetros

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

Resposta

Retorna: GetBanUsersFromCommentResponse

Exemplo

Exemplo getBanUsersFromComment

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // Chamar com todos os parâmetros
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // Chamar apenas com o parâmetro obrigatório
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

Obter status de banimento do comentário

Parâmetros

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

Resposta

Retorna: GetCommentBanStatusResponse1

Exemplo

Exemplo getCommentBanStatus

Copy

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

Obter respostas do comentário

Parâmetros

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

Resposta

Retorna: GetCommentChildrenResponse

Exemplo

getCommentChildren Exemplo

Copy

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

Obter contagem

Parâmetros

Nome	Tipo	Obrigatório
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Resposta

Retorna: GetCountResponse

Exemplo

Exemplo getCount

Copy

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

Obter contagens

Parâmetros

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

Resposta

Retorna: GetCountsResponse

Exemplo

Exemplo getCounts

Copy

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

Obter logs

Parâmetros

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

Resposta

Retorna: GetLogsResponse

Exemplo

getLogs Exemplo

Copy

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

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

Obter insígnias manuais

Parâmetros

Name	Type	Required	Description
tenantId	string	No
sso	string	No

Resposta

Retorna: GetManualBadgesResponse

Exemplo

Exemplo getManualBadges

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // Chamada com ambos os parâmetros opcionais
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // Chamada apenas com tenantId
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

Obter insígnias manuais do usuário

Parâmetros

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

Resposta

Retorna: GetManualBadgesForUserResponse

Exemplo

Exemplo getManualBadgesForUser

Copy

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

Obter comentário de moderação

Parâmetros

Nome	Tipo	Obrigatório
commentId	string	Yes
includeEmail	boolean	No
includeIP	boolean	No
tenantId	string	No
sso	string	No

Resposta

Retorna: GetModerationCommentResponse

Exemplo

Exemplo getModerationComment

Copy

async function fetchCommentDetails() {
  // Conjunto completo de parâmetros
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // Chamada mínima usando apenas o argumento obrigatório
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // Use os resultados conforme necessário...
}

Obter texto do comentário de moderação

Parameters

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

Response

Returns: GetModerationCommentTextResponse

Example

Exemplo getModerationCommentText

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // Chamar apenas com o parâmetro obrigatório
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // Chamar com parâmetros opcionais
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

Obter resumo pré-banimento

Parâmetros

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

Resposta

Retorna: GetPreBanSummaryResponse

Exemplo

Exemplo getPreBanSummary

Copy

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

Obter resumo de pesquisa de comentários

Parâmetros

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

Resposta

Retorna: GetSearchCommentsSummaryResponse

Exemplo

getSearchCommentsSummary Exemplo

Copy

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

Pesquisar páginas

Parâmetros

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

Resposta

Retorna: GetSearchPagesResponse

Exemplo

Exemplo getSearchPages

Copy

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

Pesquisar sites

Parâmetros

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

Resposta

Retorna: GetSearchSitesResponse

Exemplo

Exemplo getSearchSites

Copy

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

Obter sugestões de pesquisa

Parâmetros

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

Resposta

Retorna: GetSearchSuggestResponse

Exemplo

Exemplo getSearchSuggest

Copy

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

Pesquisar usuários

Parâmetros

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

Resposta

Retorna: GetSearchUsersResponse

Exemplo

Exemplo getSearchUsers

Copy

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

Obter fator de confiança

Parâmetros

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

Resposta

Retorna: GetTrustFactorResponse

Exemplo

Exemplo getTrustFactor

Copy

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

Obter preferência de banimento do usuário

Parâmetros

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

Resposta

Retorna: GetUserBanPreferenceResponse

Exemplo

Exemplo getUserBanPreference

Copy

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

Obter perfil interno do usuário

Parâmetros

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

Resposta

Retorna: GetUserInternalProfileResponse1

Exemplo

getUserInternalProfile Exemplo

Copy

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

Ajustar votos de comentário

Parâmetros

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

Resposta

Retorna: PostAdjustCommentVotesResponse

Exemplo

Exemplo postAdjustCommentVotes

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // campos adicionais conforme exigido por AdjustCommentVotesParams
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

Solicitar exportação da API

Parâmetros

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

Resposta

Retorna: PostApiExportResponse

Exemplo

postApiExport Exemplo

Copy

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

Banir usuário do comentário

Parâmetros

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

Resposta

Retorna: PostBanUserFromCommentResponse

Exemplo

Exemplo postBanUserFromComment

Copy

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

Desfazer banimento de usuário

Parâmetros

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

Resposta

Retorna: PostBanUserUndoResponse

Exemplo

Exemplo postBanUserUndo

Copy

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

Enviar resumo pré-banimento em massa

Parâmetros

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

Resposta

Retorna: PostBulkPreBanSummaryResponse

Exemplo

postBulkPreBanSummary Exemplo

Copy

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

Solicitar comentários por IDs

Parâmetros

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

Resposta

Retorna: PostCommentsByIdsResponse

Exemplo

postCommentsByIds Exemplo

Copy

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

Denunciar comentário

Parâmetros

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

Resposta

Retorna: PostFlagCommentResponse

Exemplo

postFlagComment Exemplo

Copy

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

Remover comentário

Parâmetros

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

Resposta

Retorna: PostRemoveCommentResponse

Exemplo

postRemoveComment Exemplo

Copy

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

Restaurar comentário excluído

Parâmetros

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

Resposta

Retorna: PostRestoreDeletedCommentResponse

Exemplo

Exemplo postRestoreDeletedComment

Copy

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

Definir status de aprovação do comentário

Parâmetros

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

Resposta

Retorna: PostSetCommentApprovalStatusResponse

Exemplo

Exemplo de postSetCommentApprovalStatus

Copy

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

Definir status de revisão do comentário

Parâmetros

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

Resposta

Retorna: PostSetCommentReviewStatusResponse

Exemplo

postSetCommentReviewStatus Exemplo

Copy

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

Definir status de spam do comentário

Parâmetros

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

Resposta

Retorna: PostSetCommentSpamStatusResponse

Exemplo

Exemplo postSetCommentSpamStatus

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // Apenas parâmetro obrigatório
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // Todos os parâmetros opcionais fornecidos
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

Definir texto do comentário

Parâmetros

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

Resposta

Retorna: PostSetCommentTextResponse

Exemplo

Exemplo postSetCommentText

Copy

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

Remover denúncia do comentário

Parâmetros

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

Resposta

Returns: PostUnFlagCommentResponse

Exemplo

postUnFlagComment Exemplo

Copy

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

Enviar voto

Parâmetros

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

Resposta

Retorna: PostVoteResponse

Exemplo

postVote Exemplo

Copy

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

Conceder insígnia

Parâmetros

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

Resposta

Retorna: PutAwardBadgeResponse

Exemplo

Exemplo putAwardBadge

Copy

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

Fechar tópico

Parâmetros

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

Resposta

Retorna: PutCloseThreadResponse

Exemplo

putCloseThread Exemplo

Copy

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

Remover insígnia

Parâmetros

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

Resposta

Retorna: PutRemoveBadgeResponse

Exemplo

Exemplo putRemoveBadge

Copy

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

Reabrir tópico

Parâmetros

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

Resposta

Retorna: PutReopenThreadResponse

Exemplo

Exemplo putReopenThread

Copy

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

Definir fator de confiança

Parâmetros

Nome	Tipo	Obrigatório
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

Resposta

Retorna: SetTrustFactorResponse

Exemplo

Exemplo setTrustFactor

Copy

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

Criar moderador

Parâmetros

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

Resposta

Retorna: CreateModeratorResponse1

Exemplo

Exemplo createModerator

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // campos opcionais como descrição são omitidos
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

Excluir moderador

Parâmetros

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

Resposta

Retorna: DeleteModeratorResponse

Exemplo

Exemplo deleteModerator

Copy

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

Obter moderador

Parameters

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

Response

Retorna: GetModeratorResponse1

Example

Exemplo getModerator

Copy

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

Obter moderadores

Parâmetros

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

Resposta

Retorna: GetModeratorsResponse1

Exemplo

Exemplo getModerators

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // deslocamento de paginação opcional
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // Exemplo sem paginação:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

Enviar convite

Parâmetros

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

Resposta

Retorna: SendInviteResponse

Exemplo

Exemplo sendInvite

Copy

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

Atualizar moderador

Parâmetros

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

Resposta

Retorna: UpdateModeratorResponse

Exemplo

Exemplo updateModerator

Copy

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

Excluir contagem de notificações

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Resposta

Retorna: DeleteNotificationCountResponse

Exemplo

Exemplo deleteNotificationCount

Copy

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

Obter contagem de notificações em cache

Parâmetros

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

Resposta

Retorna: GetCachedNotificationCountResponse1

Exemplo

getCachedNotificationCount Exemplo

Copy

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

Obter contagem de notificações

Parâmetros

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

Resposta

Retorna: GetNotificationCountResponse1

Exemplo

Exemplo getNotificationCount

Copy

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

Obter notificações

Parâmetros

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Resposta

Retorna: GetNotificationsResponse1

Exemplo

Exemplo getNotifications

Copy

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

Atualizar notificação

Parâmetros

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

Resposta

Retorna: UpdateNotificationResponse

Exemplo

Exemplo updateNotification

Copy

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

Criar reação de página V1

Parâmetros

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

Resposta

Retorna: CreateV1PageReactResponse

Exemplo

Exemplo createV1PageReact

Copy

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

Criar reação de página V2

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
urlId	string	Yes
id	string	Yes
title	string	No

Resposta

Retorna: CreateV2PageReactResponse

Exemplo

Exemplo createV2PageReact

Copy

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

Excluir reação de página V1

Parâmetros

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

Resposta

Retorna: DeleteV1PageReactResponse

Exemplo

Exemplo deleteV1PageReact

Copy

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

Excluir reação de página V2

Parâmetros

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

Resposta

Retorna: DeleteV2PageReactResponse

Exemplo

Exemplo deleteV2PageReact

Copy

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

Obter curtidas da página V1

Parâmetros

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

Resposta

Retorna: GetV1PageLikesResponse

Exemplo

Exemplo getV1PageLikes

Copy

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

Obter reações da página V2

Parâmetros

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

Resposta

Retorna: GetV2PageReactsResponse

Exemplo

Exemplo getV2PageReacts

Copy

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

Obter usuários que reagiram à página V2

Parâmetros

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

Resposta

Retorna: GetV2PageReactUsersResponse1

Exemplo

Exemplo getV2PageReactUsers

Copy

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

Adicionar página

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

Excluir página

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

Obter usuários offline

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

Parâmetros

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

Resposta

Retorna: GetOfflineUsersResponse

Exemplo

Exemplo getOfflineUsers

Copy

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

Obter usuários online

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

Parâmetros

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

Resposta

Retorna: GetOnlineUsersResponse

Exemplo

Exemplo getOnlineUsers

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // Com parâmetros de paginação opcionais
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // Sem parâmetros de paginação opcionais
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

Obter página por ID de URL

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

Obter páginas

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

Obter páginas (públicas)

Listar páginas para um tenant. Usado pelo cliente desktop FChat para preencher sua lista de salas.
Requer enableFChat ser true na configuração personalizada resolvida para cada página.
Páginas que requerem SSO são filtradas com base no 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: GetPagesPublicResponse

Exemplo

Exemplo getPagesPublic

Copy

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

Obter informações de usuários

Informações de usuário em massa para um tenant. Dado os 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).

Parâmetros

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

Resposta

Retorna: GetUsersInfoResponse

Exemplo

Exemplo getUsersInfo

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Optional fields in the response may be undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

Atualizar página (parcial)

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

Excluir evento de webhook pendente

Parâmetros

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

Resposta

Retorna: DeletePendingWebhookEventResponse

Exemplo

Exemplo deletePendingWebhookEvent

Copy

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

Obter contagem de eventos de webhook pendentes

Parâmetros

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

Resposta

Retorna: GetPendingWebhookEventCountResponse1

Exemplo

Exemplo getPendingWebhookEventCount

Copy

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

Obter eventos de webhook pendentes

Parâmetros

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

Resposta

Retorna: GetPendingWebhookEventsResponse1

Exemplo

Exemplo getPendingWebhookEvents

Copy

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

Criar configuração de pergunta

Parâmetros

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

Resposta

Retorna: CreateQuestionConfigResponse1

Exemplo

createQuestionConfig Exemplo

Copy

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

Excluir configuração de pergunta

Parâmetros

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

Resposta

Retorna: DeleteQuestionConfigResponse

Exemplo

Exemplo deleteQuestionConfig

Copy

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

Obter configuração de pergunta

Parâmetros

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Resposta

Retorna: GetQuestionConfigResponse1

Exemplo

getQuestionConfig Exemplo

Copy

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

Obter configurações de perguntas

Parâmetros

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

Resposta

Retorna: GetQuestionConfigsResponse1

Exemplo

Exemplo getQuestionConfigs

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // Chamada sem o parâmetro opcional 'skip'
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // Chamada com o parâmetro opcional 'skip'
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

Atualizar configuração de pergunta

Parâmetros

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

Resposta

Retorna: UpdateQuestionConfigResponse

Exemplo

updateQuestionConfig Exemplo

Copy

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

Criar resultado de pergunta

Parameters

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

Response

Retorna: CreateQuestionResultResponse1

Example

Exemplo createQuestionResult

Copy

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

Excluir resultado de pergunta

Parâmetros

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

Resposta

Retorna: DeleteQuestionResultResponse

Exemplo

Exemplo de deleteQuestionResult

Copy

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

Obter resultado de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionResultResponse1

Exemplo

Exemplo getQuestionResult

Copy

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

Obter resultados de perguntas

Parâmetros

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

Resposta

Retorna: GetQuestionResultsResponse1

Exemplo

Exemplo getQuestionResults

Copy

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

Atualizar resultado de pergunta

Parâmetros

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

Resposta

Retorna: UpdateQuestionResultResponse

Exemplo

Exemplo updateQuestionResult

Copy

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

Agregação de resultados de perguntas

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

Exemplo

Exemplo aggregateQuestionResults

Copy

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

Agregação em massa de resultados de perguntas

Parâmetros

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

Resposta

Retorna: BulkAggregateQuestionResultsResponse1

Exemplo

Exemplo bulkAggregateQuestionResults

Copy

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

Combinar comentários com resultados de perguntas

Parâmetros

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

Resposta

Retorna: CombineCommentsWithQuestionResultsResponse

Exemplo

Exemplo combineCommentsWithQuestionResults

Copy

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

Adicionar usuário SSO

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

Excluir usuário SSO

Parâmetros

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

Resposta

Retorna: DeleteSSOUserAPIResponse

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

Obter usuário SSO por e-mail

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

Obter usuário SSO por ID

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

Obter usuários SSO

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

Atualizar usuário SSO (parcial)

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

Substituir usuário SSO

Parâmetros

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

Resposta

Retorna: PutSSOUserAPIResponse

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

Criar assinatura

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

Excluir assinatura

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

Obter assinaturas

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

Atualizar assinatura

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

Obter uso diário do locatário

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

Exemplo

Exemplo getTenantDailyUsages

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // Maio
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // Usando apenas o parâmetro obrigatório e um opcional
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

Criar pacote do locatário

Parâmetros

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

Resposta

Retorna: CreateTenantPackageResponse1

Exemplo

Exemplo createTenantPackage

Copy

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

Excluir pacote do locatário

Parâmetros

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

Resposta

Retorna: DeleteTenantPackageResponse

Exemplo

deleteTenantPackage Exemplo

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // use o resultado conforme necessário
}
removeTenantPackage();

Obter pacote do locatário

Parâmetros

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

Resposta

Retorna: GetTenantPackageResponse1

Exemplo

Exemplo getTenantPackage

Copy

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

Obter pacotes do locatário

Parâmetros

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

Resposta

Retorna: GetTenantPackagesResponse1

Exemplo

Exemplo getTenantPackages

Copy

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

Substituir pacote do locatário

Parâmetros

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

Resposta

Retorna: ReplaceTenantPackageResponse

Exemplo

replaceTenantPackage Exemplo

Copy

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

Atualizar pacote do locatário

Parâmetros

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

Resposta

Retorna: UpdateTenantPackageResponse

Exemplo

Exemplo updateTenantPackage

Copy

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

Criar usuário do locatário

Parâmetros

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

Resposta

Retorna: CreateTenantUserResponse1

Exemplo

Exemplo createTenantUser

Copy

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

Excluir usuário do locatário

Parâmetros

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

Resposta

Returns: DeleteTenantUserResponse

Exemplo

deleteTenantUser Exemplo

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // Exclui o usuário e todos os seus comentários, usando modo hard delete
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // Exclui o usuário sem remover comentários (comportamento padrão)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

Obter usuário do locatário

Parâmetros

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

Resposta

Retorna: GetTenantUserResponse1

Exemplo

Exemplo getTenantUser

Copy

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

Obter usuários do locatário

Parâmetros

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

Resposta

Retorna: GetTenantUsersResponse1

Exemplo

Exemplo getTenantUsers

Copy

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

Substituir usuário do locatário

Parâmetros

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

Resposta

Retorna: ReplaceTenantUserResponse

Exemplo

replaceTenantUser Exemplo

Copy

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

Enviar link de login

Parâmetros

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

Resposta

Retorna: SendLoginLinkResponse

Exemplo

Exemplo sendLoginLink

Copy

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

Atualizar usuário do locatário

Parâmetros

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

Resposta

Retorna: UpdateTenantUserResponse

Exemplo

Exemplo updateTenantUser

Copy

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

Criar locatário

Parameters

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

Response

Retorna: CreateTenantResponse1

Example

Exemplo createTenant

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // campos obrigatórios
    name: 'Acme International',
    // campos opcionais podem ser adicionados conforme necessário, e.g.:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

Excluir locatário

Parâmetros

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

Resposta

Retorna: DeleteTenantResponse

Exemplo

deleteTenant Exemplo

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // Chamar com o parâmetro opcional 'sure'
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // Chamar sem o parâmetro opcional 'sure'
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

Obter locatário

Parâmetros

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

Resposta

Retorna: GetTenantResponse1

Exemplo

Exemplo getTenant

Copy

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

Obter locatários

Parâmetros

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

Resposta

Retorna: GetTenantsResponse1

Exemplo

Exemplo getTenants

Copy

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

Atualizar locatário

Parâmetros

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

Resposta

Retorna: UpdateTenantResponse

Exemplo

Exemplo updateTenant

Copy

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

Alterar estado do ticket

Parâmetros

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

Resposta

Retorna: ChangeTicketStateResponse1

Exemplo

Exemplo changeTicketState

Copy

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

Criar ticket

Parâmetros

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

Resposta

Retorna: CreateTicketResponse1

Exemplo

Exemplo de createTicket

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string é opcional e omitido
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// Exemplo de uso de um campo opcional da resposta
// console.log(response.ticket?.id);

Obter ticket

Parameters

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

Response

Retorna: GetTicketResponse1

Example

Exemplo getTicket

Copy

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

Obter tickets

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

Exemplo

Exemplo getTickets

Copy

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

Obter traduções

Parâmetros

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

Resposta

Retorna: GetTranslationsResponse1

Exemplo

Exemplo getTranslations

Copy

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

Enviar imagem

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

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

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressByIdResponse

Exemplo

Exemplo getUserBadgeProgressById

Copy

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

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

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressByUserIdResponse

Exemplo

Exemplo getUserBadgeProgressByUserId

Copy

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

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

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
userId	string	No
limit	number	No
skip	number	No

Resposta

Retorna: GetUserBadgeProgressListResponse

Exemplo

Exemplo getUserBadgeProgressList

Copy

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

Criar insígnia de usuário

Parâmetros

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

Resposta

Retorna: CreateUserBadgeResponse

Exemplo

Exemplo createUserBadge

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // descrição é opcional e omitida aqui
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

Excluir insígnia de usuário

Parâmetros

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

Resposta

Retorna: DeleteUserBadgeResponse

Exemplo

deleteUserBadge Exemplo

Copy

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

Obter insígnia de usuário

Parâmetros

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

Resposta

Retorna: GetUserBadgeResponse

Exemplo

Exemplo getUserBadge

Copy

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

Obter insígnias de usuário

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Sim
userId	string	Não
badgeId	string	Não
type	number	Não
displayedOnComments	boolean	Não
limit	number	Não
skip	number	Não

Resposta

Retorna: GetUserBadgesResponse

Exemplo

Exemplo getUserBadges

Copy

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

Atualizar insígnia de usuário

Parâmetros

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

Resposta

Retorna: UpdateUserBadgeResponse

Exemplo

updateUserBadge Exemplo

Copy

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

Obter contagem de notificações do usuário

Parâmetros

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

Resposta

Retorna: GetUserNotificationCountResponse1

Exemplo

Exemplo getUserNotificationCount

Copy

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

Obter notificações do usuário

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

Exemplo

Exemplo getUserNotifications

Copy

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

Redefinir contagem de notificações do usuário

Parâmetros

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

Resposta

Retorna: ResetUserNotificationCountResponse

Exemplo

Exemplo resetUserNotificationCount

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // Chamada com parâmetro sso opcional
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // Chamada sem parâmetro sso opcional
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

Redefinir notificações do usuário

Parâmetros

Name	Type	Required
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Resposta

Retorna: ResetUserNotificationsResponse1

Exemplo

Exemplo resetUserNotifications

Copy

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

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

Enable or disable notifications for a specific comment.

Parâmetros

Nome	Tipo	Obrigatório
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Resposta

Retorna: UpdateUserNotificationCommentSubscriptionStatusResponse

Exemplo

updateUserNotificationCommentSubscriptionStatus Exemplo

Copy

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

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

Enable ou desative 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	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

Resposta

Retorna: UpdateUserNotificationPageSubscriptionStatusResponse

Exemplo

Exemplo updateUserNotificationPageSubscriptionStatus

Copy

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

Atualizar status de notificação do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserNotificationStatusResponse

Exemplo

Exemplo de updateUserNotificationStatus

Copy

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

Obter status de presença do usuário

Parâmetros

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

Resposta

Retorna: GetUserPresenceStatusesResponse1

Exemplo

getUserPresenceStatuses Exemplo

Copy

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

Pesquisar usuários

Parâmetros

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

Resposta

Retorna: SearchUsersResponse1

Exemplo

Exemplo de searchUsers

Copy

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

Obter usuário

Parâmetros

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

Resposta

Retorna: GetUserResponse1

Exemplo

Exemplo getUser

Copy

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

Criar voto

Parâmetros

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

Resposta

Retorna: CreateVoteResponse

Exemplo

Exemplo createVote

Copy

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

Excluir voto

Parâmetros

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

Resposta

Retorna: DeleteVoteResponse

Exemplo

Exemplo deleteVote

Copy

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

Obter votos

Parâmetros

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

Resposta

Retorna: GetVotesResponse1

Exemplo

Exemplo getVotes

Copy

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

Obter votos do usuário

Parâmetros

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

Resposta

Retorna: GetVotesForUserResponse1

Exemplo

Exemplo getVotesForUser

Copy

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

Precisa de ajuda?

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

Contribuindo

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

Idioma 🇧🇷 Português (Brasil)

Primeiros Passos

Referência da API

Documentação

Uso

Agregação

Registros de Auditoria

Bloquear do comentário

Verificar comentários bloqueados

Comentários

Comentários Para Usuário

Configurações de Domínio

Modelos de E-mail

Registro de Eventos

Publicações do Feed

Denunciar comentário

Gifs

Hashtags

Moderação

Moderadores

Contagem de Notificações

Notificações

Reações na Página

Páginas

Eventos de Webhook Pendentes

Configurações de Perguntas

Resultados de Perguntas

Agregação de Resultados de Perguntas

Usuários SSO

Assinaturas

Uso diário do locatário

Pacotes do Locatário

Usuários do Locatário

Locatários

Tickets

Traduções

Enviar Imagem

Progresso de Insígnia do Usuário

Insígnias de Usuário

Notificações do Usuário

Status de Presença do Usuário

Busca de Usuários

Usuários

Votos

FastComments SDK JavaScript/TypeScript

Repositório

Instalação

Documentação da API

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

Compatibilidade Navegador vs Servidor

Uso

Uso no Navegador (Lado do Cliente)

Uso no Servidor (Node.js)

Import apenas de Tipos

Usando Classes de API Individuais

Ambiente do Navegador

Ambiente do Servidor

APIs Públicas vs Seguras

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

Exemplo: Usando a Default API (somente no servidor)

Exemplo: Usando a Moderation API

SSO (Single Sign-On) - Integração

SSO Simples (Apenas no Lado do Servidor)

SSO Seguro (Lado do Servidor, Recomendado)

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

SSO com Criação de Comentário

Casos de Uso Comuns

Obtendo Comentários de uma Página

Criando um Comentário

Votando em um Comentário

Gerenciamento de Usuários (Requer Chave de API)

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

Eventos por página

Inscreva-se em eventos do usuário

Obtendo userIdWS

IDs de Transmissão

Tratamento de Erros

Agregação

Parameters

Response