FastComments JavaScript/TypeScript SDK

Questo è lo SDK ufficiale JavaScript/TypeScript per FastComments.

SDK ufficiale JavaScript/TypeScript per l'API di FastComments

Repository

Installazione

npm install fastcomments-sdk

Documentazione API

Riferimento completo delle API: docs/api/README.md

Compatibilità Browser e Server

Questo SDK utilizza due punti di ingresso per garantire la massima compatibilità e prevenire errori a runtime:

fastcomments-sdk/browser - Versione sicura per il browser con fetch nativo
fastcomments-sdk/server - Versione completa per Node.js con supporto SSO
fastcomments-sdk (predefinito) - Solo tipi, sicuro da importare ovunque

Utilizzo

Questo SDK fornisce punti di ingresso separati per gli ambienti browser e server per garantire compatibilità e sicurezza ottimali:

Browser Usage (Client-Side)

Per applicazioni browser/frontend, utilizzare l'export sicuro per il browser che esclude le dipendenze di Node.js:

// Import sicuro per il browser (nessuna dipendenza Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Crea un'istanza dello SDK per il browser
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // opzionale, predefinito https://fastcomments.com
});

// Usa API pubbliche (nessuna API key necessaria - sicuro per i browser)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server Usage (Node.js)

Per applicazioni server/backend, utilizzare lo SDK completo con funzionalità SSO e di autenticazione:

// Import lato server (include SSO e progettato per funzionare con NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Crea un'istanza dello SDK per il server
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Mantieni questo segreto sul server!
  basePath: 'https://fastcomments.com' // opzionale, predefinito https://fastcomments.com
});

// Usa API protette con la tua API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Import Solo Tipi

Se hai bisogno solo dei tipi TypeScript (nessun codice a runtime), utilizza l'importazione di default:

// Solo tipi (nessuna dipendenza runtime - sicuro ovunque)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Using Individual API Classes

Browser Environment

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

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

const publicApi = new PublicApi(config);

Server Environment

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

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

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

API Pubbliche vs Protette

L'SDK fornisce tre principali classi API:

DefaultApi - Endpoint protetti che richiedono la tua chiave API per l'autenticazione. Usali per operazioni lato server.
PublicApi - Endpoint pubblici accessibili senza una chiave API. Possono essere chiamati direttamente da browser/dispositivi mobili/etc.
HiddenApi - Endpoint interni/amministrativi per casi d'uso avanzati.

Esempio: Uso della Public API (sicuro per il browser)

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

const publicApi = new PublicApi();

// Ottieni i commenti per una pagina (non è richiesta la chiave API)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Esempio: Uso della Default API (solo lato server)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Tienila segreta!
});
const defaultApi = new DefaultApi(config);

// Ottieni i commenti con accesso amministrativo completo
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Integrazione SSO (Single Sign-On)

FastComments supporta SSO per integrarsi con il tuo sistema di autenticazione utenti esistente. La funzionalità SSO è disponibile solo nell'export lato server poiché richiede le funzionalità crypto di Node.js.

SSO semplice (solo lato server)

L'SSO semplice dovrebbe essere generato lato server e inviato al client:

// Codice lato server (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crea SSO semplice usando l'aiuto integrato  
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();

// Invia ssoToken al codice lato client
// Il codice lato client può quindi usare questo token con lo SDK per browser

SSO sicuro (lato server, raccomandato)

L'SSO sicuro dovrebbe essere implementato lato server e offre maggiore sicurezza:

// Codice lato server (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crea SSO sicuro usando l'aiuto integrato
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();

// Usalo con chiamate API sul server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Oppure invia ssoConfig al client per l'utilizzo nel browser

Utilizzo dell'SSO dal browser (con token generato dal server)

// Codice lato client (browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Ottieni il token SSO dal tuo endpoint server
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 the server-generated SSO token
});

SSO con creazione di commenti

// Lato server: crea SSO e commento
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)
});

Casi d'uso comuni

Ottenere i commenti di una pagina

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

Creare un commento

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

Votare un commento

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

Gestione utenti (Richiede API Key)

// Cerca utenti (richiede DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Eventi Live (Aggiornamenti in tempo reale)

Iscriviti agli eventi live per ricevere aggiornamenti in tempo reale su commenti, voti e altre attività.

Eventi a livello di pagina

Ascolta gli eventi live per una pagina specifica (commenti, voti, ecc.):

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);
        // Aggiorna la UI con il nuovo commento
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Aggiorna i conteggi dei voti nella tua UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Restituisci true se l'evento è stato gestito
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

Iscriviti agli eventi utente

Ascolta gli eventi specifici dell'utente (notifiche, menzioni, ecc.):

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);
        // Mostra la notifica nella tua 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();

Ottenere userIdWS

The userIdWS parameter is required for live events and can be obtained from API responses:

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

ID di Broadcast

Vedrai che dovrai passare un broadcastId in alcune chiamate API. Quando riceverai eventi, ti verrà restituito questo ID, quindi saprai di ignorare l'evento se intendi applicare le modifiche in modo ottimistico sul client (cosa che probabilmente vorrai fare, dato che offre la migliore esperienza). Passa qui un UUID. L'ID dovrebbe essere sufficientemente unico da non verificarsi due volte durante la sessione del browser.

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 univoco per questa operazione
  }
});

Gestione degli errori

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

Aggrega

Aggrega i documenti raggruppandoli (se groupBy è fornito) e applicando più operazioni. Sono supportate diverse operazioni (ad es. sum, countDistinct, avg, ecc.).

Parametri

Name	Type	Required
tenantId	string	Sì
aggregationRequest	AggregationRequest	Sì
parentTenantId	string	No
includeStats	boolean	No

Response

Restituisce: AggregationResponse

Ottieni log di audit

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Risposta

Restituisce: GetAuditLogs200Response

Esempio

Esempio di getAuditLogs

Copy

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

Blocca da commento pubblico

Parametri

Name	Type	Required
tenantId	string	Sì
commentId	string	Sì
publicBlockFromCommentParams	PublicBlockFromCommentParams	Sì
sso	string	No

Risposta

Restituisce: BlockFromCommentPublic200Response

Esempio

Esempio di blockFromCommentPublic

Copy

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

Sblocca commento pubblico

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
commentId	string	Sì
publicBlockFromCommentParams	PublicBlockFromCommentParams	Sì
sso	string	No

Risposta

Restituisce: UnBlockCommentPublic200Response

Esempio

unBlockCommentPublic Esempio

Copy

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

Controlla commenti bloccati

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentIds	string	Sì
sso	string	No

Risposta

Restituisce: CheckedCommentsForBlocked200Response

Esempio

Esempio di checkedCommentsForBlocked

Copy

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

Blocca utente da commento

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
blockFromCommentParams	BlockFromCommentParams	Sì
userId	string	No
anonUserId	string	No

Response

Restituisce: BlockFromCommentPublic200Response

Esempio

Esempio di blockUserFromComment

Copy

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

Crea commento pubblico

Parametri

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
broadcastId	string	Sì
commentData	CommentData	Sì
sessionId	string	No
sso	string	No

Response

Restituisce: CreateCommentPublic200Response

Esempio

Esempio di createCommentPublic

Copy

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

Elimina commento

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
contextUserId	string	No
isLive	boolean	No

Risposta

Restituisce: DeleteComment200Response

Esempio

Esempio di deleteComment

Copy

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

Elimina commento pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	Sì
editKey	string	No
sso	string	No

Risposta

Restituisce: DeleteCommentPublic200Response

Esempio

Esempio di deleteCommentPublic

Copy

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

Elimina voto commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
voteId	string	Sì
urlId	string	Sì
broadcastId	string	Sì
editKey	string	No
sso	string	No

Risposta

Restituisce: DeleteCommentVote200Response

Esempio

Esempio di deleteCommentVote

Copy

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

Segnala commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
userId	string	No
anonUserId	string	No

Risposta

Restituisce: FlagComment200Response

Esempio

Esempio di flagComment

Copy

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

Ottieni commento

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetComment200Response

Esempio

Esempio getComment

Copy

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

Ottieni commenti

Parametri

Name	Type	Required
tenantId	string	Yes
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No

Risposta

Restituisce: GetComments200Response

Esempio

Esempio di getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // page (pagina)
  20, // limit (limite)
  0, // skip (salto)
  true, // asTree (comeAlbero)
  1, // skipChildren (saltaFigli)
  3, // limitChildren (limiteFigli)
  4, // maxTreeDepth (profonditàMassimaAlbero)
  'articles/2026/new-product-launch', // urlId (idUrl)
  'user_7890', // userId (idUtente)
  'anon_4f3b2', // anonUserId (idUtenteAnonimo)
  undefined, // contextUserId (idUtenteContesto)
  '#launch', // hashTag (hashtag)
  undefined // parentId (idGenitore)
);

Ottieni commenti pubblici

req tenantId urlId

Parametri

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

Risposta

Restituisce: GetCommentsPublic200Response

Esempio

Esempio getCommentsPublic

Copy

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

Ottieni testo commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
editKey	string	No
sso	string	No

Risposta

Restituisce: GetCommentText200Response

Esempio

Esempio di getCommentText

Copy

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

Ottieni nomi utenti voto commento

Parametri

Name	Type	Required
tenantId	string	Sì
commentId	string	Sì
dir	number	Sì
sso	string	No

Risposta

Restituisce: GetCommentVoteUserNames200Response

Esempio

Esempio di getCommentVoteUserNames

Copy

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

Blocca commento

Parametri

Name	Type	Richiesto
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	Sì
sso	string	No

Risposta

Restituisce: LockComment200Response

Esempio

Esempio di lockComment

Copy

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

Fissa commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	Sì
sso	string	No

Risposta

Restituisce: PinComment200Response

Esempio

Esempio di pinComment

Copy

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

Salva commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createCommentParams	CreateCommentParams	Sì
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Risposta

Restituisce: SaveComment200Response

Esempio

Esempio di saveComment

Copy

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

Salva commenti in blocco

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Response

Restituisce: Array<SaveComment200Response

Esempio

Esempio di saveCommentsBulk

Copy

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

Imposta testo commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	Sì
commentTextUpdateRequest	CommentTextUpdateRequest	Sì
editKey	string	No
sso	string	No

Risposta

Restituisce: SetCommentText200Response

Esempio

Esempio setCommentText

Copy

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

Sblocca utente da commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
unBlockFromCommentParams	UnBlockFromCommentParams	Sì
userId	string	No
anonUserId	string	No

Risposta

Restituisce: UnBlockCommentPublic200Response

Esempio

unBlockUserFromComment Esempio

Copy

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

Rimuovi segnalazione commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
userId	string	No
anonUserId	string	No

Risposta

Restituisce: FlagComment200Response

Esempio

Esempio di unFlagComment

Copy

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

Sblocca commento

Parametri

Name	Type	Required
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	Sì
sso	string	No

Risposta

Restituisce: LockComment200Response

Esempio

Esempio di unLockComment

Copy

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

Rimuovi pin commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	Sì
sso	string	No

Risposta

Restituisce: PinComment200Response

Esempio

Esempio di unPinComment

Copy

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

Aggiorna commento

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	Sì
updatableCommentParams	UpdatableCommentParams	Sì
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateComment

Copy

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

Vota commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
urlId	string	Sì
broadcastId	string	Sì
voteBodyParams	VoteBodyParams	Sì
sessionId	string	No
sso	string	No

Risposta

Restituisce: VoteComment200Response

Esempio

Esempio di voteComment

Copy

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

Aggiungi configurazione dominio

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
addDomainConfigParams	AddDomainConfigParams	Sì

Risposta

Restituisce: AddDomainConfig200Response

Elimina configurazione dominio

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	Sì

Risposta

Restituisce: DeleteDomainConfig200Response

Ottieni configurazione dominio

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	Sì

Risposta

Restituisce: GetDomainConfig200Response

Ottieni configurazioni dominio

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì

Risposta

Restituisce: GetDomainConfigs200Response

Aggiorna parzialmente configurazione dominio

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
domainToUpdate	string	Sì
patchDomainConfigParams	PatchDomainConfigParams	Sì

Risposta

Restituisce: GetDomainConfig200Response

Sostituisci configurazione dominio

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
domainToUpdate	string	Sì
updateDomainConfigParams	UpdateDomainConfigParams	Sì

Risposta

Restituisce: GetDomainConfig200Response

Crea modello email

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createEmailTemplateBody	CreateEmailTemplateBody	Sì

Risposta

Restituisce: CreateEmailTemplate200Response

Esempio

Esempio di createEmailTemplate

Copy

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

Elimina modello email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteEmailTemplate

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // esempio di parametro opzionale
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

Elimina errore di rendering modello email

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	Sì
errorId	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteEmailTemplateRenderError

Copy

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

Ottieni modello email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetEmailTemplate200Response

Esempio

Esempio di getEmailTemplate

Copy

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

Ottieni definizioni modelli email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì

Risposta

Restituisce: GetEmailTemplateDefinitions200Response

Esempio

getEmailTemplateDefinitions Esempio

Copy

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

Ottieni errori di rendering modelli email

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
skip	number	No

Risposta

Restituisce: GetEmailTemplateRenderErrors200Response

Esempio

Esempio getEmailTemplateRenderErrors

Copy

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

Ottieni modelli email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	number	No

Risposta

Restituisce: GetEmailTemplates200Response

Esempio

Esempio di getEmailTemplates

Copy

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

Esegui rendering modello email

Parametri

Name	Type	Required
tenantId	string	Sì
renderEmailTemplateBody	RenderEmailTemplateBody	Sì
locale	string	No

Risposta

Restituisce: RenderEmailTemplate200Response

Esempio

Esempio di renderEmailTemplate

Copy

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

Aggiorna modello email

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
updateEmailTemplateBody	UpdateEmailTemplateBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateEmailTemplate

Copy

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

Ottieni registro eventi

req tenantId urlId userIdWS

Parametri

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
userIdWS	string	Sì
startTime	number	Sì
endTime	number	Sì

Risposta

Restituisce: GetEventLog200Response

Esempio

Esempio di getEventLog

Copy

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

Ottieni registro eventi globale

req tenantId urlId userIdWS

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
userIdWS	string	Sì
startTime	number	Sì
endTime	number	Sì

Risposta

Restituisce: GetEventLog200Response

Esempio

Esempio di getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 giorni fa
const endTimeOptional: number | undefined = undefined; // termine opzionale dell'intervallo di tempo
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

Crea post feed

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createFeedPostParams	CreateFeedPostParams	Sì
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Risposta

Restituisce: CreateFeedPost200Response

Esempio

Esempio di createFeedPost

Copy

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

Crea post feed pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createFeedPostParams	CreateFeedPostParams	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: CreateFeedPostPublic200Response

Esempio

Esempio di createFeedPostPublic

Copy

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

Elimina post feed pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
postId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: DeleteFeedPostPublic200Response

Esempio

Esempio di deleteFeedPostPublic

Copy

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

Ottieni post feed

req tenantId afterId

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
afterId	string	No
limit	number	No
tags	Array	No

Risposta

Restituisce: GetFeedPosts200Response

Esempio

Esempio getFeedPosts

Copy

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

Ottieni post feed pubblici

req tenantId afterId

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

Risposta

Restituisce: GetFeedPostsPublic200Response

Esempio

Esempio di getFeedPostsPublic

Copy

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

Ottieni statistiche post feed

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
postIds	Array	Sì
sso	string	No

Risposta

Restituisce: GetFeedPostsStats200Response

Esempio

Esempio di getFeedPostsStats

Copy

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

Ottieni reazioni utente pubbliche

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
postIds	Array	No
sso	string	No

Risposta

Restituisce: GetUserReactsPublic200Response

Esempio

Esempio di getUserReactsPublic

Copy

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

Reagisci a post feed pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
postId	string	Sì
reactBodyParams	ReactBodyParams	Sì
isUndo	boolean	No
broadcastId	string	No
sso	string	No

Risposta

Restituisce: ReactFeedPostPublic200Response

Esempio

Esempio di reactFeedPostPublic

Copy

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

Aggiorna post feed

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
feedPost	FeedPost	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateFeedPost

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // array opzionale incluso
  links: [link],          // link opzionali inclusi
  isPublished: true       // flag di pubblicazione opzionale usato qui
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

Aggiorna post feed pubblico

Parametri

Name	Type	Required
tenantId	string	Sì
postId	string	Sì
updateFeedPostParams	UpdateFeedPostParams	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: CreateFeedPostPublic200Response

Esempio

Esempio di updateFeedPostPublic

Copy

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

Segnala commento pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
isFlagged	boolean	Sì
sso	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di flagCommentPublic

Copy

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

Aggiungi hashtag

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Risposta

Restituisce: AddHashTag200Response

Esempio

Esempio di addHashTag

Copy

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

Aggiungi hashtag in blocco

Parametri

Name	Type	Required	Description
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Risposta

Restituisce: AddHashTagsBulk200Response

Esempio

addHashTagsBulk Esempio

Copy

// Crea l'identificatore del tenant (parametro opzionale)
const tenantId: string = "tenant_9f8c2b7a";
// Prepara le singole voci dei tag
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Corpo per la creazione in blocco (parametro opzionale)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Chiama la funzione asincrona globale e assegna il risultato tipizzato
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

Elimina hashtag

Parametri

Name	Type	Obbligatorio
tag	string	Sì
tenantId	string	No
deleteHashTagRequest	DeleteHashTagRequest	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteHashTag

Copy

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

Ottieni hashtag

Parameters

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
page	number	No

Risposta

Restituisce: GetHashTags200Response

Esempio

Esempio di getHashTags

Copy

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

Aggiorna parzialmente hashtag

Parametri

Nome	Tipo	Obbligatorio
tag	string	Yes
tenantId	string	No
updateHashTagBody	UpdateHashTagBody	No

Risposta

Restituisce: PatchHashTag200Response

Esempio

Esempio di patchHashTag

Copy

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

Crea moderatore

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createModeratorBody	CreateModeratorBody	Sì

Risposta

Restituisce: CreateModerator200Response

Esempio

createModerator Example

Copy

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

Elimina moderatore

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
sendEmail	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteModerator

Copy

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

Ottieni moderatore

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetModerator200Response

Esempio

Esempio di getModerator

Copy

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

Ottieni moderatori

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	number	No

Risposta

Restituisce: GetModerators200Response

Esempio

Esempio di getModerators

Copy

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

Invia invito

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
fromName	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di sendInvite

Copy

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

Aggiorna moderatore

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
updateModeratorBody	UpdateModeratorBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateModerator

Copy

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

Elimina conteggio notifiche

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteNotificationCount

Copy

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

Ottieni conteggio notifiche in cache

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetCachedNotificationCount200Response

Esempio

Esempio di getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // flag del parametro opzionale (dimostrato)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

Ottieni conteggio notifiche

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

Risposta

Restituisce: GetNotificationCount200Response

Esempio

Esempio di getNotificationCount

Copy

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

Ottieni notifiche

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Risposta

Restituisce: GetNotifications200Response

Esempio

Esempio di getNotifications

Copy

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

Aggiorna notifica

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateNotificationBody	UpdateNotificationBody	Sì
userId	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateNotification

Copy

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

Aggiungi pagina

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPIPageData	CreateAPIPageData	Sì

Risposta

Restituisce: AddPageAPIResponse

Elimina pagina

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: DeletePageAPIResponse

Ottieni pagina per URL ID

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
urlId	string	Sì

Risposta

Restituisce: GetPageByURLIdAPIResponse

Ottieni pagine

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì

Risposta

Restituisce: GetPagesAPIResponse

Aggiorna parzialmente pagina

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	Sì
updateAPIPageData	UpdateAPIPageData	Sì

Risposta

Restituisce: PatchPageAPIResponse

Elimina evento webhook in sospeso

Parametri

Name	Type	Richiesto	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deletePendingWebhookEvent

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // esempio di parametro opzionale (non richiesto dalla funzione)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

Ottieni conteggio eventi webhook in sospeso

Parametri

Name	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Risposta

Restituisce: GetPendingWebhookEventCount200Response

Esempio

Esempio di getPendingWebhookEventCount

Copy

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

Ottieni eventi webhook in sospeso

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

Risposta

Restituisce: GetPendingWebhookEvents200Response

Esempio

Esempio di getPendingWebhookEvents

Copy

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

Crea configurazione domanda

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createQuestionConfigBody	CreateQuestionConfigBody	Sì

Risposta

Restituisce: CreateQuestionConfig200Response

Esempio

Esempio di createQuestionConfig

Copy

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

Elimina configurazione domanda

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteQuestionConfig

Copy

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

Ottieni configurazione domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetQuestionConfig200Response

Esempio

Esempio di getQuestionConfig

Copy

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

Ottieni configurazioni domande

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	number	No

Risposta

Restituisce: GetQuestionConfigs200Response

Esempio

Esempio di getQuestionConfigs

Copy

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

Aggiorna configurazione domanda

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateQuestionConfigBody	UpdateQuestionConfigBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateQuestionConfig

Copy

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

Crea risultato domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionResultBody	CreateQuestionResultBody	Sì

Risposta

Restituisce: CreateQuestionResult200Response

Esempio

Esempio di createQuestionResult

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // metadati opzionali
  note: "Follow-up requested" // parametro opzionale dimostrato
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

Elimina risultato domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteQuestionResult

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // parametro opzionale che dimostra la selezione alternativa del target
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

Ottieni risultato domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetQuestionResult200Response

Esempio

Esempio di getQuestionResult

Copy

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

Ottieni risultati domande

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Risposta

Restituisce: GetQuestionResults200Response

Esempio

Esempio di getQuestionResults

Copy

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

Aggiorna risultato domanda

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateQuestionResultBody	UpdateQuestionResultBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateQuestionResult

Copy

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

Aggrega risultati domande

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Risposta

Restituisce: AggregateQuestionResults200Response

Esempio

Esempio di aggregateQuestionResults

Copy

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

Aggrega risultati domande in blocco

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Sì
forceRecalculate	boolean	No

Risposta

Restituisce: BulkAggregateQuestionResults200Response

Esempio

Esempio di bulkAggregateQuestionResults

Copy

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

Combina commenti con risultati domande

Parametri

Nome	Type	Obbligatorio
tenantId	string	Sì
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

Risposta

Restituisce: CombineCommentsWithQuestionResults200Response

Esempio

Esempio combineCommentsWithQuestionResults

Copy

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

Aggiungi utente SSO

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPISSOUserData	CreateAPISSOUserData	Sì

Risposta

Restituisce: AddSSOUserAPIResponse

Elimina utente SSO

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
deleteComments	boolean	No
commentDeleteMode	string	No

Risposta

Restituisce: DeleteSSOUserAPIResponse

Ottieni utente SSO per email

Parametri

Nome	Type	Obbligatorio	Descrizione
tenantId	string	Sì
email	string	Sì

Risposta

Restituisce: GetSSOUserByEmailAPIResponse

Ottieni utente SSO per ID

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetSSOUserByIdAPIResponse

Ottieni utenti SSO

Parametri

Nome	Type	Obbligatorio	Descrizione
tenantId	string	Sì
skip	number	No

Risposta

Restituisce: GetSSOUsers200Response

Aggiorna parzialmente utente SSO

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateAPISSOUserData	UpdateAPISSOUserData	Sì
updateComments	boolean	No

Risposta

Restituisce: PatchSSOUserAPIResponse

Sostituisci utente SSO

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateAPISSOUserData	UpdateAPISSOUserData	Sì
updateComments	boolean	No

Risposta

Restituisce: PutSSOUserAPIResponse

Crea sottoscrizione

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Sì

Risposta

Restituisce: CreateSubscriptionAPIResponse

Esempio

Esempio di createSubscription

Copy

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

Elimina sottoscrizione

Parameters

Name	Type	Required
tenantId	string	Sì
id	string	Sì
userId	string	No

Risposta

Restituisce: DeleteSubscriptionAPIResponse

Ottieni sottoscrizioni

Parametri

Name	Type	Required	Description
tenantId	string	Sì
userId	string	No

Risposta

Restituisce: GetSubscriptionsAPIResponse

Esempio

Esempio di getSubscriptions

Copy

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

Aggiorna sottoscrizione

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	Sì
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Sì
userId	string	No

Risposta

Restituisce: UpdateSubscriptionAPIResponse

Esempio

Esempio di updateSubscription

Copy

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

Ottieni utilizzi giornalieri tenant

Parametri

Name	Type	Required
tenantId	string	Sì
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

Risposta

Restituisce: GetTenantDailyUsages200Response

Esempio

Esempio di getTenantDailyUsages

Copy

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

Crea pacchetto tenant

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createTenantPackageBody	CreateTenantPackageBody	Sì

Risposta

Restituisce: CreateTenantPackage200Response

Esempio

Esempio di createTenantPackage

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // parametro opzionale fornito
  // campi opzionali omessi: p.es., regole di moderazione avanzate, CSS personalizzati
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // valore illustrativo; usa la struttura CustomConfigParameters
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

Elimina pacchetto tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteTenantPackage

Copy

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

Ottieni pacchetto tenant

Parametri

Name	Type	Required	Description
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetTenantPackage200Response

Esempio

Esempio di getTenantPackage

Copy

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

Ottieni pacchetti tenant

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Yes
skip	number	No

Risposta

Restituisce: GetTenantPackages200Response

Esempio

Esempio di getTenantPackages

Copy

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

Sostituisci pacchetto tenant

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
replaceTenantPackageBody	ReplaceTenantPackageBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di replaceTenantPackage

Copy

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

Aggiorna pacchetto tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateTenantPackageBody	UpdateTenantPackageBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // campi opzionali omessi intenzionalmente (es., description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

Crea utente tenant

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createTenantUserBody	CreateTenantUserBody	Sì

Risposta

Restituisce: CreateTenantUser200Response

Esempio

Esempio di createTenantUser

Copy

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

Elimina utente tenant

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	Sì
deleteComments	string	No
commentDeleteMode	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio deleteTenantUser

Copy

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

Ottieni utente tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetTenantUser200Response

Esempio

Esempio getTenantUser

Copy

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

Ottieni utenti tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	number	No

Risposta

Restituisce: GetTenantUsers200Response

Esempio

Esempio di getTenantUsers

Copy

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

Sostituisci utente tenant

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
id	string	Sì
replaceTenantUserBody	ReplaceTenantUserBody	Sì
updateComments	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di replaceTenantUser

Copy

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

Invia link di accesso

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
redirectURL	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di sendLoginLink

Copy

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

Aggiorna utente tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateTenantUserBody	UpdateTenantUserBody	Sì
updateComments	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateTenantUser

Copy

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

Crea tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createTenantBody	CreateTenantBody	Sì

Risposta

Restituisce: CreateTenant200Response

Esempio

Esempio di createTenant

Copy

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

Elimina tenant

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	Sì
sure	string	No

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di deleteTenant

Copy

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

Ottieni tenant

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetTenant200Response

Esempio

Esempio getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // override opzionale, se disponibile
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

Ottieni tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
meta	string	No
skip	number	No

Risposta

Restituisce: GetTenants200Response

Esempio

Esempio di getTenants

Copy

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

Aggiorna tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateTenantBody	UpdateTenantBody	Sì

Risposta

Restituisce: FlagCommentPublic200Response

Esempio

Esempio di updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // opzionale, omettere per mantenere la fatturazione corrente
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Cambia stato ticket

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	Sì
id	string	Sì
changeTicketStateBody	ChangeTicketStateBody	Sì

Risposta

Restituisce: ChangeTicketState200Response

Esempio

Esempio di changeTicketState

Copy

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

Crea ticket

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	Sì
createTicketBody	CreateTicketBody	Sì

Risposta

Restituisce: CreateTicket200Response

Esempio

Esempio di createTicket

Copy

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

Ottieni ticket

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
id	string	Sì
userId	string	No

Risposta

Restituisce: GetTicket200Response

Esempio

Esempio di getTicket

Copy

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

Ottieni ticket

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
state	number	No
skip	number	No
limit	number	No

Risposta

Restituisce: GetTickets200Response

Esempio

Esempio di getTickets

Copy

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

Carica immagine

Carica e ridimensiona un'immagine

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
file	Blob	Sì
sizePreset	SizePreset	No
urlId	string	No

Risposta

Restituisce: UploadImageResponse

Ottieni progresso badge utente per ID

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetUserBadgeProgressById200Response

Esempio

Esempio di getUserBadgeProgressById

Copy

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

Ottieni progresso badge utente per ID utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
userId	string	Sì

Risposta

Restituisce: GetUserBadgeProgressById200Response

Esempio

Esempio di getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // sorgente opzionale (potrebbe essere undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

Ottieni lista progresso badge utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
limit	number	No
skip	number	No

Risposta

Restituisce: GetUserBadgeProgressList200Response

Esempio

Esempio di getUserBadgeProgressList

Copy

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

Crea badge utente

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
createUserBadgeParams	CreateUserBadgeParams	Sì

Risposta

Restituisce: CreateUserBadge200Response

Esempio

Esempio di createUserBadge

Copy

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

Elimina badge utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: UpdateUserBadge200Response

Esempio

Esempio di deleteUserBadge

Copy

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

Ottieni badge utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	Sì

Risposta

Restituisce: GetUserBadge200Response

Esempio

Esempio di getUserBadge

Copy

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

Ottieni badge utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

Risposta

Restituisce: GetUserBadges200Response

Esempio

Esempio di getUserBadges

Copy

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

Aggiorna badge utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
updateUserBadgeParams	UpdateUserBadgeParams	Sì

Risposta

Restituisce: UpdateUserBadge200Response

Esempio

Esempio di updateUserBadge

Copy

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

Ottieni conteggio notifiche utente

Parametri

Name	Tipo	Richiesto	Descrizione
tenantId	string	Sì
sso	string	No

Risposta

Restituisce: GetUserNotificationCount200Response

Esempio

Esempio di getUserNotificationCount

Copy

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

Ottieni notifiche utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
sso	string	No

Risposta

Restituisce: GetUserNotifications200Response

Esempio

Esempio di getUserNotifications

Copy

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

Reimposta conteggio notifiche utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string	No

Risposta

Restituisce: ResetUserNotifications200Response

Esempio

Esempio di resetUserNotificationCount

Copy

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

Reimposta notifiche utente

Parameters

Nome	Tipo	Obbligatorio
tenantId	string	Sì
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Risposta

Restituisce: ResetUserNotifications200Response

Esempio

Esempio di resetUserNotifications

Copy

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

Aggiorna stato sottoscrizione commenti notifiche utente

Abilita o disabilita le notifiche per un commento specifico.

Parametri

Name	Type	Required
tenantId	string	Sì
notificationId	string	Sì
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Sì
commentId	string	Sì
sso	string	No

Risposta

Restituisce: UpdateUserNotificationStatus200Response

Esempio

Esempio di updateUserNotificationCommentSubscriptionStatus

Copy

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

Aggiorna stato sottoscrizione pagina notifiche utente

Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, vengono create notifiche per i nuovi commenti principali, e anche

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
urlId	string	Sì
url	string	Sì
pageTitle	string	Sì
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Sì
sso	string	No

Risposta

Restituisce: UpdateUserNotificationStatus200Response

Esempio

updateUserNotificationPageSubscriptionStatus Esempio

Copy

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

Aggiorna stato notifica utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
notificationId	string	Sì
newStatus	UpdateUserNotificationStatusNewStatusEnum	Sì
sso	string	No

Risposta

Restituisce: UpdateUserNotificationStatus200Response

Esempio

Esempio di updateUserNotificationStatus

Copy

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

Ottieni stati presenza utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlIdWS	string	Sì
userIds	string	Sì

Risposta

Restituisce: GetUserPresenceStatuses200Response

Esempio

Esempio di getUserPresenceStatuses

Copy

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

Cerca utenti

Parametri

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

Risposta

Restituisce: SearchUsers200Response

Esempio

Esempio di searchUsers

Copy

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

Ottieni utente

Parametri

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Risposta

Restituisce: GetUser200Response

Esempio

Esempio di getUser

Copy

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

Crea voto

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
direction	CreateVoteDirectionEnum	Sì
userId	string	No
anonUserId	string	No

Risposta

Restituisce: VoteComment200Response

Esempio

Esempio di createVote

Copy

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

Elimina voto

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	Sì
editKey	string	No

Risposta

Restituisce: DeleteCommentVote200Response

Esempio

Esempio di deleteVote

Copy

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

Ottieni voti

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
urlId	string	Sì

Risposta

Restituisce: GetVotes200Response

Esempio

Esempio getVotes

Copy

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

Ottieni voti per utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
userId	string	No
anonUserId	string	No

Risposta

Restituisce: GetVotesForUser200Response

Esempio

Esempio di getVotesForUser

Copy

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

Hai bisogno di aiuto?

Se riscontri problemi o hai domande sullo SDK JavaScript/TypeScript, per favore:

Contribuire

I contributi sono benvenuti! Visita il repository GitHub per le linee guida sui contributi.

Lingua 🇮🇹 Italiano

Introduzione

Riferimento API

Documentazione

Utilizzo

Aggregazione

Log di audit

Blocca da commento

Controlla commenti bloccati

Commenti

Configurazioni dominio

Modelli email

Registro eventi

Post feed

Segnala commento

Hashtag

Moderatori

Conteggio notifiche

Notifiche

Pagine

Eventi webhook in sospeso

Configurazioni domande

Risultati domande

Aggregazione risultati domande

Utenti SSO

Sottoscrizioni

Utilizzo giornaliero tenant

Pacchetti tenant

Utenti tenant

Tenant

Ticket

Carica immagine

Progresso badge utente

Badge utente

Notifiche utente

Stato presenza utente

Ricerca utenti

Utenti

Voti

FastComments JavaScript/TypeScript SDK

Repository

Installazione

Documentazione API

Riferimento completo delle API: docs/api/README.md

Compatibilità Browser e Server

Utilizzo

Browser Usage (Client-Side)

Server Usage (Node.js)

Import Solo Tipi

Using Individual API Classes

Browser Environment

Server Environment

API Pubbliche vs Protette

Esempio: Uso della Public API (sicuro per il browser)

Esempio: Uso della Default API (solo lato server)

Integrazione SSO (Single Sign-On)

SSO semplice (solo lato server)

SSO sicuro (lato server, raccomandato)

Utilizzo dell'SSO dal browser (con token generato dal server)

SSO con creazione di commenti

Casi d'uso comuni

Ottenere i commenti di una pagina

Creare un commento

Votare un commento

Gestione utenti (Richiede API Key)

Eventi Live (Aggiornamenti in tempo reale)

Eventi a livello di pagina

Iscriviti agli eventi utente

Ottenere userIdWS

ID di Broadcast

Gestione degli errori

Aggrega

Parametri

Response

Ottieni log di audit

Parametri

Risposta

Esempio

Blocca da commento pubblico

Parametri