FastComments JavaScript/TypeScript SDK
Dit is de officiële JavaScript/TypeScript SDK voor FastComments.
Officiële JavaScript/TypeScript SDK voor de FastComments API
Repository
Installatie 
npm install fastcomments-sdkAPI-documentatie
Volledige API-referentie: docs/api/README.md
Browser- vs servercompatibiliteit
Deze SDK gebruikt dubbele toegangspunten om optimale compatibiliteit te waarborgen en runtime-fouten te voorkomen:
fastcomments-sdk/browser- Browserveilige versie met nativefetchfastcomments-sdk/server- Volledige Node.js-versie met SSO-ondersteuningfastcomments-sdk(standaard) - Alleen types, veilig om overal te importeren
Gebruik
Deze SDK biedt afzonderlijke toegangspunten voor browser- en serveromgevingen om optimale compatibiliteit en beveiliging te garanderen:
Browsergebruik (Client-Side)
Voor browser/frontend-applicaties, gebruik de browserveilige export die Node.js-afhankelijkheden uitsluit:
// Browser-veilige import (geen Node.js-afhankelijkheden)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';
// Maak een browser SDK-instantie
const sdk = createFastCommentsBrowserSDK({
basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});
// Gebruik openbare API's (geen API-sleutel nodig - veilig voor browsers)
const comments = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});Servergebruik (Node.js)
Voor server/backend-applicaties, gebruik de volledige SDK met SSO- en authenticatiefuncties:
// Server-side import (inclusief SSO en ontworpen om te werken met NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';
// Maak een server SDK-instantie
const sdk = createFastCommentsSDK({
apiKey: 'your-api-key', // Houd dit geheim op de server!
basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});
// Gebruik beveiligde API's met uw API-sleutel
const comments = await sdk.defaultApi.getComments({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});Alleen types importeren
Als u alleen TypeScript-typen nodig heeft (geen runtime-code), gebruik dan de standaardimport:
// Alleen types (geen runtime-afhankelijkheden - overal veilig)
import type {
PublicComment,
CreateCommentParams,
GetCommentsPublic200Response
} from 'fastcomments-sdk';Gebruik van individuele API-klassen
Browseromgeving
import { PublicApi, Configuration } from 'fastcomments-sdk/browser';
const config = new Configuration({
basePath: 'https://fastcomments.com'
});
const publicApi = new PublicApi(config);Serveromgeving
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);Openbare vs beveiligde API's
De SDK biedt drie hoofd-API-klassen:
DefaultApi- Beveiligde endpoints die uw API-sleutel vereisen voor authenticatie. Gebruik deze voor serverzijde-bewerkingen.PublicApi- Publieke endpoints die kunnen worden benaderd zonder API-sleutel. Deze kunnen rechtstreeks vanuit browsers/mobiele apparaten/etc. worden aangeroepen.HiddenApi- Interne/admin endpoints voor geavanceerde gebruikssituaties.
Voorbeeld: Public API gebruiken (browser-veilig)
import { PublicApi } from 'fastcomments-sdk/browser';
const publicApi = new PublicApi();
// Haal reacties op voor een pagina (geen API-sleutel vereist)
const response = await publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});Voorbeeld: Default API gebruiken (alleen serverzijde)
import { DefaultApi, Configuration } from 'fastcomments-sdk/server';
const config = new Configuration({
apiKey: 'your-api-key' // Houd dit geheim!
});
const defaultApi = new DefaultApi(config);
// Haal reacties op met volledige beheerdersrechten
const response = await defaultApi.getComments({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});SSO (Single Sign-On) integratie
FastComments ondersteunt SSO om te integreren met uw bestaande gebruikersauthenticatiesysteem. SSO-functionaliteit is alleen beschikbaar in de server-export omdat het Node.js crypto-functies vereist.
Eenvoudige SSO (Alleen serverzijde)
Eenvoudige SSO moet aan de serverzijde worden gegenereerd en naar de client worden gestuurd:
// Code aan de serverzijde (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';
// Maak eenvoudige SSO met de ingebouwde helper
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();
// Stuur ssoToken naar uw client-side code
// Client-side code kan dit token vervolgens gebruiken met de browser SDKBeveiligde SSO (Server-side, aanbevolen)
Beveiligde SSO moet aan de serverzijde worden geïmplementeerd en biedt betere beveiliging:
// Code aan de serverzijde (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';
// Maak beveiligde SSO met de ingebouwde helper
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();
// Gebruik met API-aanroepen op de server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id',
sso: JSON.stringify(ssoConfig)
});
// Of stuur ssoConfig naar de client voor gebruik in de browserSSO gebruiken vanuit de browser (met door de server gegenereerd token)
// Code aan de clientzijde (browser)
import { PublicApi } from 'fastcomments-sdk/browser';
// Haal SSO-token op van uw server-endpoint
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 // Gebruik het door de server gegenereerde SSO-token
});SSO met het aanmaken van een reactie
// Server-side: Maak SSO en reactie
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)
});Veelvoorkomende use-cases
Reacties ophalen voor een pagina
const comments = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'article-123'
});Een reactie aanmaken
const newComment = await sdk.publicApi.createCommentPublic({
createCommentParams: {
tenantId: 'your-tenant-id',
urlId: 'article-123',
comment: 'Great article!',
commenterName: 'John Doe',
commenterEmail: 'john@example.com'
}
});Stemmen op een reactie
const voteResponse = await sdk.publicApi.voteComment({
voteBodyParams: {
commentId: 'comment-id',
direction: 1 // 1 voor omhoog stemmen, -1 voor omlaag stemmen
}
});Gebruikersbeheer (vereist API-sleutel)
// Zoeken naar gebruikers (vereist DefaultApi)
const users = await sdk.defaultApi.searchUsers({
tenantId: 'your-tenant-id',
urlId: 'page-id',
usernameStartsWith: 'john'
});Live-evenementen (realtime updates)
Abonneer op live-evenementen om realtime updates te ontvangen voor reacties, stemmen en andere activiteiten.
Paginaniveau-evenementen
Luister naar live-evenementen op een specifieke pagina (reacties, stemmen, enz.):
import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';
const config = {
tenantId: 'your-tenant-id',
urlId: 'page-url-id',
};
// Abonneer op live-evenementen voor een pagina
const subscription = subscribeToChanges(
config,
'your-tenant-id', // tenantIdWS
'page-url-id', // urlIdWS
'user-session-id', // userIdWS (haal dit uit het antwoord van getComments)
(event: LiveEvent) => {
console.log('Live event received:', event);
switch (event.type) {
case LiveEventType.new_comment:
console.log('New comment:', event.comment);
// Werk je UI bij met de nieuwe reactie
break;
case LiveEventType.new_vote:
console.log('New vote:', event.vote);
// Werk de stemaantallen in je UI bij
break;
case LiveEventType.updated_comment:
console.log('Comment updated:', event.comment);
break;
default:
console.log('Other event type:', event.type);
}
return true; // Geef true terug als het event is verwerkt
},
(isConnected: boolean) => {
console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
}
);
// Sluit de subscription wanneer klaar
subscription.close();Abonneer op gebruikersgebeurtenissen
Luister naar gebruiker-specifieke gebeurtenissen (meldingen, vermeldingen, enz.):
import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';
const userConfig = {
userIdWS: 'user-session-id', // Verkrijg dit uit het antwoord van getComments
};
// Abonneer op de persoonlijke feed van de gebruiker
const userSubscription = subscribeToUserFeed(
userConfig,
(event: LiveEvent) => {
console.log('User event received:', event);
switch (event.type) {
case LiveEventType.notification:
console.log('New notification:', event.notification);
// Toon melding in je 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');
}
);
// Sluit wanneer klaar
userSubscription.close();Het verkrijgen van userIdWS
De userIdWS-parameter is vereist voor live-evenementen en kan worden verkregen uit API-responses:
const response = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-id'
});
// Extraheer userIdWS uit het antwoord
const userIdWS = response.data?.userSessionInfo?.userIdWS;
if (userIdWS) {
// Nu kun je je abonneren op live-evenementen
const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}Broadcast IDs
Je ziet dat je in sommige API-aanroepen een broadcastId moet doorgeven. Wanneer je events ontvangt, krijg je deze ID terug, zodat je het event kunt negeren als je van plan bent om wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen omdat het de beste ervaring biedt). Geef hier een UUID door. De ID moet uniek genoeg zijn om niet twee keer in een browsersessie voor te komen.
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() // Unieke ID voor deze bewerking
}
});Foutafhandeling
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);
}
}aggregate
Aggregeert documenten door ze te groeperen (als groupBy wordt opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, etc.) worden ondersteund.
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| aggregationRequest | AggregationRequest | Ja | |
| parentTenantId | string | Nee | |
| includeStats | boolean | Nee |
Antwoord
Retourneert: AggregationResponse
getAuditLogs
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| limit | number | Nee | |
| skip | number | Nee | |
| order | SORTDIR | Nee | |
| after | number | Nee | |
| before | number | Nee |
Response
Retourneert: GetAuditLogs200Response
blockFromCommentPublic
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ja | |
| sso | string | Nee |
Respons
Retourneert: BlockFromCommentPublic200Response
unBlockCommentPublic
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ja | |
| sso | string | Nee |
Respons
Geeft terug: UnBlockCommentPublic200Response
checkedCommentsForBlocked
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentIds | string | Ja | |
| sso | string | Nee |
Response
Geeft terug: CheckedCommentsForBlocked200Response
blockUserFromComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| blockFromCommentParams | BlockFromCommentParams | Ja | |
| userId | string | Nee | |
| anonUserId | string | Nee |
Response
Geeft terug: BlockFromCommentPublic200Response
createCommentPublic
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Ja | |
| commentData | CommentData | Ja | |
| sessionId | string | Nee | |
| sso | string | Nee |
Respons
Geeft terug: CreateCommentPublic200Response
deleteComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| contextUserId | string | Nee | |
| isLive | boolean | Nee |
Respons
Retourneert: DeleteComment200Response
deleteCommentPublic
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| editKey | string | Nee | |
| sso | string | Nee |
Antwoord
Retourneert: DeleteCommentPublic200Response
deleteCommentVote
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| voteId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Ja | |
| editKey | string | Nee | |
| sso | string | Nee |
Respons
Retourneert: DeleteCommentVote200Response
flagComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| userId | string | Nee | |
| anonUserId | string | Nee |
Antwoord
Retourneert: FlagComment200Response
getComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwoord
Retourneert: GetComment200Response
getComments
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| page | number | Nee | |
| limit | number | Nee | |
| skip | number | Nee | |
| asTree | boolean | Nee | |
| skipChildren | number | Nee | |
| limitChildren | number | Nee | |
| maxTreeDepth | number | Nee | |
| urlId | string | Nee | |
| userId | string | Nee | |
| anonUserId | string | Nee | |
| contextUserId | string | Nee | |
| hashTag | string | Nee | |
| parentId | string | Nee | |
| direction | SortDirections | Nee |
Antwoord
Retourneert: GetComments200Response
getCommentsPublic
req tenantId urlId
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| page | number | Nee | |
| direction | SortDirections | Nee | |
| sso | string | Nee | |
| skip | number | Nee | |
| skipChildren | number | Nee | |
| limit | number | Nee | |
| limitChildren | number | Nee | |
| countChildren | boolean | Nee | |
| fetchPageForCommentId | string | Nee | |
| includeConfig | boolean | Nee | |
| countAll | boolean | Nee | |
| includei10n | boolean | Nee | |
| locale | string | Nee | |
| modules | string | Nee | |
| isCrawler | boolean | Nee | |
| includeNotificationCount | boolean | Nee | |
| asTree | boolean | Nee | |
| maxTreeDepth | number | Nee | |
| useFullTranslationIds | boolean | Nee | |
| parentId | string | Nee | |
| searchText | string | Nee | |
| hashTags | Array |
Nee | |
| userId | string | Nee | |
| customConfigStr | string | Nee | |
| afterCommentId | string | Nee | |
| beforeCommentId | string | Nee |
Respons
Retourneert: GetCommentsPublic200Response
getCommentText
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| editKey | string | Nee | |
| sso | string | Nee |
Antwoord
Retourneert: GetCommentText200Response
getCommentVoteUserNames
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| dir | number | Ja | |
| sso | string | Nee |
Respons
Retourneert: GetCommentVoteUserNames200Response
lockComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nee |
Respons
Retourneert: LockComment200Response
pinComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nee |
Antwoord
Returneert: PinComment200Response
saveComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createCommentParams | CreateCommentParams | Ja | |
| isLive | boolean | Nee | |
| doSpamCheck | boolean | Nee | |
| sendEmails | boolean | Nee | |
| populateNotifications | boolean | Nee |
Respons
Geeft terug: SaveComment200Response
saveCommentsBulk
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createCommentParams | Array |
Ja | |
| isLive | boolean | Nee | |
| doSpamCheck | boolean | Nee | |
| sendEmails | boolean | Nee | |
| populateNotifications | boolean | Nee |
Respons
Retourneert: Array<SaveComment200Response
setCommentText
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Ja | |
| editKey | string | Nee | |
| sso | string | Nee |
Response
Retourneert: SetCommentText200Response
unBlockUserFromComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Ja | |
| userId | string | Nee | |
| anonUserId | string | Nee |
Respons
Retourneert: UnBlockCommentPublic200Response
unFlagComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| userId | string | Nee | |
| anonUserId | string | Nee |
Respons
Retourneert: FlagComment200Response
unLockComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nee |
Response
Retourneert: LockComment200Response
unPinComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nee |
Antwoord
Retourneert: PinComment200Response
updateComment
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| body | PickAPICommentUpdatableCommentFields | Ja | |
| contextUserId | string | Nee | |
| doSpamCheck | boolean | Nee | |
| isLive | boolean | Nee |
Respons
Retourneert: FlagCommentPublic200Response
voteComment
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Ja | |
| voteBodyParams | VoteBodyParams | Ja | |
| sessionId | string | Nee | |
| sso | string | Nee |
Response
Retourneert: VoteComment200Response
addDomainConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| addDomainConfigParams | AddDomainConfigParams | Ja |
Respons
Retourneert: AddDomainConfig200Response
deleteDomainConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| domain | string | Ja |
Respons
Geeft terug: DeleteDomainConfig200Response
getDomainConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| domain | string | Ja |
Antwoord
Retourneert: GetDomainConfig200Response
getDomainConfigs
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja |
Antwoord
Retourneert: GetDomainConfigs200Response
patchDomainConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| domainToUpdate | string | Ja | |
| patchDomainConfigParams | PatchDomainConfigParams | Ja |
Respons
Retourneert: GetDomainConfig200Response
putDomainConfig
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| domainToUpdate | string | Ja | |
| updateDomainConfigParams | UpdateDomainConfigParams | Ja |
Respons
Retourneert: GetDomainConfig200Response
createEmailTemplate
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createEmailTemplateBody | CreateEmailTemplateBody | Ja |
Antwoord
Retourneert: CreateEmailTemplate200Response
Voorbeeld
createEmailTemplate Voorbeeld
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" } // optionele extra gegevens
11};
12
13const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);
14
deleteEmailTemplate
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteEmailTemplate Voorbeeld
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
deleteEmailTemplateRenderError
Parameters
| Name | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| errorId | string | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld
Voorbeeld van 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
getEmailTemplate
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetEmailTemplate200Response
Voorbeeld
getEmailTemplate Voorbeeld
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'; // voorbeeld van een optionele parameter
6 const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);
7 console.log(template, locale);
8})();
9
getEmailTemplateDefinitions
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja |
Response
Retourneert: GetEmailTemplateDefinitions200Response
Voorbeeld
Voorbeeld van getEmailTemplateDefinitions
Copy
1
2const tenantId: string = 'acme-enterprises-78f2';
3const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
4
getEmailTemplateRenderErrors
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| skip | number | Nee |
Respons
Retourneert: GetEmailTemplateRenderErrors200Response
Voorbeeld
getEmailTemplateRenderErrors Voorbeeld
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
getEmailTemplates
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nee |
Respons
Retourneert: GetEmailTemplates200Response
Voorbeeld
getEmailTemplates Voorbeeld
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
renderEmailTemplate
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Ja | |
| locale | string | Nee |
Antwoord
Retourneert: RenderEmailTemplate200Response
Voorbeeld
renderEmailTemplate Voorbeeld
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
updateEmailTemplate
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateEmailTemplate Voorbeeld
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', // optioneel veld ter demonstratie
9 enabled: true,
10 customConfig: { priority: 'high' } // optionele aangepaste parameters
11};
12const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);
13
getEventLog
req tenantId urlId userIdWS
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userIdWS | string | Ja | |
| startTime | number | Ja | |
| endTime | number | Ja |
Antwoord
Retourneert: GetEventLog200Response
getGlobalEventLog
req tenantId urlId userIdWS
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userIdWS | string | Ja | |
| startTime | number | Ja | |
| endTime | number | Ja |
Antwoord
Retourneert: GetEventLog200Response
createFeedPost
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createFeedPostParams | CreateFeedPostParams | Ja | |
| broadcastId | string | Nee | |
| isLive | boolean | Nee | |
| doSpamCheck | boolean | Nee | |
| skipDupCheck | boolean | Nee |
Respons
Retourneert: CreateFeedPost200Response
createFeedPostPublic
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createFeedPostParams | CreateFeedPostParams | Ja | |
| broadcastId | string | Nee | |
| sso | string | Nee |
Respons
Retourneert: CreateFeedPostPublic200Response
deleteFeedPostPublic
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Ja | |
| broadcastId | string | Nee | |
| sso | string | Nee |
Respons
Geeft terug: DeleteFeedPostPublic200Response
getFeedPosts
req tenantId afterId
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nee | |
| limit | number | Nee | |
| tags | Array |
Nee |
Respons
Geeft terug: GetFeedPosts200Response
getFeedPostsPublic
req tenantId afterId
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nee | |
| limit | number | Nee | |
| tags | Array |
Nee | |
| sso | string | Nee | |
| isCrawler | boolean | Nee | |
| includeUserInfo | boolean | Nee |
Antwoord
Retourneert: GetFeedPostsPublic200Response
getFeedPostsStats
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| postIds | Array |
Ja | |
| sso | string | Nee |
Response
Retourneert: GetFeedPostsStats200Response
getUserReactsPublic
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| postIds | Array |
Nee | |
| sso | string | Nee |
Respons
Retourneert: GetUserReactsPublic200Response
reactFeedPostPublic
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Yes | |
| postId | string | Yes | |
| reactBodyParams | ReactBodyParams | Yes | |
| isUndo | boolean | No | |
| broadcastId | string | No | |
| sso | string | No |
Respons
Retourneert: ReactFeedPostPublic200Response
updateFeedPost
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| feedPost | FeedPost | Ja |
Respons
Geeft terug: FlagCommentPublic200Response
updateFeedPostPublic
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Ja | |
| updateFeedPostParams | UpdateFeedPostParams | Ja | |
| broadcastId | string | Nee | |
| sso | string | Nee |
Antwoord
Retourneert: CreateFeedPostPublic200Response
flagCommentPublic
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| isFlagged | boolean | Ja | |
| sso | string | Nee |
Respons
Retourneert: FlagCommentPublic200Response
addHashTag
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | No | |
| createHashTagBody | CreateHashTagBody | No |
Response
Geeft terug: AddHashTag200Response
Voorbeeld
addHashTag Voorbeeld
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
addHashTagsBulk
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Nee | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Nee |
Respons
Retourneert: AddHashTagsBulk200Response
Voorbeeld
addHashTagsBulk Voorbeeld
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
deleteHashTag
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tag | string | Ja | |
| tenantId | string | Nee | |
| deleteHashTagRequest | DeleteHashTagRequest | Nee |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteHashTag Voorbeeld
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
getHashTags
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| page | number | Nee |
Antwoord
Retourneert: GetHashTags200Response
Voorbeeld
getHashTags Voorbeeld
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
patchHashTag
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tag | string | Yes | |
| tenantId | string | No | |
| updateHashTagBody | UpdateHashTagBody | No |
Response
Retourneert: PatchHashTag200Response
Voorbeeld
patchHashTag Voorbeeld
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
createModerator
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createModeratorBody | CreateModeratorBody | Ja |
Respons
Geeft terug: CreateModerator200Response
Voorbeeld
createModerator Voorbeeld
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
deleteModerator
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| sendEmail | string | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteModerator Voorbeeld
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
getModerator
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetModerator200Response
Voorbeeld
getModerator Voorbeeld
Copy
1
2const tenantId: string = "tenant_eu_4f8d2b9e";
3const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // optionele bron (kan undefined zijn)
4const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);
5
getModerators
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nee |
Antwoord
Retourneert: GetModerators200Response
Voorbeeld
getModerators Voorbeeld
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
sendInvite
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| fromName | string | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld
Voorbeeld van 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
updateModerator
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateModeratorBody | UpdateModeratorBody | Yes |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateModerator Voorbeeld
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 // optionele parameter gedemonstreerd
10};
11const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);
12
deleteNotificationCount
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteNotificationCount Voorbeeld
Copy
1
2const tenantId: string = 'tenant_7f3a1b2c4d9e';
3const notificationId: string = 'notif_8c9d0a1b2f3e4b7';
4const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);
5
getCachedNotificationCount
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetCachedNotificationCount200Response
Voorbeeld
getCachedNotificationCount Voorbeeld
Copy
1
2const tenantId: string = 'acme-tenant-01';
3const baseNotificationId: string = 'notif-000123';
4const idSuffix: string | undefined = undefined; // voorbeeld van optionele parameter
5const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;
6const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);
7console.log(result);
8
getNotificationCount
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nee | |
| urlId | string | Nee | |
| fromCommentId | string | Nee | |
| viewed | boolean | Nee | |
| type | string | Nee |
Response
Geeft terug: GetNotificationCount200Response
Voorbeeld
getNotificationCount Voorbeeld
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
getNotifications
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nee | |
| urlId | string | Nee | |
| fromCommentId | string | Nee | |
| viewed | boolean | Nee | |
| type | string | Nee | |
| skip | number | Nee |
Respons
Retourneert: GetNotifications200Response
Voorbeeld
getNotifications Voorbeeld
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
updateNotification
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateNotificationBody | UpdateNotificationBody | Ja | |
| userId | string | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateNotification Voorbeeld
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
addPage
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPIPageData | CreateAPIPageData | Ja |
Antwoord
Retourneert: AddPageAPIResponse
deletePage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwoord
Retourneert: DeletePageAPIResponse
getPageByURLId
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Respons
Retourneert: GetPageByURLIdAPIResponse
getPages
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja |
Response
Retourneert: GetPagesAPIResponse
patchPage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPIPageData | UpdateAPIPageData | Ja |
Antwoord
Retourneert: PatchPageAPIResponse
deletePendingWebhookEvent
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
deletePendingWebhookEvent Voorbeeld
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
getPendingWebhookEventCount
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Nee | |
| externalId | string | Nee | |
| eventType | string | Nee | |
| type | string | Nee | |
| domain | string | Nee | |
| attemptCountGT | number | Nee |
Antwoord
Retourneert: GetPendingWebhookEventCount200Response
Voorbeeld
getPendingWebhookEventCount Voorbeeld
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
getPendingWebhookEvents
Parameters
| Name | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Nee | |
| externalId | string | Nee | |
| eventType | string | Nee | |
| type | string | Nee | |
| domain | string | Nee | |
| attemptCountGT | number | Nee | |
| skip | number | Nee |
Response
Geeft terug: GetPendingWebhookEvents200Response
Voorbeeld
getPendingWebhookEvents Voorbeeld
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
createQuestionConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createQuestionConfigBody | CreateQuestionConfigBody | Ja |
Antwoord
Retourneert: CreateQuestionConfig200Response
Voorbeeld
createQuestionConfig Voorbeeld
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, // optioneel: demonstratie van weggelaten vs opgenomen optionele velden
12 renderingType: QuestionRenderingType.Dropdown,
13 options: customOptions,
14 whenSave: QuestionWhenSave.Always
15};
16const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);
17
deleteQuestionConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteQuestionConfig Voorbeeld
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
getQuestionConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetQuestionConfig200Response
Voorbeeld
getQuestionConfig Voorbeeld
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 is optioneel; implementatie weggelaten voor beknoptheid
7 return undefined;
8}
9const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
10const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);
11
getQuestionConfigs
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nee |
Respons
Retourneert: GetQuestionConfigs200Response
Voorbeeld
getQuestionConfigs Voorbeeld
Copy
1
2const tenantId: string = 'tenant-42a7b9';
3const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
4const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);
5
updateQuestionConfig
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateQuestionConfig Voorbeeld
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
createQuestionResult
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createQuestionResultBody | CreateQuestionResultBody | Ja |
Response
Retourneert: CreateQuestionResult200Response
Voorbeeld
createQuestionResult Voorbeeld
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] // optionele metadata ter demonstratie
10} as CreateQuestionResultBody;
11const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);
12
deleteQuestionResult
Parameters
| Name | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Response
Geeft terug: FlagCommentPublic200Response
Example
deleteQuestionResult Voorbeeld
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
getQuestionResult
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Response
Geeft terug: GetQuestionResult200Response
Voorbeeld
getQuestionResult Voorbeeld
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
getQuestionResults
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Nee | |
| userId | string | Nee | |
| startDate | string | Nee | |
| questionId | string | Nee | |
| questionIds | string | Nee | |
| skip | number | Nee |
Response
Retourneert: GetQuestionResults200Response
Voorbeeld
getQuestionResults Voorbeeld
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
updateQuestionResult
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateQuestionResultBody | UpdateQuestionResultBody | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateQuestionResult Voorbeeld
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 // optionele parameter opgenomen
8};
9const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);
10
aggregateQuestionResults
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| questionId | string | Nee | |
| questionIds | Array |
Nee | |
| urlId | string | Nee | |
| timeBucket | AggregateTimeBucket | Nee | |
| startDate | Date | Nee | |
| forceRecalculate | boolean | Nee |
Respons
Geeft terug: AggregateQuestionResults200Response
bulkAggregateQuestionResults
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Ja | |
| forceRecalculate | boolean | Nee |
Response
Geeft terug: BulkAggregateQuestionResults200Response
combineCommentsWithQuestionResults
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| questionId | string | Nee | |
| questionIds | Array |
Nee | |
| urlId | string | Nee | |
| startDate | Date | Nee | |
| forceRecalculate | boolean | Nee | |
| minValue | number | Nee | |
| maxValue | number | Nee | |
| limit | number | Nee |
Antwoord
Retourneert: CombineCommentsWithQuestionResults200Response
addSSOUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPISSOUserData | CreateAPISSOUserData | Ja |
Antwoord
Retourneert: AddSSOUserAPIResponse
deleteSSOUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| deleteComments | boolean | Nee | |
| commentDeleteMode | string | Nee |
Respons
Geeft terug: DeleteSSOUserAPIResponse
getSSOUserByEmail
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| string | Ja |
Response
Retourneert: GetSSOUserByEmailAPIResponse
getSSOUserById
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetSSOUserByIdAPIResponse
getSSOUsers
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nee |
Respons
Retourneert: GetSSOUsers200Response
patchSSOUser
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPISSOUserData | UpdateAPISSOUserData | Ja | |
| updateComments | boolean | Nee |
Response
Retourneert: PatchSSOUserAPIResponse
putSSOUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPISSOUserData | UpdateAPISSOUserData | Ja | |
| updateComments | boolean | Nee |
Antwoord
Retourneert: PutSSOUserAPIResponse
createSubscription
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Ja |
Respons
Retourneert: CreateSubscriptionAPIResponse
deleteSubscription
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| userId | string | Nee |
Antwoord
Retourneert: DeleteSubscriptionAPIResponse
getSubscriptions
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nee |
Antwoord
Geeft terug: GetSubscriptionsAPIResponse
getTenantDailyUsages
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| yearNumber | number | Nee | |
| monthNumber | number | Nee | |
| dayNumber | number | Nee | |
| skip | number | Nee |
Antwoord
Retourneert: GetTenantDailyUsages200Response
Voorbeeld
getTenantDailyUsages Voorbeeld
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
createTenantPackage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantPackageBody | CreateTenantPackageBody | Ja |
Respons
Retourneert: CreateTenantPackage200Response
Voorbeeld
createTenantPackage Voorbeeld
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" // optionele parameter gedemonstreerd
10};
11const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
12
deleteTenantPackage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld
deleteTenantPackage Voorbeeld
Copy
1
2const tenantId: string = 'fc-tenant-8a9c2b';
3const packageId: string = 'pkg-47f3c9';
4const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);
5
getTenantPackage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetTenantPackage200Response
Voorbeeld
getTenantPackage Voorbeeld
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
getTenantPackages
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nee |
Response
Retourneert: GetTenantPackages200Response
Voorbeeld
getTenantPackages Voorbeeld
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
replaceTenantPackage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
replaceTenantPackage Voorbeeld
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 // optionele velden zoals "notes" of "trialExpiry" zijn hier opzettelijk weggelaten
9} as ReplaceTenantPackageBody;
10const result: FlagCommentPublic200Response = await replaceTenantPackage(
11 tenantId,
12 packageId,
13 replaceTenantPackageBody
14);
15
updateTenantPackage
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateTenantPackageBody | UpdateTenantPackageBody | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateTenantPackage Voorbeeld
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
createTenantUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantUserBody | CreateTenantUserBody | Ja |
Respons
Retourneert: CreateTenantUser200Response
Voorbeeld
createTenantUser Voorbeeld
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, // optionele parameter ter demonstratie
9 locale: "en-US",
10 metadata: { department: "Customer Success" }
11};
12const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
13
deleteTenantUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| deleteComments | string | Nee | |
| commentDeleteMode | string | Nee |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteTenantUser Voorbeeld
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
getTenantUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: GetTenantUser200Response
Voorbeeld
getTenantUser Voorbeeld
Copy
1
2const tenantId: string = "tenant_9f7d4b2a-1c3e";
3const id: string = "user_6a12b3c4d5";
4const includeProfile: boolean | undefined = true; // voorbeeld van optionele parameter
5const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
6console.log("Tenant user fetched", response);
7
getTenantUsers
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nee |
Respons
Retourneert: GetTenantUsers200Response
Voorbeeld
getTenantUsers Voorbeeld
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
replaceTenantUser
Parameters
| Name | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| replaceTenantUserBody | ReplaceTenantUserBody | Ja | |
| updateComments | string | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
replaceTenantUser Voorbeeld
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
sendLoginLink
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| redirectURL | string | Nee |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld
sendLoginLink Voorbeeld
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
updateTenantUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateTenantUserBody | UpdateTenantUserBody | Ja | |
| updateComments | string | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateTenantUser Voorbeeld
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
createTenant
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| createTenantBody | CreateTenantBody | Yes |
Respons
Geeft terug: CreateTenant200Response
Voorbeeld
createTenant Voorbeeld
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" }]; // optioneel
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
deleteTenant
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| sure | string | Nee |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld
deleteTenant Voorbeeld
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
getTenant
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Response
Retourneert: GetTenant200Response
Voorbeeld
getTenant Voorbeeld
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
getTenants
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| meta | string | Nee | |
| skip | number | Nee |
Respons
Geeft terug: GetTenants200Response
Voorbeeld
getTenants Voorbeeld
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
updateTenant
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateTenantBody | UpdateTenantBody | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld
updateTenant Voorbeeld
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, // optionele parameter ter demonstratie
17 enableModeration: true
18};
19const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);
20
uploadImage
Een afbeelding uploaden en formaat wijzigen
Parameters
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| file | Blob | Ja | |
| sizePreset | SizePreset | Nee | |
| urlId | string | Nee |
Respons
Geeft terug: UploadImageResponse
getUserBadgeProgressById
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Geeft terug: GetUserBadgeProgressById200Response
getUserBadgeProgressByUserId
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Ja |
Respons
Retourneert: GetUserBadgeProgressById200Response
getUserBadgeProgressList
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nee | |
| limit | number | Nee | |
| skip | number | Nee |
Antwoord
Retourneert: GetUserBadgeProgressList200Response
createUserBadge
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| createUserBadgeParams | CreateUserBadgeParams | Ja |
Antwoord
Retourneert: CreateUserBadge200Response
deleteUserBadge
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Retourneert: UpdateUserBadge200Response
getUserBadge
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Geeft terug: GetUserBadge200Response
getUserBadges
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nee | |
| badgeId | string | Nee | |
| type | number | Nee | |
| displayedOnComments | boolean | Nee | |
| limit | number | Nee | |
| skip | number | Nee |
Antwoord
Retourneert: GetUserBadges200Response
updateUserBadge
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateUserBadgeParams | UpdateUserBadgeParams | Ja |
Respons
Geeft terug: UpdateUserBadge200Response
getUserNotificationCount
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| sso | string | Nee |
Respons
Retourneert: GetUserNotificationCount200Response
getUserNotifications
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| pageSize | number | Nee | |
| afterId | string | Nee | |
| includeContext | boolean | Nee | |
| afterCreatedAt | number | Nee | |
| unreadOnly | boolean | Nee | |
| dmOnly | boolean | Nee | |
| noDm | boolean | Nee | |
| includeTranslations | boolean | Nee | |
| sso | string | Nee |
Response
Retourneert: GetUserNotifications200Response
resetUserNotificationCount
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| sso | string | Nee |
Respons
Retourneert: ResetUserNotifications200Response
resetUserNotifications
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nee | |
| afterCreatedAt | number | Nee | |
| unreadOnly | boolean | Nee | |
| dmOnly | boolean | Nee | |
| noDm | boolean | Nee | |
| sso | string | Nee |
Respons
Retourneert: ResetUserNotifications200Response
updateUserNotificationCommentSubscriptionStatus
Meldingen voor een specifieke opmerking in- of uitschakelen.
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| notificationId | string | Ja | |
| optedInOrOut | UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum | Ja | |
| commentId | string | Ja | |
| sso | string | Nee |
Antwoord
Retourneert: UpdateUserNotificationStatus200Response
updateUserNotificationPageSubscriptionStatus
Schakel meldingen in of uit voor een pagina. Wanneer gebruikers op een pagina zijn geabonneerd, worden meldingen aangemaakt voor nieuwe root-reacties, en ook
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| url | string | Ja | |
| pageTitle | string | Ja | |
| subscribedOrUnsubscribed | UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum | Ja | |
| sso | string | Nee |
Antwoord
Retourneert: UpdateUserNotificationStatus200Response
updateUserNotificationStatus
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| notificationId | string | Ja | |
| newStatus | UpdateUserNotificationStatusNewStatusEnum | Ja | |
| sso | string | Nee |
Respons
Retourneert: UpdateUserNotificationStatus200Response
getUserPresenceStatuses
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlIdWS | string | Ja | |
| userIds | string | Ja |
Antwoord
Retourneert: GetUserPresenceStatuses200Response
searchUsers
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| usernameStartsWith | string | Ja | |
| mentionGroupIds | Array |
Nee | |
| sso | string | Nee |
Response
Retourneert: SearchUsers200Response
getUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Respons
Geeft terug: GetUser200Response
Voorbeeld
getUser Voorbeeld
Copy
1
2const tenantId: string = "acme-publishing-42";
3const userIdOptional: string | undefined = "user_9d7b4c"; // kan in sommige flows undefined zijn (optioneel)
4const id: string = userIdOptional ?? "user_default_0001";
5const result: GetUser200Response = await getUser(tenantId, id);
6console.log(result);
7
createVote
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| direction | CreateVoteDirectionEnum | Ja | |
| userId | string | Nee | |
| anonUserId | string | Nee |
Respons
Retourneert: VoteComment200Response
Voorbeeld
createVote Voorbeeld
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
deleteVote
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| editKey | string | Nee |
Respons
Geeft terug: DeleteCommentVote200Response
Voorbeeld
deleteVote Voorbeeld
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
getVotes
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Respons
Retourneert: GetVotes200Response
Voorbeeld
getVotes Voorbeeld
Copy
1
2const tenantId: string = 'tenant_9f8b3c_prod';
3const urlId: string = '/news/2026/typescript-ecosystem-update';
4const votes: GetVotes200Response = await getVotes(tenantId, urlId);
5// Als er een optionele parameter bestond, bijvoorbeeld includeHidden, zou die als volgt gebruikt kunnen worden:
6// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });
7
getVotesForUser
Parameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userId | string | Nee | |
| anonUserId | string | Nee |
Respons
Retourneert: GetVotesForUser200Response
Voorbeeld
getVotesForUser Voorbeeld
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
Hulp nodig?
Als u problemen ondervindt of vragen heeft over de JavaScript/TypeScript SDK, kunt u:
Bijdragen
Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.