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-sdkDocumentazione API
Riferimento completo delle API: docs/api/README.md
Compatibilità Browser vs 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 confetchnativofastcomments-sdk/server- Versione completa per Node.js con supporto SSOfastcomments-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 browserSSO 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 browserUtilizzo 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);
}
}aggregare
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 | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| aggregationRequest | AggregationRequest | Sì | |
| parentTenantId | string | No | |
| includeStats | boolean | No |
Response
Restituisce: AggregationResponse
ottieniLogAudit
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| limit | number | No | |
| skip | number | No | |
| order | SORTDIR | No | |
| after | number | No | |
| before | number | No |
Risposta
Restituisce: GetAuditLogs200Response
bloccaDaCommentoPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Sì | |
| sso | string | No |
Risposta
Restituisce: BlockFromCommentPublic200Response
sbloccaCommentoPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Sì | |
| sso | string | No |
Risposta
Restituisce: UnBlockCommentPublic200Response
controllaCommentiBloccati
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentIds | string | Sì | |
| sso | string | No |
Risposta
Restituisce: CheckedCommentsForBlocked200Response
bloccaUtenteDaCommento
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| blockFromCommentParams | BlockFromCommentParams | Sì | |
| userId | string | No | |
| anonUserId | string | No |
Risposta
Restituisce: BlockFromCommentPublic200Response
creaCommentoPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì | |
| broadcastId | string | Sì | |
| commentData | CommentData | Sì | |
| sessionId | string | No | |
| sso | string | No |
Risposta
Restituisce: CreateCommentPublic200Response
eliminaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| contextUserId | string | No | |
| isLive | boolean | No |
Risposta
Restituisce: DeleteComment200Response
eliminaCommentoPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| broadcastId | string | Sì | |
| editKey | string | No | |
| sso | string | No |
Risposta
Restituisce: DeleteCommentPublic200Response
eliminaVotoCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| voteId | string | Sì | |
| urlId | string | Sì | |
| broadcastId | string | Sì | |
| editKey | string | No | |
| sso | string | No |
Risposta
Restituisce: DeleteCommentVote200Response
segnalaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| userId | string | No | |
| anonUserId | string | No |
Risposta
Restituisce: FlagComment200Response
ottieniCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetComment200Response
ottieniCommenti
Parametri
| Name | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| 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
ottieniCommentiPubblici
req tenantId urlId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
ottieniTestoCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| editKey | string | No | |
| sso | string | No |
Risposta
Restituisce: GetCommentText200Response
ottieniNomiUtentiVotoCommento
Parametri
| Nome | Type | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| dir | number | Sì | |
| sso | string | No |
Risposta
Restituisce: GetCommentVoteUserNames200Response
bloccaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| broadcastId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: LockComment200Response
fissaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| broadcastId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: PinComment200Response
salvaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createCommentParams | CreateCommentParams | Sì | |
| isLive | boolean | No | |
| doSpamCheck | boolean | No | |
| sendEmails | boolean | No | |
| populateNotifications | boolean | No |
Risposta
Restituisce: SaveComment200Response
salvaCommentiInBlocco
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createCommentParams | Array |
Sì | |
| isLive | boolean | No | |
| doSpamCheck | boolean | No | |
| sendEmails | boolean | No | |
| populateNotifications | boolean | No |
Risposta
Restituisce: Array<SaveComment200Response
impostaTestoCommento
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| broadcastId | string | Sì | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Sì | |
| editKey | string | No | |
| sso | string | No |
Risposta
Restituisce: SetCommentText200Response
sbloccaUtenteDaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Sì | |
| userId | string | No | |
| anonUserId | string | No |
Risposta
Restituisce: UnBlockCommentPublic200Response
rimuoviSegnalazioneCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| userId | string | No | |
| anonUserId | string | No |
Risposta
Restituisce: FlagComment200Response
sbloccaCommento
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| broadcastId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: LockComment200Response
rimuoviPinCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| broadcastId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: PinComment200Response
aggiornaCommento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| body | PickAPICommentUpdatableCommentFields | Sì | |
| contextUserId | string | No | |
| doSpamCheck | boolean | No | |
| isLive | boolean | No |
Risposta
Restituisce: FlagCommentPublic200Response
votaCommento
Parametri
| Name | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| urlId | string | Sì | |
| broadcastId | string | Sì | |
| voteBodyParams | VoteBodyParams | Sì | |
| sessionId | string | No | |
| sso | string | No |
Risposta
Restituisce: VoteComment200Response
aggiungiConfigurazioneDominio
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| addDomainConfigParams | AddDomainConfigParams | Sì |
Risposta
Restituisce: AddDomainConfig200Response
eliminaConfigurazioneDominio
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| domain | string | Sì |
Risposta
Restituisce: DeleteDomainConfig200Response
ottieniConfigurazioneDominio
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| domain | string | Sì |
Risposta
Restituisce: GetDomainConfig200Response
ottieniConfigurazioniDominio
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì |
Risposta
Restituisce: GetDomainConfigs200Response
modificaParzialeConfigurazioneDominio
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| domainToUpdate | string | Sì | |
| patchDomainConfigParams | PatchDomainConfigParams | Sì |
Risposta
Restituisce: GetDomainConfig200Response
sostituisciConfigurazioneDominio
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| domainToUpdate | string | Sì | |
| updateDomainConfigParams | UpdateDomainConfigParams | Sì |
Risposta
Restituisce: GetDomainConfig200Response
creaTemplateEmail
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createEmailTemplateBody | CreateEmailTemplateBody | Sì |
Risposta
Restituisce: CreateEmailTemplate200Response
Esempio
Esempio di createEmailTemplate
Copy 
1
2const tenantId: string = "tenant_7a9f2b3d";
3
4const createEmailTemplateBody: CreateEmailTemplateBody = {
5 name: "Comment Notification",
6 subject: "New comment on your article: ",
7 htmlBody: "<p> left a comment:</p><blockquote></blockquote>",
8 enabled: true,
9 defaultLocale: "en-US",
10 metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // dati extra opzionali
11};
12
13const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);
14
eliminaTemplateEmail
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteEmailTemplate
Copy
1
2const tenantId: string = "tenant_4b2f6a-4b2f6a2d";
3const templateId: string = "email_template_9f8b7c3e";
4const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);
5const status: APIStatus | undefined = result?.status
6
eliminaErroreRenderingTemplateEmail
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| errorId | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteEmailTemplateRenderError
Copy
1
2const tenantId: string = "tenant_8f3b2a9c";
3const id: string = "template_4a1c9f7e";
4const errorId: string = "err_20260112_abc123";
5const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
6
ottieniTemplateEmail
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetEmailTemplate200Response
Esempio
Esempio di getEmailTemplate
Copy
1
2(async () => {
3 const tenantId: string = 'acme-enterprises-123';
4 const id: string = 'welcome-email-template-v2';
5 const locale: string | undefined = 'en-US'; // esempio di parametro opzionale
6 const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);
7 console.log(template, locale);
8})();
9
ottieniDefinizioniTemplateEmail
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì |
Risposta
Restituisce: GetEmailTemplateDefinitions200Response
Esempio
Esempio di getEmailTemplateDefinitions
Copy
1
2const tenantId: string = 'acme-enterprises-78f2';
3const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
4
ottieniErroriRenderingTemplateEmail
Parametri
| Name | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| skip | number | No |
Risposta
Restituisce: GetEmailTemplateRenderErrors200Response
Esempio
Esempio di getEmailTemplateRenderErrors
Copy
1
2const tenantId: string = "tenant_7b3f2a9c";
3const id: string = "tmpl_4f1b2c9e";
4const skip: number = 25;
5const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
6
ottieniTemplateEmail
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| skip | number | No |
Risposta
Restituisce: GetEmailTemplates200Response
Esempio
Esempio di getEmailTemplates
Copy
1
2const tenantId: string = 'tenant_8f4d2b7c';
3const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
4const skip: number = 20;
5const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
6
renderizzaTemplateEmail
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Sì | |
| locale | string | No |
Risposta
Restituisce: RenderEmailTemplate200Response
Esempio
Esempio di renderEmailTemplate
Copy
1
2const tenantId: string = 'acme-corp-7f3';
3const renderEmailTemplateBody: RenderEmailTemplateBody = {
4 templateId: 'new-comment-notification',
5 recipientEmail: 'jane.doe@acme.com',
6 variables: {
7 commenterName: 'Samir Patel',
8 commentText: 'I found this article really helpful — thanks for sharing!',
9 threadUrl: 'https://acme.com/blog/123#comments'
10 },
11 includeUnsubscribeLink: true
12};
13const locale: string = 'en-US';
14const response: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);
15
aggiornaTemplateEmail
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateEmailTemplate
Copy
1
2const tenantId: string = 'acme-corp-tenant-01';
3const id: string = 'email_tpl_42b7a9';
4const updateEmailTemplateBody: UpdateEmailTemplateBody = {
5 name: 'Comment Flag Notification',
6 subject: 'A comment was flagged on acme.com',
7 html: '<p>A comment by was flagged. Review at </p>',
8 replyTo: 'noreply@acme.com', // campo opzionale a scopo dimostrativo
9 enabled: true,
10 customConfig: { priority: 'high' } // parametri personalizzati opzionali
11};
12const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);
13
ottieniLogEventi
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì | |
| userIdWS | string | Sì | |
| startTime | number | Sì | |
| endTime | number | Sì |
Risposta
Restituisce: GetEventLog200Response
ottieniLogEventiGlobali
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì | |
| userIdWS | string | Sì | |
| startTime | number | Sì | |
| endTime | number | Sì |
Risposta
Restituisce: GetEventLog200Response
creaFeedPost
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createFeedPostParams | CreateFeedPostParams | Sì | |
| broadcastId | string | No | |
| isLive | boolean | No | |
| doSpamCheck | boolean | No | |
| skipDupCheck | boolean | No |
Risposta
Restituisce: CreateFeedPost200Response
creaFeedPostPubblico
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createFeedPostParams | CreateFeedPostParams | Sì | |
| broadcastId | string | No | |
| sso | string | No |
Risposta
Restituisce: CreateFeedPostPublic200Response
eliminaFeedPostPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| postId | string | Sì | |
| broadcastId | string | No | |
| sso | string | No |
Risposta
Restituisce: DeleteFeedPostPublic200Response
ottieniFeedPost
req tenantId afterId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| afterId | string | No | |
| limit | number | No | |
| tags | Array |
No |
Risposta
Restituisce: GetFeedPosts200Response
ottieniFeedPostPubblici
req tenantId afterId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| afterId | string | No | |
| limit | number | No | |
| tags | Array |
No | |
| sso | string | No | |
| isCrawler | boolean | No | |
| includeUserInfo | boolean | No |
Risposta
Restituisce: GetFeedPostsPublic200Response
ottieniStatisticheFeedPost
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| postIds | Array |
Sì | |
| sso | string | No |
Risposta
Restituisce: GetFeedPostsStats200Response
ottieniReazioniUtentePubbliche
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| postIds | Array |
No | |
| sso | string | No |
Risposta
Restituisce: GetUserReactsPublic200Response
reagisciFeedPostPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| postId | string | Sì | |
| reactBodyParams | ReactBodyParams | Sì | |
| isUndo | boolean | No | |
| broadcastId | string | No | |
| sso | string | No |
Risposta
Restituisce: ReactFeedPostPublic200Response
aggiornaFeedPost
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| feedPost | FeedPost | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
aggiornaFeedPostPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| postId | string | Sì | |
| updateFeedPostParams | UpdateFeedPostParams | Sì | |
| broadcastId | string | No | |
| sso | string | No |
Risposta
Restituisce: CreateFeedPostPublic200Response
segnalaCommentoPubblico
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| isFlagged | boolean | Sì | |
| sso | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
aggiungiHashtag
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | No | |
| createHashTagBody | CreateHashTagBody | No |
Risposta
Restituisce: AddHashTag200Response
Esempio
Esempio di addHashTag
Copy
1
2const tenantId: string = 'tenant_7b2f6c2b';
3const createBody: CreateHashTagBody = {
4 tag: 'feature-request',
5 label: 'Feature Request',
6 description: 'Requests for new functionality in the web client',
7 isActive: true,
8 visibility: 'public',
9 allowedDomains: ['example.com', 'internal.example.com']
10};
11const result: AddHashTag200Response = await addHashTag(tenantId, createBody);
12const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {
13 tag: 'bug',
14 label: 'Bug',
15 description: 'Use for reproducible bugs reported by users',
16 isActive: true,
17 visibility: 'public'
18});
19
aggiungiHashtagInBlocco
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | No | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | No |
Risposta
Restituisce: AddHashTagsBulk200Response
Esempio
Esempio di addHashTagsBulk
Copy
1
2(async () => {
3 const tenantId: string = 'tenant_3f2b9a';
4 const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
5 tags: [
6 { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },
7 { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }
8 ]
9 };
10 const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
11 const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);
12 console.log(result, resultWithNoTenant);
13})();
14
eliminaHashtag
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tag | string | Sì | |
| tenantId | string | No | |
| deleteHashTagRequest | DeleteHashTagRequest | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteHashTag
Copy
1
2const tag: string = 'breaking-news';
3const tenantId: string = 'tenant_42';
4const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;
5const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);
6
ottieniHashtag
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| page | number | No |
Risposta
Restituisce: GetHashTags200Response
Esempio
Esempio getHashTags
Copy
1
2(async () => {
3 const tenantId: string = "acme-corp-7a9f";
4 const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);
5 const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);
6 console.log(tagsPage1, tagsPage2);
7})();
8
modificaParzialeHashtag
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tag | string | Sì | |
| tenantId | string | No | |
| updateHashTagBody | UpdateHashTagBody | No |
Risposta
Restituisce: PatchHashTag200Response
Esempio
Esempio di patchHashTag
Copy
1
2const tag: string = 'release-2026';
3const tenantId: string = 'tenant_42';
4const updateHashTagBody: UpdateHashTagBody = {
5 displayName: 'Release 2026',
6 description: 'Discussions and notes for the 2026 product release',
7 isActive: true
8};
9const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);
10
creaModeratore
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createModeratorBody | CreateModeratorBody | Sì |
Risposta
Restituisce: CreateModerator200Response
Esempio
Esempio di createModerator
Copy
1
2const tenantId: string = "tenant_prod_us-east_01";
3const createModeratorBody: CreateModeratorBody = {
4 email: "maria.lopez+mod@fastcompany.com",
5 username: "mlopez_mod",
6 displayName: "Maria Lopez",
7 roles: ["content_moderator"],
8 notifyOnReports: true,
9 metadata: { region: "us-east", team: "community" }
10};
11const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);
12
eliminaModeratore
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| sendEmail | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteModerator
Copy
1
2const tenantId: string = 'acme-tenant-987';
3const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';
4const sendEmail: string = 'true';
5const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);
6
ottieniModeratore
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetModerator200Response
Esempio
Esempio getModerator
Copy
1
2const tenantId: string = "tenant_eu_4f8d2b9e";
3const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // origine opzionale (potrebbe essere undefined)
4const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);
5
ottieniModeratori
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Yes | |
| skip | number | No |
Risposta
Restituisce: GetModerators200Response
Esempio
Esempio di getModerators
Copy
1
2const tenantId: string = "tenant_corp_7f9b2a";
3const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
4const skip: number = 50;
5const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);
6
inviaInvito
Parametri
| Name | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| fromName | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di sendInvite
Copy
1
2const tenantId: string = 'acme-tenant-004';
3const id: string = 'comment_9b7f3a2c';
4const fromName: string = 'María Hernández';
5const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);
6
aggiornaModeratore
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateModeratorBody | UpdateModeratorBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateModerator
Copy
1
2const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';
3const id: string = 'mod_92a7c4';
4const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };
5const updateModeratorBodyWithOptional: UpdateModeratorBody = {
6 displayName: 'Sophia Patel',
7 email: 'sophia.patel@newsroom.example',
8 permissions: ['remove_comments', 'ban_user'],
9 notifyOnFlag: true // parametro opzionale dimostrato
10};
11const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);
12
eliminaConteggioNotifiche
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteNotificationCount
Copy
1
2const tenantId: string = 'tenant_7f3a1b2c4d9e';
3const notificationId: string = 'notif_8c9d0a1b2f3e4b7';
4const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);
5
ottieniConteggioNotificheCache
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetCachedNotificationCount200Response
Esempio
Esempio di getCachedNotificationCount
Copy
1
2const tenantId: string = 'acme-tenant-01';
3const baseNotificationId: string = 'notif-000123';
4const idSuffix: string | undefined = undefined; // esempio di parametro opzionale
5const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;
6const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);
7console.log(result);
8
ottieniConteggioNotifiche
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
1
2const tenantId: string = 'tenant_8a9b7c';
3const userId: string = 'user_42b3c';
4const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';
5const fromCommentId: string | undefined = undefined;
6const viewed: boolean = false;
7const type: string = 'mention';
8const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);
9
ottieniNotifiche
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
1
2(async () => {
3 const tenantId: string = 'tenant_8f3b1a2c';
4 const userId: string = 'user_42';
5 const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';
6 const fromCommentId: string = 'cmt_9a7b';
7 const viewed: boolean = false;
8 const type: string = 'mention';
9 const skip: number = 0;
10 const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);
11 console.log(response);
12})();
13
aggiornaNotifica
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateNotificationBody | UpdateNotificationBody | Sì | |
| userId | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateNotification
Copy
1
2const tenantId: string = "tenant_86a7b3";
3const id: string = "notif_20260112_01";
4const userId: string = "moderator_42";
5const updateNotificationBody: UpdateNotificationBody = {
6 name: "Flagged comment alert",
7 enabled: true,
8 channels: ["email"],
9 recipients: ["mod-team@news-site.com"],
10 threshold: 1
11};
12
13(async () => {
14 const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);
15 console.log(result);
16})();
17
aggiungiPagina
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createAPIPageData | CreateAPIPageData | Sì |
Risposta
Restituisce: AddPageAPIResponse
eliminaPagina
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: DeletePageAPIResponse
ottieniPaginaPerURLId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì |
Risposta
Restituisce: GetPageByURLIdAPIResponse
ottieniPagine
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì |
Risposta
Restituisce: GetPagesAPIResponse
modificaParzialePagina
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateAPIPageData | UpdateAPIPageData | Sì |
Risposta
Restituisce: PatchPageAPIResponse
eliminaEventoWebhookInSospeso
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deletePendingWebhookEvent
Copy
1
2const tenantId: string = 'tenant_7f4e2b';
3const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';
4const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);
5console.log(result);
6
ottieniConteggioEventiWebhookInSospeso
Parametri
| Name | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
1
2(async () => {
3 const tenantId: string = 'tenant_9c3b2b';
4 const commentId: string = 'cmt_f4a1b2';
5 const externalId: string = 'ext-789';
6 const eventType: string = 'comment.created';
7 const type: string = 'delivery';
8 const domain: string = 'app.example.com';
9 const attemptCountGT: number = 2;
10
11 const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
12 tenantId,
13 commentId,
14 externalId,
15 eventType,
16 type,
17 domain,
18 attemptCountGT
19 );
20
21 console.log(result);
22})();
23
ottieniEventiWebhookInSospeso
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
1
2const tenantId: string = "tenant_78b2f1";
3const commentId: string = "cmt_0042";
4const eventType: string = "comment.created";
5const domain: string = "blog.example.com";
6const attemptCountGT: number = 1;
7const skip: number = 0;
8
9const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
10 tenantId,
11 commentId,
12 undefined, // externalId
13 eventType,
14 undefined, // type
15 domain,
16 attemptCountGT,
17 skip
18);
19
creaConfigurazioneDomanda
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| createQuestionConfigBody | CreateQuestionConfigBody | Sì |
Risposta
Restituisce: CreateQuestionConfig200Response
Esempio
Esempio di createQuestionConfig
Copy
1
2const tenantId: string = "tenant_live_7f8b3c2a";
3const customOptions: QuestionConfigCustomOptionsInner[] = [
4 { value: "under18", label: "Under 18" },
5 { value: "18-24", label: "18-24" },
6 { value: "25-34", label: "25-34", defaultSelected: true }
7];
8const createQuestionConfigBody: CreateQuestionConfigBody = {
9 key: "age_range",
10 label: "What is your age range?",
11 required: false, // opzionale: mostra la differenza tra campi opzionali omessi e inclusi
12 renderingType: QuestionRenderingType.Dropdown,
13 options: customOptions,
14 whenSave: QuestionWhenSave.Always
15};
16const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);
17
eliminaConfigurazioneDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteQuestionConfig
Copy
1
2async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {
3 if (!id) return null;
4 const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);
5 return result;
6}
7const tenantId: string = 'tenant_acme_001';
8const optionalConfigId: string | undefined = 'qcfg_20260112_01';
9(async (): Promise<void> => {
10 const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);
11 void deleted;
12})();
13
ottieniConfigurazioneDomanda
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetQuestionConfig200Response
Esempio
Esempio di getQuestionConfig
Copy
1
2const tenantId: string = 'acme-corp-47';
3const questionId: string = 'q-2026-01-12-01';
4const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
5function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
6 // includeMetadata è opzionale; implementazione omessa per brevità
7 return undefined;
8}
9const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
10const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);
11
ottieniConfigurazioniDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| skip | number | No |
Risposta
Restituisce: GetQuestionConfigs200Response
Esempio
Esempio di getQuestionConfigs
Copy
1
2const tenantId: string = 'tenant-42a7b9';
3const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
4const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);
5
aggiornaConfigurazioneDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateQuestionConfig
Copy
1
2const tenantId: string = 'tenant-82b3a';
3const id: string = 'qst-20260112';
4const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;
5const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);
6
creaRisultatoDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createQuestionResultBody | CreateQuestionResultBody | Sì |
Risposta
Restituisce: CreateQuestionResult200Response
Esempio
Esempio di createQuestionResult
Copy
1
2const tenantId: string = "fc_tenant_7a3c_us-east-1";
3const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };
4const createQuestionResultBody: CreateQuestionResultBody = {
5 questionId: "q_42",
6 commenterId: "user_1984",
7 answer: "yes",
8 score: 4,
9 meta: [metaItem] // metadati opzionali (dimostrazione)
10} as CreateQuestionResultBody;
11const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);
12
eliminaRisultatoDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteQuestionResult
Copy
1
2const tenantId: string = 'acme-tenant-01';
3const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';
4const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);
5console.log(deletedResult);
6
ottieniRisultatoDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetQuestionResult200Response
Esempio
Esempio di getQuestionResult
Copy
1
2const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
3const questionId: string = "question_72f1b9c3a4";
4const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
5console.log(result);
6
ottieniRisultatiDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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 getQuestionResults
Copy
1
2const tenantId: string = 'tenant_42';
3const urlId: string = 'news/2025/fastcomments-release';
4const userId: string = 'user_8b7f3c';
5const startDate: string = '2025-01-01T00:00:00Z';
6const questionIds: string = 'q123,q124';
7const skip: number = 20;
8const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);
9
aggiornaRisultatoDomanda
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateQuestionResultBody | UpdateQuestionResultBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateQuestionResult
Copy
1
2const tenantId: string = 'tenant_84f2b9';
3const id: string = 'question_3a7c1d';
4const updateQuestionResultBody: UpdateQuestionResultBody = {
5 result: { verdict: 'helpful', confidence: 0.92 },
6 reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
7 notifyUser: true // parametro opzionale incluso
8};
9const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);
10
aggregazioneRisultatiDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| questionId | string | No | |
| questionIds | Array |
No | |
| urlId | string | No | |
| timeBucket | AggregateTimeBucket | No | |
| startDate | Date | No | |
| forceRecalculate | boolean | No |
Risposta
Restituisce: AggregateQuestionResults200Response
aggregazioneInBloccoRisultatiDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Sì | |
| forceRecalculate | boolean | No |
Risposta
Restituisce: BulkAggregateQuestionResults200Response
combinaCommentiConRisultatiDomanda
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
aggiungiUtenteSSO
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createAPISSOUserData | CreateAPISSOUserData | Sì |
Risposta
Restituisce: AddSSOUserAPIResponse
eliminaUtenteSSO
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| deleteComments | boolean | No | |
| commentDeleteMode | string | No |
Risposta
Restituisce: DeleteSSOUserAPIResponse
ottieniUtenteSSOPerEmail
Parametri
| Nome | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| string | Sì |
Risposta
Restituisce: GetSSOUserByEmailAPIResponse
ottieniUtenteSSOPerId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetSSOUserByIdAPIResponse
ottieniUtentiSSO
Parametri
| Nome | Type | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| skip | number | No |
Risposta
Restituisce: GetSSOUsers200Response
modificaParzialeUtenteSSO
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateAPISSOUserData | UpdateAPISSOUserData | Sì | |
| updateComments | boolean | No |
Risposta
Restituisce: PatchSSOUserAPIResponse
sostituisciUtenteSSO
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateAPISSOUserData | UpdateAPISSOUserData | Sì | |
| updateComments | boolean | No |
Risposta
Restituisce: PutSSOUserAPIResponse
creaAbbonamento
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Sì |
Risposta
Restituisce: CreateSubscriptionAPIResponse
eliminaAbbonamento
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| userId | string | No |
Risposta
Restituisce: DeleteSubscriptionAPIResponse
ottieniAbbonamenti
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| userId | string | No |
Risposta
Restituisce: GetSubscriptionsAPIResponse
ottieniUtilizziGiornalieriTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Yes | |
| yearNumber | number | No | |
| monthNumber | number | No | |
| dayNumber | number | No | |
| skip | number | No |
Risposta
Restituisce: GetTenantDailyUsages200Response
Esempio
Esempio di getTenantDailyUsages
Copy
1
2const tenantId: string = "tenant_89f3c2-prod";
3const yearNumber: number = 2026;
4const monthNumber: number = 1;
5const skip: number = 0;
6const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);
7
creaPacchettoTenant
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| createTenantPackageBody | CreateTenantPackageBody | Sì |
Risposta
Restituisce: CreateTenantPackage200Response
Esempio
Esempio di createTenantPackage
Copy
1
2const tenantId: string = "tenant_7f3b1a9c";
3const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };
4const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };
5const createTenantPackageBody: CreateTenantPackageBody = {
6 packageName: "Premium Plus",
7 tenantPackage,
8 customConfig,
9 notes: "Enable advanced moderation and image uploads" // parametro opzionale dimostrativo
10};
11const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
12
eliminaPacchettoTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteTenantPackage
Copy
1
2const tenantId: string = 'fc-tenant-8a9c2b';
3const packageId: string = 'pkg-47f3c9';
4const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);
5
ottieniPacchettoTenant
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetTenantPackage200Response
Esempio
Esempio di getTenantPackage
Copy
1
2const tenantId: string = 'tenant_westus_01';
3const packageId: string = 'pkg_premium_annual_2026';
4interface FetchOptions { includeArchived?: boolean }
5const options: FetchOptions = { includeArchived: false };
6const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);
7
ottieniPacchettiTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| skip | number | No |
Risposta
Restituisce: GetTenantPackages200Response
Esempio
Esempio di getTenantPackages
Copy
1
2const tenantId: string = 'tenant_4f3a9c2d';
3const skip: number = 25;
4const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);
5const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);
6
sostituisciPacchettoTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di replaceTenantPackage
Copy
1
2const tenantId: string = 'tenant-9b72f2';
3const packageId: string = 'pkg-prod-v2';
4const replaceTenantPackageBody: ReplaceTenantPackageBody = {
5 name: 'Premium Moderation Bundle',
6 enabled: true,
7 maxModerators: 4,
8 // i campi opzionali come "notes" o "trialExpiry" sono intenzionalmente omessi qui
9} as ReplaceTenantPackageBody;
10const result: FlagCommentPublic200Response = await replaceTenantPackage(
11 tenantId,
12 packageId,
13 replaceTenantPackageBody
14);
15
aggiornaPacchettoTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateTenantPackageBody | UpdateTenantPackageBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateTenantPackage
Copy
1
2const tenantId: string = 'tenant_8a4f1c9b';
3const packageId: string = 'pkg_premium_v2';
4const customConfig: CustomConfigParameters = { enableRichText: true, maxImagesPerComment: 5 };
5const updateTenantPackageBody: UpdateTenantPackageBody = {
6 name: 'Premium Moderation Package',
7 enabled: true,
8 description: 'Adds advanced spam rules, image moderation and priority support',
9 customConfigParameters: customConfig
10};
11const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, packageId, updateTenantPackageBody);
12
creaUtenteTenant
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| createTenantUserBody | CreateTenantUserBody | Sì |
Risposta
Restituisce: CreateTenantUser200Response
Esempio
Esempio di createTenantUser
Copy
1
2const tenantId: string = "tenant_9a8c7e4b";
3const createTenantUserBody: CreateTenantUserBody = {
4 email: "julia.smith@acme-corp.com",
5 displayName: "Julia Smith",
6 role: "moderator",
7 password: "Str0ngP@ssword!23",
8 sendInviteEmail: true, // parametro opzionale dimostrato
9 locale: "en-US",
10 metadata: { department: "Customer Success" }
11};
12const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
13
eliminaUtenteTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| deleteComments | string | No | |
| commentDeleteMode | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteTenantUser
Copy
1
2const tenantId: string = 'tenant_8f3b2a9c';
3const id: string = 'user_4e5f6a7b';
4const deleteComments: string = 'true';
5const commentDeleteMode: string = 'hard';
6
7const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);
8
ottieniUtenteTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetTenantUser200Response
Esempio
Esempio getTenantUser
Copy
1
2const tenantId: string = "tenant_9f7d4b2a-1c3e";
3const id: string = "user_6a12b3c4d5";
4const includeProfile: boolean | undefined = true; // esempio di parametro opzionale
5const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
6console.log("Tenant user fetched", response);
7
ottieniUtentiTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| skip | number | No |
Risposta
Restituisce: GetTenantUsers200Response
Esempio
Esempio di getTenantUsers
Copy
1
2const tenantId: string = 'tenant_8f3b2c1a';
3const skip: number = 50;
4const firstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
5const nextPage: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
6
sostituisciUtenteTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| replaceTenantUserBody | ReplaceTenantUserBody | Sì | |
| updateComments | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di replaceTenantUser
Copy
1
2const tenantId: string = "tenant_5f8b9a";
3const id: string = "user_92bf21";
4const replaceTenantUserBody: ReplaceTenantUserBody = {
5 email: "jane.doe@acme-corp.com",
6 displayName: "Jane Doe",
7 externalId: "acme|12345",
8 roles: ["commenter", "moderator"],
9 isActive: true,
10 metadata: { team: "product", location: "NYC" }
11};
12const updateComments: string = "Update historical comments to reflect new display name";
13const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);
14
inviaLinkAccesso
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| redirectURL | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di sendLoginLink
Copy
1
2const tenantId: string = 'tenant_acme_01';
3const id: string = 'user_9f3b2a';
4const redirectURL: string = 'https://app.example.com/onboard?source=login-email';
5const result: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
6
aggiornaUtenteTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateTenantUserBody | UpdateTenantUserBody | Sì | |
| updateComments | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateTenantUser
Copy
1
2const tenantId: string = 'tenant_84f3b2';
3const id: string = 'user_7a9d1c';
4const updateComments: string = 'Promoted to moderator and updated contact email';
5const updateTenantUserBody: UpdateTenantUserBody = {
6 email: 'jane.doe+mod@example.com',
7 displayName: 'Jane D.',
8 roles: ['moderator'],
9 isBanned: false,
10 metadata: { department: 'community' }
11};
12const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
13
creaTenant
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| createTenantBody | CreateTenantBody | Sì |
Risposta
Restituisce: CreateTenant200Response
Esempio
Esempio di createTenant
Copy
1
2const tenantId: string = "acme-corporation";
3const billing: BillingInfo = { planId: "pro", billingContactEmail: "finance@acme-corp.com", currency: "USD" };
4const domainConfig: APIDomainConfiguration = { primaryDomain: "comments.acme-corp.com", allowedDomains: ["acme-corp.com", "www.acme-corp.com"], enforceHttps: true };
5const importedSites: ImportedSiteType[] = [{ siteId: "site-001", url: "https://blog.acme-corp.com", name: "Acme Blog" }]; // opzionale
6const createBody: CreateTenantBody = { tenantName: "Acme Corporation", adminEmail: "admin@acme-corp.com", billingInfo: billing, domainConfiguration: domainConfig, importedSites, enableModeration: true };
7const response: CreateTenant200Response = await createTenant(tenantId, createBody);
8
eliminaTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| sure | string | No |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di deleteTenant
Copy
1
2const tenantId: string = "tenant_7b3f1a9e";
3const id: string = "flag_9c4d2b1a";
4const sure: string = "yes_confirm_delete";
5
6const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);
7console.log(result);
8
ottieniTenant
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetTenant200Response
Esempio
Esempio di getTenant
Copy
1
2const tenantId: string = "tenant_acme_corp";
3const id: string = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
4interface GetOptions { includeDeleted?: boolean; locale?: string; }
5const options: GetOptions = { locale: "en-US" };
6const result: GetTenant200Response = await getTenant(tenantId, id);
7
ottieniTenants
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| meta | string | No | |
| skip | number | No |
Risposta
Restituisce: GetTenants200Response
Esempio
Esempio di getTenants
Copy
1
2(async () => {
3 const tenantId: string = 'tenant_9f2d1b7c';
4 const meta: string = 'include=domains,billing,customConfig';
5 const skip: number = 20;
6 const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
7 console.log(response);
8})();
9
aggiornaTenant
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateTenantBody | UpdateTenantBody | Sì |
Risposta
Restituisce: FlagCommentPublic200Response
Esempio
Esempio di updateTenant
Copy
1
2const tenantId: string = "tenant_01H4ZQ7KABCD";
3const id: string = "site_9f8e7d6c";
4const apiDomainConfiguration: APIDomainConfiguration = {
5 primaryDomain: "comments.acme.com",
6 allowSubdomains: true
7};
8const billingInfo: BillingInfo = {
9 planName: "Business",
10 billingContactEmail: "billing@acme.com",
11 seats: 25
12};
13const updateTenantBody: UpdateTenantBody = {
14 displayName: "Acme Corporation Comments",
15 apiDomainConfiguration,
16 billingInfo, // parametro opzionale dimostrato
17 enableModeration: true
18};
19const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);
20
caricaImmagine
Carica e ridimensiona un'immagine
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| file | Blob | Sì | |
| sizePreset | SizePreset | No | |
| urlId | string | No |
Risposta
Restituisce: UploadImageResponse
ottieniProgressoBadgeUtentePerId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetUserBadgeProgressById200Response
ottieniProgressoBadgeUtentePerUserId
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| userId | string | Sì |
Risposta
Restituisce: GetUserBadgeProgressById200Response
ottieniListaProgressoBadgeUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| userId | string | No | |
| limit | number | No | |
| skip | number | No |
Risposta
Restituisce: GetUserBadgeProgressList200Response
creaBadgeUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| createUserBadgeParams | CreateUserBadgeParams | Sì |
Risposta
Restituisce: CreateUserBadge200Response
eliminaBadgeUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: UpdateUserBadge200Response
ottieniBadgeUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetUserBadge200Response
ottieniBadgeUtenti
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| userId | string | No | |
| badgeId | string | No | |
| type | number | No | |
| displayedOnComments | boolean | No | |
| limit | number | No | |
| skip | number | No |
Risposta
Restituisce: GetUserBadges200Response
aggiornaBadgeUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| updateUserBadgeParams | UpdateUserBadgeParams | Sì |
Risposta
Restituisce: UpdateUserBadge200Response
ottieniConteggioNotificheUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: GetUserNotificationCount200Response
ottieniNotificheUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| 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
resettaConteggioNotificheUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: ResetUserNotifications200Response
resettaNotificheUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| afterId | string | No | |
| afterCreatedAt | number | No | |
| unreadOnly | boolean | No | |
| dmOnly | boolean | No | |
| noDm | boolean | No | |
| sso | string | No |
Risposta
Restituisce: ResetUserNotifications200Response
aggiornaStatoIscrizioneCommentiNotificheUtente
Abilita o disabilita le notifiche per un commento specifico.
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| notificationId | string | Sì | |
| optedInOrOut | UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum | Sì | |
| commentId | string | Sì | |
| sso | string | No |
Risposta
Restituisce: UpdateUserNotificationStatus200Response
aggiornaStatoIscrizionePagineNotificheUtente
Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, vengono create notifiche per nuovi commenti di primo livello, e anche
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì | |
| url | string | Sì | |
| pageTitle | string | Sì | |
| subscribedOrUnsubscribed | UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum | Sì | |
| sso | string | No |
Risposta
Restituisce: UpdateUserNotificationStatus200Response
aggiornaStatoNotificheUtente
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| notificationId | string | Sì | |
| newStatus | UpdateUserNotificationStatusNewStatusEnum | Sì | |
| sso | string | No |
Risposta
Restituisce: UpdateUserNotificationStatus200Response
ottieniStatiPresenzaUtenti
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlIdWS | string | Sì | |
| userIds | string | Sì |
Risposta
Restituisce: GetUserPresenceStatuses200Response
cercaUtenti
Parametri
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì | |
| usernameStartsWith | string | Sì | |
| mentionGroupIds | Array |
No | |
| sso | string | No |
Risposta
Restituisce: SearchUsers200Response
ottieniUtente
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì |
Risposta
Restituisce: GetUser200Response
Esempio
Esempio getUser
Copy
1
2const tenantId: string = "acme-publishing-42";
3const userIdOptional: string | undefined = "user_9d7b4c"; // potrebbe essere undefined in alcuni flussi (opzionale)
4const id: string = userIdOptional ?? "user_default_0001";
5const result: GetUser200Response = await getUser(tenantId, id);
6console.log(result);
7
creaVoto
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| commentId | string | Sì | |
| direction | CreateVoteDirectionEnum | Sì | |
| userId | string | No | |
| anonUserId | string | No |
Risposta
Restituisce: VoteComment200Response
Esempio
Esempio di createVote
Copy
1
2(async () => {
3 const tenantId: string = 'acme-tenant-812';
4 const commentId: string = '5e8f8b7a-3d4b-4f1b-9a2e-1c9f2d6a7b8c';
5 const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.UP;
6 const anonUserId: string = 'anon-84b9c2d';
7 const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);
8 console.log(voteResult);
9})();
10
eliminaVoto
Parametri
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| tenantId | string | Sì | |
| id | string | Sì | |
| editKey | string | No |
Risposta
Restituisce: DeleteCommentVote200Response
Esempio
Esempio di deleteVote
Copy
1
2const tenantId: string = 'tenant_7f3b21c9';
3const id: string = 'vote_4a2d9f1b';
4const editKey: string = 'edit_92b7c6a1';
5
6const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);
7const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
8
ottieniVoti
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì |
Risposta
Restituisce: GetVotes200Response
Esempio
Esempio getVotes
Copy
1
2const tenantId: string = 'tenant_9f8b3c_prod';
3const urlId: string = '/news/2026/typescript-ecosystem-update';
4const votes: GetVotes200Response = await getVotes(tenantId, urlId);
5// Se esistesse un parametro opzionale, ad esempio includeHidden, potrebbe essere utilizzato così:
6// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });
7
ottieniVotiPerUtente
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Sì | |
| urlId | string | Sì | |
| userId | string | No | |
| anonUserId | string | No |
Risposta
Restituisce: GetVotesForUser200Response
Esempio
Esempio di getVotesForUser
Copy
1
2const tenantId: string = 'tenant_acme_01';
3const urlId: string = 'news/2026/01/12/product-launch';
4const userId: string = 'user_9c3f2b';
5const anonUserId: string = 'anon_d4e7a1';
6
7const votesForUser: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId);
8const votesForAnon: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, undefined, anonUserId);
9
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.