FastComments JavaScript/TypeScript SDK

Dette er den officielle JavaScript/TypeScript SDK til FastComments.

Officiel JavaScript/TypeScript SDK til FastComments API

Repository

Installation

npm install fastcomments-sdk

API Documentation

Fuld API-reference: docs/api/README.md

Browser vs Server Compatibility

Dette SDK bruger to indgangspunkter for at sikre optimal kompatibilitet og forhindre kørselstidsfejl:

fastcomments-sdk/browser - Browser-sikker version med indbygget fetch
fastcomments-sdk/server - Fuld Node.js-version med SSO-understøttelse
fastcomments-sdk (standard) - Kun typer, sikker at importere hvor som helst

Usage

Denne SDK giver separate indgangspunkt for browser- og servermiljøer for at sikre optimal kompatibilitet og sikkerhed:

Browserbrug (klientside)

For browser-/frontend-applikationer, brug den browser-sikre eksport, som udelader Node.js-afhængigheder:

// Browser-sikker import (ingen Node.js-afhængigheder)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Opret browser SDK-instans
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // valgfri, standard er https://fastcomments.com
});

// Brug offentlige API'er (ingen API-nøgle nødvendig - sikkert for browsere)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Serverbrug (Node.js)

For server-/backend-applikationer, brug det fulde SDK med SSO og autentificeringsfunktioner:

// Server-side import (inkluderer SSO og designet til at fungere med NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Opret server SDK-instans
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Hold denne hemmelig på serveren!
  basePath: 'https://fastcomments.com' // valgfri, standard er https://fastcomments.com
});

// Brug sikrede API'er med din API-nøgle
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Kun typer-import

Hvis du kun har brug for TypeScript-typer (ingen runtime-kode), brug standardimporten:

// Kun typer (ingen runtime-afhængigheder - sikkert overalt)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Brug af individuelle API-klasser

Browsermiljø

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

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

const publicApi = new PublicApi(config);

Servermiljø

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

Public vs Secured APIs

SDK'et leverer tre hoved-API-klasser:

DefaultApi - Sikrede endpoints, der kræver din API-nøgle til autentificering. Brug disse til operationer på serversiden.
PublicApi - Offentlige endpoints, som kan tilgås uden en API-nøgle. Disse kan kaldes direkte fra browsere/mobilenheder/osv.
HiddenApi - Interne/admin-endpoints til avancerede brugssituationer.

Eksempel: Brug af Public API (browser-sikkert)

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

const publicApi = new PublicApi();

// Hent kommentarer for en side (ingen API-nøgle nødvendig)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Eksempel: Brug af Default API (kun på serversiden)

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

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

// Hent kommentarer med fuld admin-adgang
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On) Integration

FastComments understøtter SSO til at integrere med dit eksisterende brugerautentifikationssystem. SSO-funktionalitet er kun tilgængelig i server-udgaven da det kræver Node.js crypto-funktioner.

Simpelt SSO (Kun server-side)

Simpelt SSO bør genereres på serversiden og sendes til klienten:

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

// Create simple SSO using the built-in 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();

// Send ssoToken to your client-side code
// Client-side code can then use this token with the browser SDK

Sikkert SSO (Server-side, anbefalet)

Sikkert SSO bør implementeres på serversiden og giver bedre sikkerhed:

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

// Create secure SSO using the built-in 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();

// Use with API calls on the server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Or send ssoConfig to client for browser usage

Brug af SSO fra browseren (med servergenereret token)

// Client-side code (browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Get SSO token from your 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 // Use the server-generated SSO token
});

SSO med kommentaroprettelse

// Server-side: Create SSO and comment
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)
});

Common Use Cases

Hent kommentarer for en side

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

Oprettelse af en kommentar

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

Stem på en kommentar

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 for opstemning, -1 for nedstemning
  }
});

Brugeradministration (Kræver API-nøgle)

// Søg efter brugere (kræver DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live Events (Real-time Updates)

Abonner på live-begivenheder for at få opdateringer i realtid om kommentarer, stemmer og andre aktiviteter.

Begivenheder på sideniveau

Lyt efter live-begivenheder på en specifik side (kommentarer, stemmer osv.):

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

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

// Abonner på live-begivenheder for en side
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (hent dette fra getComments-responsen)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Opdater din UI med den nye kommentar
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Opdater stemmetællinger i din UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Returner true hvis begivenheden blev håndteret
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Luk abonnementet når det er færdigt
subscription.close();

Abonner på brugerbegivenheder

Lyt efter brugerspecifikke begivenheder (notifikationer, nævnelser osv.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Hent dette fra getComments-responsen
};

// Abonner på brugerens personlige 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);
        // Vis notifikation i din 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');
  }
);

// Luk når du er færdig
userSubscription.close();

Sådan får du userIdWS

Parameteren userIdWS er påkrævet for live-begivenheder og kan hentes fra API-responser:

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

// Udtræk userIdWS fra responsen
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Nu kan du abonnere på live-begivenheder
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast IDs

Du vil se, at du skal sende et broadcastId i nogle API-kald. Når du modtager hændelser, får du dette ID tilbage, så du ved, at du kan ignorere eventet, hvis du planlægger at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være tilstrækkeligt unikt til ikke at forekomme to gange i en browsersession.

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() // Unikt ID for denne operation
  }
});

Error Handling

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

Aggregerer dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
aggregationRequest	AggregationRequest	Ja
parentTenantId	string	Nej
includeStats	boolean	Nej

Svar

Returnerer: AggregationResponse

getAuditLogs

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
limit	number	Nej
skip	number	Nej
order	SORTDIR	Nej
after	number	Nej
before	number	Nej

Svar

Returnerer: GetAuditLogs200Response

blockFromCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nej

Svar

Returnerer: BlockFromCommentPublic200Response

unBlockCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nej

Svar

Returnerer: UnBlockCommentPublic200Response

checkedCommentsForBlocked

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
commentIds	string	Ja
sso	string	Nej

Respons

Returnerer: CheckedCommentsForBlocked200Response

blockUserFromComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
blockFromCommentParams	BlockFromCommentParams	Ja
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: BlockFromCommentPublic200Response

createCommentPublic

Parameters

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
commentData	CommentData	Ja
sessionId	string	Nej
sso	string	Nej

Respons

Returnerer: CreateCommentPublic200Response

deleteComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
contextUserId	string	Nej
isLive	boolean	Nej

Svar

Returnerer: DeleteComment200Response

deleteCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
editKey	string	Nej
sso	string	Nej

Svar

Returnerer: DeleteCommentPublic200Response

deleteCommentVote

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
voteId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
editKey	string	Nej
sso	string	Nej

Respons

Returnerer: DeleteCommentVote200Response

flagComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: FlagComment200Response

getComment

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: GetComment200Response

getComments

Parametre

Navn	Type	Kræves
tenantId	string	Ja
page	number	Nej
limit	number	Nej
skip	number	Nej
asTree	boolean	Nej
skipChildren	number	Nej
limitChildren	number	Nej
maxTreeDepth	number	Nej
urlId	string	Nej
userId	string	Nej
anonUserId	string	Nej
contextUserId	string	Nej
hashTag	string	Nej
parentId	string	Nej
direction	SortDirections	Nej

Respons

Returnerer: GetComments200Response

getCommentsPublic

req tenantId urlId

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
page	number	Nej
direction	SortDirections	Nej
sso	string	Nej
skip	number	Nej
skipChildren	number	Nej
limit	number	Nej
limitChildren	number	Nej
countChildren	boolean	Nej
fetchPageForCommentId	string	Nej
includeConfig	boolean	Nej
countAll	boolean	Nej
includei10n	boolean	Nej
locale	string	Nej
modules	string	Nej
isCrawler	boolean	Nej
includeNotificationCount	boolean	Nej
asTree	boolean	Nej
maxTreeDepth	number	Nej
useFullTranslationIds	boolean	Nej
parentId	string	Nej
searchText	string	Nej
hashTags	Array	Nej
userId	string	Nej
customConfigStr	string	Nej
afterCommentId	string	Nej
beforeCommentId	string	Nej

Respons

Returnerer: GetCommentsPublic200Response

getCommentText

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nej
sso	string	Nej

Svar

Returnerer: GetCommentText200Response

getCommentVoteUserNames

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
dir	number	Ja
sso	string	Nej

Svar

Returnerer: GetCommentVoteUserNames200Response

lockComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nej

Svar

Returnerer: LockComment200Response

pinComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nej

Svar

Returnerer: PinComment200Response

saveComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createCommentParams	CreateCommentParams	Ja
isLive	boolean	Nej
doSpamCheck	boolean	Nej
sendEmails	boolean	Nej
populateNotifications	boolean	Nej

Svar

Returnerer: SaveComment200Response

saveCommentsBulk

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createCommentParams	Array	Ja
isLive	boolean	Nej
doSpamCheck	boolean	Nej
sendEmails	boolean	Nej
populateNotifications	boolean	Nej

Respons

Returnerer: Array<SaveComment200Response

setCommentText

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
commentTextUpdateRequest	CommentTextUpdateRequest	Ja
editKey	string	Nej
sso	string	Nej

Svar

Returnerer: SetCommentText200Response

unBlockUserFromComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
unBlockFromCommentParams	UnBlockFromCommentParams	Ja
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: UnBlockCommentPublic200Response

unFlagComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: FlagComment200Response

unLockComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nej

Svar

Returnerer: LockComment200Response

unPinComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nej

Respons

Returnerer: PinComment200Response

updateComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
body	PickAPICommentUpdatableCommentFields	Ja
contextUserId	string	Nej
doSpamCheck	boolean	Nej
isLive	boolean	Nej

Respons

Returnerer: FlagCommentPublic200Response

voteComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
voteBodyParams	VoteBodyParams	Ja
sessionId	string	Nej
sso	string	Nej

Svar

Returnerer: VoteComment200Response

addDomainConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Ja

Respons

Returnerer: AddDomainConfig200Response

deleteDomainConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
domain	string	Ja

Svar

Returnerer: DeleteDomainConfig200Response

getDomainConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
domain	string	Ja

Svar

Returnerer: GetDomainConfig200Response

getDomainConfigs

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: GetDomainConfigs200Response

patchDomainConfig

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
domainToUpdate	string	Ja
patchDomainConfigParams	PatchDomainConfigParams	Ja

Svar

Returnerer: GetDomainConfig200Response

putDomainConfig

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
domainToUpdate	string	Ja
updateDomainConfigParams	UpdateDomainConfigParams	Ja

Response

Returnerer: GetDomainConfig200Response

createEmailTemplate

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Ja

Svar

Returnerer: CreateEmailTemplate200Response

Eksempel

createEmailTemplate Eksempel

Copy

const tenantId: string = "tenant_7a9f2b3d";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Comment Notification",
  subject: "New comment on your article: ",
  htmlBody: "<p> left a comment:</p><blockquote></blockquote>",
  enabled: true,
  defaultLocale: "en-US",
  metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // valgfri ekstra data
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteEmailTemplate

Copy

const tenantId: string = "tenant_4b2f6a-4b2f6a2d";
const templateId: string = "email_template_9f8b7c3e";
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);
const status: APIStatus | undefined = result?.status

deleteEmailTemplateRenderError

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
errorId	string	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

deleteEmailTemplateRenderError Eksempel

Copy

const tenantId: string = "tenant_8f3b2a9c";
const id: string = "template_4a1c9f7e";
const errorId: string = "err_20260112_abc123";
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

getEmailTemplate

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetEmailTemplate200Response

Eksempel

getEmailTemplate Eksempel

Copy

(async () => {
  const tenantId: string = 'acme-enterprises-123';
  const id: string = 'welcome-email-template-v2';
  const locale: string | undefined = 'en-US'; // eksempel på valgfri parameter
  const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);
  console.log(template, locale);
})();

getEmailTemplateDefinitions

Parametre

Name	Type	Required	Description
tenantId	string	Ja

Respons

Returnerer: GetEmailTemplateDefinitions200Response

Eksempel

getEmailTemplateDefinitions Eksempel

Copy

const tenantId: string = 'acme-enterprises-78f2';
const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

getEmailTemplateRenderErrors

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Ja
skip	number	Nej

Svar

Returnerer: GetEmailTemplateRenderErrors200Response

Eksempel

Eksempel på getEmailTemplateRenderErrors

Copy

const tenantId: string = "tenant_7b3f2a9c";
const id: string = "tmpl_4f1b2c9e";
const skip: number = 25;
const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

getEmailTemplates

Parametre

Name	Type	Required	Description
tenantId	string	Ja
skip	number	Nej

Svar

Returnerer: GetEmailTemplates200Response

Eksempel

getEmailTemplates Eksempel

Copy

const tenantId: string = 'tenant_8f4d2b7c';
const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
const skip: number = 20;
const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

renderEmailTemplate

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Ja
locale	string	Nej

Svar

Returnerer: RenderEmailTemplate200Response

Eksempel

renderEmailTemplate Eksempel

Copy

const tenantId: string = 'acme-corp-7f3';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'new-comment-notification',
  recipientEmail: 'jane.doe@acme.com',
  variables: {
    commenterName: 'Samir Patel',
    commentText: 'I found this article really helpful — thanks for sharing!',
    threadUrl: 'https://acme.com/blog/123#comments'
  },
  includeUnsubscribeLink: true
};
const locale: string = 'en-US';
const response: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parametre

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateEmailTemplateBody	UpdateEmailTemplateBody	Yes

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateEmailTemplate Eksempel

Copy

const tenantId: string = 'acme-corp-tenant-01';
const id: string = 'email_tpl_42b7a9';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: 'Comment Flag Notification',
  subject: 'A comment was flagged on acme.com',
  html: '<p>A comment by  was flagged. Review at </p>',
  replyTo: 'noreply@acme.com', // valgfrit felt demonstreret
  enabled: true,
  customConfig: { priority: 'high' } // valgfri brugerdefinerede parametre
};
const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Respons

Returnerer: GetEventLog200Response

getGlobalEventLog

req tenantId urlId userIdWS

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Svar

Returnerer: GetEventLog200Response

createFeedPost

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nej
isLive	boolean	Nej
doSpamCheck	boolean	Nej
skipDupCheck	boolean	Nej

Svar

Returnerer: CreateFeedPost200Response

createFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: CreateFeedPostPublic200Response

deleteFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Ja
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: DeleteFeedPostPublic200Response

getFeedPosts

req tenantId afterId

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
afterId	string	Nej
limit	number	Nej
tags	Array	Nej

Svar

Returnerer: GetFeedPosts200Response

getFeedPostsPublic

req tenantId afterId

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
afterId	string	Nej
limit	number	Nej
tags	Array	Nej
sso	string	Nej
isCrawler	boolean	Nej
includeUserInfo	boolean	Nej

Svar

Returnerer: GetFeedPostsPublic200Response

getFeedPostsStats

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postIds	Array	Ja
sso	string	Nej

Svar

Returnerer: GetFeedPostsStats200Response

getUserReactsPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postIds	Array	Nej
sso	string	Nej

Svar

Returnerer: GetUserReactsPublic200Response

reactFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Ja
reactBodyParams	ReactBodyParams	Ja
isUndo	boolean	Nej
broadcastId	string	Nej
sso	string	Nej

Respons

Returnerer: ReactFeedPostPublic200Response

updateFeedPost

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
feedPost	FeedPost	Ja

Svar

Returnerer: FlagCommentPublic200Response

updateFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Ja
updateFeedPostParams	UpdateFeedPostParams	Ja
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: CreateFeedPostPublic200Response

flagCommentPublic

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
isFlagged	boolean	Ja
sso	string	Nej

Svar

Returnerer: FlagCommentPublic200Response

addHashTag

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Nej
createHashTagBody	CreateHashTagBody	Nej

Svar

Returnerer: AddHashTag200Response

Eksempel

addHashTag Eksempel

Copy

const tenantId: string = 'tenant_7b2f6c2b';
const createBody: CreateHashTagBody = {
  tag: 'feature-request',
  label: 'Feature Request',
  description: 'Requests for new functionality in the web client',
  isActive: true,
  visibility: 'public',
  allowedDomains: ['example.com', 'internal.example.com']
};
const result: AddHashTag200Response = await addHashTag(tenantId, createBody);
const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {
  tag: 'bug',
  label: 'Bug',
  description: 'Use for reproducible bugs reported by users',
  isActive: true,
  visibility: 'public'
});

addHashTagsBulk

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Nej
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nej

Svar

Returnerer: AddHashTagsBulk200Response

Eksempel

addHashTagsBulk Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_3f2b9a';
  const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
    tags: [
      { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },
      { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }
    ]
  };
  const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
  const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);
  console.log(result, resultWithNoTenant);
})();

deleteHashTag

Parametre

Name	Type	Påkrævet
tag	string	Ja
tenantId	string	Nej
deleteHashTagRequest	DeleteHashTagRequest	Nej

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteHashTag

Copy

const tag: string = 'breaking-news';
const tenantId: string = 'tenant_42';
const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);

getHashTags

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
page	number	Nej

Svar

Returnerer: GetHashTags200Response

Eksempel

getHashTags Eksempel

Copy

(async () => {
  const tenantId: string = "acme-corp-7a9f";
  const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);
  const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);
  console.log(tagsPage1, tagsPage2);
})();

patchHashTag

Parametre

Name	Type	Påkrævet
tag	string	Ja
tenantId	string	Nej
updateHashTagBody	UpdateHashTagBody	Nej

Svar

Returnerer: PatchHashTag200Response

Eksempel

patchHashTag Eksempel

Copy

const tag: string = 'release-2026';
const tenantId: string = 'tenant_42';
const updateHashTagBody: UpdateHashTagBody = {
  displayName: 'Release 2026',
  description: 'Discussions and notes for the 2026 product release',
  isActive: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Ja

Svar

Returnerer: CreateModerator200Response

Eksempel

createModerator Eksempel

Copy

const tenantId: string = "tenant_prod_us-east_01";
const createModeratorBody: CreateModeratorBody = {
  email: "maria.lopez+mod@fastcompany.com",
  username: "mlopez_mod",
  displayName: "Maria Lopez",
  roles: ["content_moderator"],
  notifyOnReports: true,
  metadata: { region: "us-east", team: "community" }
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
sendEmail	string	Nej

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

deleteModerator Eksempel

Copy

const tenantId: string = 'acme-tenant-987';
const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

getModerator

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetModerator200Response

Eksempel

getModerator Eksempel

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // valgfri kilde (kan være undefined)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

getModerators

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	number	Nej

Svar

Returnerer: GetModerators200Response

Eksempel

getModerators Eksempel

Copy

const tenantId: string = "tenant_corp_7f9b2a";
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const skip: number = 50;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

sendInvite

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
fromName	string	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

sendInvite Eksempel

Copy

const tenantId: string = 'acme-tenant-004';
const id: string = 'comment_9b7f3a2c';
const fromName: string = 'María Hernández';
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

updateModerator

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateModeratorBody	UpdateModeratorBody	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateModerator Eksempel

Copy

const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';
const id: string = 'mod_92a7c4';
const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };
const updateModeratorBodyWithOptional: UpdateModeratorBody = {
  displayName: 'Sophia Patel',
  email: 'sophia.patel@newsroom.example',
  permissions: ['remove_comments', 'ban_user'],
  notifyOnFlag: true // valgfri parameter demonstreret
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);

deleteNotificationCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteNotificationCount

Copy

const tenantId: string = 'tenant_7f3a1b2c4d9e';
const notificationId: string = 'notif_8c9d0a1b2f3e4b7';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);

getCachedNotificationCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetCachedNotificationCount200Response

Eksempel

getCachedNotificationCount Eksempel

Copy

const tenantId: string = 'acme-tenant-01';
const baseNotificationId: string = 'notif-000123';
const idSuffix: string | undefined = undefined; // optional parameter example
const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);
console.log(result);

getNotificationCount

Parametre

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

Svar

Returnerer: GetNotificationCount200Response

Eksempel

Eksempel på getNotificationCount

Copy

const tenantId: string = 'tenant_8a9b7c';
const userId: string = 'user_42b3c';
const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';
const fromCommentId: string | undefined = undefined;
const viewed: boolean = false;
const type: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

getNotifications

Parametre

Name	Type	Required
tenantId	string	Ja
userId	string	Nej
urlId	string	Nej
fromCommentId	string	Nej
viewed	boolean	Nej
type	string	Nej
skip	number	Nej

Svar

Returnerer: GetNotifications200Response

Eksempel

getNotifications Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_8f3b1a2c';
  const userId: string = 'user_42';
  const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';
  const fromCommentId: string = 'cmt_9a7b';
  const viewed: boolean = false;
  const type: string = 'mention';
  const skip: number = 0;
  const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);
  console.log(response);
})();

updateNotification

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateNotificationBody	UpdateNotificationBody	Ja
userId	string	Nej

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateNotification

Copy

const tenantId: string = "tenant_86a7b3";
const id: string = "notif_20260112_01";
const userId: string = "moderator_42";
const updateNotificationBody: UpdateNotificationBody = {
  name: "Flagged comment alert",
  enabled: true,
  channels: ["email"],
  recipients: ["mod-team@news-site.com"],
  threshold: 1
};
(async () => {
  const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);
  console.log(result);
})();

addPage

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Ja

Svar

Returnerer: AddPageAPIResponse

deletePage

Parametre

Name	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: DeletePageAPIResponse

getPageByURLId

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
urlId	string	Ja

Svar

Returnerer: GetPageByURLIdAPIResponse

getPages

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Respons

Returnerer: GetPagesAPIResponse

patchPage

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateAPIPageData	UpdateAPIPageData	Ja

Svar

Returnerer: PatchPageAPIResponse

deletePendingWebhookEvent

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deletePendingWebhookEvent

Copy

const tenantId: string = 'tenant_7f4e2b';
const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);
console.log(result);

getPendingWebhookEventCount

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Nej
externalId	string	Nej
eventType	string	Nej
type	string	Nej
domain	string	Nej
attemptCountGT	number	Nej

Svar

Returnerer: GetPendingWebhookEventCount200Response

Eksempel

getPendingWebhookEventCount Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_9c3b2b';
  const commentId: string = 'cmt_f4a1b2';
  const externalId: string = 'ext-789';
  const eventType: string = 'comment.created';
  const type: string = 'delivery';
  const domain: string = 'app.example.com';
  const attemptCountGT: number = 2;
  const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
    tenantId,
    commentId,
    externalId,
    eventType,
    type,
    domain,
    attemptCountGT
  );
  console.log(result);
})();

getPendingWebhookEvents

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
commentId	string	Nej
externalId	string	Nej
eventType	string	Nej
type	string	Nej
domain	string	Nej
attemptCountGT	number	Nej
skip	number	Nej

Respons

Returnerer: GetPendingWebhookEvents200Response

Eksempel

getPendingWebhookEvents Eksempel

Copy

const tenantId: string = "tenant_78b2f1";
const commentId: string = "cmt_0042";
const eventType: string = "comment.created";
const domain: string = "blog.example.com";
const attemptCountGT: number = 1;
const skip: number = 0;
const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined, // externalId
  eventType,
  undefined, // type
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Ja

Svar

Returnerer: CreateQuestionConfig200Response

Eksempel

createQuestionConfig Eksempel

Copy

const tenantId: string = "tenant_live_7f8b3c2a";
const customOptions: QuestionConfigCustomOptionsInner[] = [
  { value: "under18", label: "Under 18" },
  { value: "18-24", label: "18-24" },
  { value: "25-34", label: "25-34", defaultSelected: true }
];
const createQuestionConfigBody: CreateQuestionConfigBody = {
  key: "age_range",
  label: "What is your age range?",
  required: false, // valgfri: demonstrerer udeladte vs inkluderede valgfrie felter
  renderingType: QuestionRenderingType.Dropdown,
  options: customOptions,
  whenSave: QuestionWhenSave.Always
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parametre

Navn	Type	Krævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteQuestionConfig

Copy

async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {
  if (!id) return null;
  const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);
  return result;
}
const tenantId: string = 'tenant_acme_001';
const optionalConfigId: string | undefined = 'qcfg_20260112_01';
(async (): Promise<void> => {
  const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);
  void deleted;
})();

getQuestionConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetQuestionConfig200Response

Eksempel

getQuestionConfig Eksempel

Copy

const tenantId: string = 'acme-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata er valgfri; implementeringen er udeladt af hensyn til korthed
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

getQuestionConfigs

Parametre

Name	Type	Required	Description
tenantId	string	Ja
skip	number	Nej

Svar

Returnerer: GetQuestionConfigs200Response

Eksempel

getQuestionConfigs Eksempel

Copy

const tenantId: string = 'tenant-42a7b9';
const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);

updateQuestionConfig

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateQuestionConfigBody	UpdateQuestionConfigBody	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateQuestionConfig Eksempel

Copy

const tenantId: string = 'tenant-82b3a';
const id: string = 'qst-20260112';
const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Ja

Svar

Returnerer: CreateQuestionResult200Response

Eksempel

createQuestionResult Eksempel

Copy

const tenantId: string = "fc_tenant_7a3c_us-east-1";
const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "q_42",
  commenterId: "user_1984",
  answer: "yes",
  score: 4,
  meta: [metaItem] // valgfri metadata demonstreret
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteQuestionResult

Copy

const tenantId: string = 'acme-tenant-01';
const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';
const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);
console.log(deletedResult);

getQuestionResult

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: GetQuestionResult200Response

Eksempel

getQuestionResult Eksempel

Copy

const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
const questionId: string = "question_72f1b9c3a4";
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
console.log(result);

getQuestionResults

Parametre

Name	Type	Required
tenantId	string	Ja
urlId	string	Nej
userId	string	Nej
startDate	string	Nej
questionId	string	Nej
questionIds	string	Nej
skip	number	Nej

Svar

Returnerer: GetQuestionResults200Response

Eksempel

getQuestionResults Eksempel

Copy

const tenantId: string = 'tenant_42';
const urlId: string = 'news/2025/fastcomments-release';
const userId: string = 'user_8b7f3c';
const startDate: string = '2025-01-01T00:00:00Z';
const questionIds: string = 'q123,q124';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

updateQuestionResult

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateQuestionResultBody	UpdateQuestionResultBody	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

updateQuestionResult Eksempel

Copy

const tenantId: string = 'tenant_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // valgfri parameter inkluderet
};
const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
questionId	string	Nej
questionIds	Array	Nej
urlId	string	Nej
timeBucket	AggregateTimeBucket	Nej
startDate	Date	Nej
forceRecalculate	boolean	Nej

Svar

Returnerer: AggregateQuestionResults200Response

bulkAggregateQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Ja
forceRecalculate	boolean	Nej

Svar

Returnerer: BulkAggregateQuestionResults200Response

combineCommentsWithQuestionResults

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
questionId	string	Nej
questionIds	Array	Nej
urlId	string	Nej
startDate	Date	Nej
forceRecalculate	boolean	Nej
minValue	number	Nej
maxValue	number	Nej
limit	number	Nej

Svar

Returnerer: CombineCommentsWithQuestionResults200Response

addSSOUser

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Ja

Svar

Returnerer: AddSSOUserAPIResponse

deleteSSOUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
deleteComments	boolean	Nej
commentDeleteMode	string	Nej

Svar

Returnerer: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
email	string	Ja

Svar

Returnerer: GetSSOUserByEmailAPIResponse

getSSOUserById

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: GetSSOUserByIdAPIResponse

getSSOUsers

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	number	Nej

Svar

Returnerer: GetSSOUsers200Response

patchSSOUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nej

Svar

Returnerer: PatchSSOUserAPIResponse

putSSOUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nej

Svar

Returnerer: PutSSOUserAPIResponse

createSubscription

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ja

Respons

Returnerer: CreateSubscriptionAPIResponse

deleteSubscription

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
userId	string	Nej

Svar

Returnerer: DeleteSubscriptionAPIResponse

getSubscriptions

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
userId	string	Nej

Svar

Returnerer: GetSubscriptionsAPIResponse

getTenantDailyUsages

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
yearNumber	number	Nej
monthNumber	number	Nej
dayNumber	number	Nej
skip	number	Nej

Respons

Returnerer: GetTenantDailyUsages200Response

Eksempel

getTenantDailyUsages Eksempel

Copy

const tenantId: string = "tenant_89f3c2-prod";
const yearNumber: number = 2026;
const monthNumber: number = 1;
const skip: number = 0;
const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

createTenantPackage

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Ja

Svar

Returnerer: CreateTenantPackage200Response

Eksempel

createTenantPackage-eksempel

Copy

const tenantId: string = "tenant_7f3b1a9c";
const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };
const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Premium Plus",
  tenantPackage,
  customConfig,
  notes: "Enable advanced moderation and image uploads" // valgfrit parameter demonstreret
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

deleteTenantPackage

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteTenantPackage

Copy

const tenantId: string = 'fc-tenant-8a9c2b';
const packageId: string = 'pkg-47f3c9';
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetTenantPackage200Response

Eksempel

getTenantPackage Eksempel

Copy

const tenantId: string = 'tenant_westus_01';
const packageId: string = 'pkg_premium_annual_2026';
interface FetchOptions { includeArchived?: boolean }
const options: FetchOptions = { includeArchived: false };
const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	number	Nej

Svar

Returnerer: GetTenantPackages200Response

Eksempel

Eksempel på getTenantPackages

Copy

const tenantId: string = 'tenant_4f3a9c2d';
const skip: number = 25;
const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);
const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

replaceTenantPackage

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
replaceTenantPackageBody	ReplaceTenantPackageBody	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på replaceTenantPackage

Copy

const tenantId: string = 'tenant-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // valgfrie felter som "notes" eller "trialExpiry" er bevidst udeladt her
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

updateTenantPackage

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateTenantPackageBody	UpdateTenantPackageBody	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateTenantPackage Eksempel

Copy

const tenantId: string = 'tenant_8a4f1c9b';
const packageId: string = 'pkg_premium_v2';
const customConfig: CustomConfigParameters = { enableRichText: true, maxImagesPerComment: 5 };
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Premium Moderation Package',
  enabled: true,
  description: 'Adds advanced spam rules, image moderation and priority support',
  customConfigParameters: customConfig
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, packageId, updateTenantPackageBody);

createTenantUser

Parametre

Name	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Ja

Respons

Returnerer: CreateTenantUser200Response

Eksempel

Eksempel på createTenantUser

Copy

const tenantId: string = "tenant_9a8c7e4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "julia.smith@acme-corp.com",
  displayName: "Julia Smith",
  role: "moderator",
  password: "Str0ngP@ssword!23",
  sendInviteEmail: true, // valgfri parameter demonstreret
  locale: "en-US",
  metadata: { department: "Customer Success" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

deleteTenantUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
deleteComments	string	Nej
commentDeleteMode	string	Nej

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteTenantUser Eksempel

Copy

const tenantId: string = 'tenant_8f3b2a9c';
const id: string = 'user_4e5f6a7b';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'hard';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

getTenantUser

Parametre

Name	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetTenantUser200Response

Eksempel

getTenantUser Eksempel

Copy

const tenantId: string = "tenant_9f7d4b2a-1c3e";
const id: string = "user_6a12b3c4d5";
const includeProfile: boolean | undefined = true; // eksempel på valgfri parameter
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log("Tenant user fetched", response);

getTenantUsers

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	number	Nej

Svar

Returnerer: GetTenantUsers200Response

Eksempel

getTenantUsers Eksempel

Copy

const tenantId: string = 'tenant_8f3b2c1a';
const skip: number = 50;
const firstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
const nextPage: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

replaceTenantUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
replaceTenantUserBody	ReplaceTenantUserBody	Ja
updateComments	string	Nej

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

replaceTenantUser Eksempel

Copy

const tenantId: string = "tenant_5f8b9a";
const id: string = "user_92bf21";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "jane.doe@acme-corp.com",
  displayName: "Jane Doe",
  externalId: "acme|12345",
  roles: ["commenter", "moderator"],
  isActive: true,
  metadata: { team: "product", location: "NYC" }
};
const updateComments: string = "Update historical comments to reflect new display name";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
redirectURL	string	Nej

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

sendLoginLink Eksempel

Copy

const tenantId: string = 'tenant_acme_01';
const id: string = 'user_9f3b2a';
const redirectURL: string = 'https://app.example.com/onboard?source=login-email';
const result: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

updateTenantUser

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateTenantUserBody	UpdateTenantUserBody	Ja
updateComments	string	Nej

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateTenantUser Eksempel

Copy

const tenantId: string = 'tenant_84f3b2';
const id: string = 'user_7a9d1c';
const updateComments: string = 'Promoted to moderator and updated contact email';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe+mod@example.com',
  displayName: 'Jane D.',
  roles: ['moderator'],
  isBanned: false,
  metadata: { department: 'community' }
};
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

createTenant

Parametre

Name	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createTenantBody	CreateTenantBody	Ja

Svar

Returnerer: CreateTenant200Response

Eksempel

createTenant Eksempel

Copy

const tenantId: string = "acme-corporation";
const billing: BillingInfo = { planId: "pro", billingContactEmail: "finance@acme-corp.com", currency: "USD" };
const domainConfig: APIDomainConfiguration = { primaryDomain: "comments.acme-corp.com", allowedDomains: ["acme-corp.com", "www.acme-corp.com"], enforceHttps: true };
const importedSites: ImportedSiteType[] = [{ siteId: "site-001", url: "https://blog.acme-corp.com", name: "Acme Blog" }]; // valgfri
const createBody: CreateTenantBody = { tenantName: "Acme Corporation", adminEmail: "admin@acme-corp.com", billingInfo: billing, domainConfiguration: domainConfig, importedSites, enableModeration: true };
const response: CreateTenant200Response = await createTenant(tenantId, createBody);

deleteTenant

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
sure	string	Nej

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteTenant Eksempel

Copy

const tenantId: string = "tenant_7b3f1a9e";
const id: string = "flag_9c4d2b1a";
const sure: string = "yes_confirm_delete";
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);
console.log(result);

getTenant

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetTenant200Response

Eksempel

getTenant-eksempel

Copy

const tenantId: string = "tenant_acme_corp";
const id: string = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
interface GetOptions { includeDeleted?: boolean; locale?: string; }
const options: GetOptions = { locale: "en-US" };
const result: GetTenant200Response = await getTenant(tenantId, id);

getTenants

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
meta	string	Nej
skip	number	Nej

Svar

Returnerer: GetTenants200Response

Eksempel

getTenants-eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_9f2d1b7c';
  const meta: string = 'include=domains,billing,customConfig';
  const skip: number = 20;
  const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
  console.log(response);
})();

updateTenant

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateTenantBody	UpdateTenantBody	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateTenant

Copy

const tenantId: string = "tenant_01H4ZQ7KABCD";
const id: string = "site_9f8e7d6c";
const apiDomainConfiguration: APIDomainConfiguration = {
  primaryDomain: "comments.acme.com",
  allowSubdomains: true
};
const billingInfo: BillingInfo = {
  planName: "Business",
  billingContactEmail: "billing@acme.com",
  seats: 25
};
const updateTenantBody: UpdateTenantBody = {
  displayName: "Acme Corporation Comments",
  apiDomainConfiguration,
  billingInfo, // valgfrit parameter demonstreret
  enableModeration: true
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

uploadImage

Upload og ændr størrelse på et billede

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
file	Blob	Ja
sizePreset	SizePreset	Nej
urlId	string	Nej

Svar

Returnerer: UploadImageResponse

getUserBadgeProgressById

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: GetUserBadgeProgressById200Response

getUserBadgeProgressByUserId

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
userId	string	Ja

Respons

Returnerer: GetUserBadgeProgressById200Response

getUserBadgeProgressList

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
limit	number	Nej
skip	number	Nej

Svar

Returnerer: GetUserBadgeProgressList200Response

createUserBadge

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Ja

Svar

Returnerer: CreateUserBadge200Response

deleteUserBadge

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: UpdateUserBadge200Response

getUserBadge

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetUserBadge200Response

getUserBadges

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
badgeId	string	Nej
type	number	Nej
displayedOnComments	boolean	Nej
limit	number	Nej
skip	number	Nej

Svar

Returnerer: GetUserBadges200Response

updateUserBadge

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateUserBadgeParams	UpdateUserBadgeParams	Ja

Svar

Returnerer: UpdateUserBadge200Response

getUserNotificationCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
sso	string	Nej

Svar

Returnerer: GetUserNotificationCount200Response

getUserNotifications

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
pageSize	number	Nej
afterId	string	Nej
includeContext	boolean	Nej
afterCreatedAt	number	Nej
unreadOnly	boolean	Nej
dmOnly	boolean	Nej
noDm	boolean	Nej
includeTranslations	boolean	Nej
sso	string	Nej

Svar

Returnerer: GetUserNotifications200Response

resetUserNotificationCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
sso	string	Nej

Respons

Returnerer: ResetUserNotifications200Response

resetUserNotifications

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
afterId	string	Nej
afterCreatedAt	number	Nej
unreadOnly	boolean	Nej
dmOnly	boolean	Nej
noDm	boolean	Nej
sso	string	Nej

Svar

Returnerer: ResetUserNotifications200Response

updateUserNotificationCommentSubscriptionStatus

Aktiver eller deaktiver notifikationer for en bestemt kommentar.

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
notificationId	string	Ja
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Ja
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: UpdateUserNotificationStatus200Response

updateUserNotificationPageSubscriptionStatus

Aktivér eller deaktiver notifikationer for en side. Når brugere er tilmeldt en side, oprettes notifikationer for nye hovedkommentarer, og også

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
url	string	Ja
pageTitle	string	Ja
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Ja
sso	string	Nej

Svar

Returnerer: UpdateUserNotificationStatus200Response

updateUserNotificationStatus

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
notificationId	string	Ja
newStatus	UpdateUserNotificationStatusNewStatusEnum	Ja
sso	string	Nej

Svar

Returnerer: UpdateUserNotificationStatus200Response

getUserPresenceStatuses

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlIdWS	string	Ja
userIds	string	Ja

Respons

Returnerer: GetUserPresenceStatuses200Response

searchUsers

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Ja
mentionGroupIds	Array	Nej
sso	string	Nej

Svar

Returnerer: SearchUsers200Response

getUser

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetUser200Response

Eksempel

getUser Eksempel

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // kan være undefined i nogle flows (valgfri)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

createVote

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
direction	CreateVoteDirectionEnum	Ja
userId	string	Nej
anonUserId	string	Nej

Respons

Returnerer: VoteComment200Response

Eksempel

createVote Eksempel

Copy

(async () => {
  const tenantId: string = 'acme-tenant-812';
  const commentId: string = '5e8f8b7a-3d4b-4f1b-9a2e-1c9f2d6a7b8c';
  const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.UP;
  const anonUserId: string = 'anon-84b9c2d';
  const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);
  console.log(voteResult);
})();

deleteVote

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
editKey	string	Nej

Svar

Returnerer: DeleteCommentVote200Response

Eksempel

Eksempel på deleteVote

Copy

const tenantId: string = 'tenant_7f3b21c9';
const id: string = 'vote_4a2d9f1b';
const editKey: string = 'edit_92b7c6a1';
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);

getVotes

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
urlId	string	Ja

Respons

Returnerer: GetVotes200Response

Eksempel

getVotes Eksempel

Copy

const tenantId: string = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// Hvis en valgfri parameter fandtes, f.eks. includeHidden, kunne den bruges sådan:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

getVotesForUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: GetVotesForUser200Response

Eksempel

getVotesForUser Eksempel

Copy

const tenantId: string = 'tenant_acme_01';
const urlId: string = 'news/2026/01/12/product-launch';
const userId: string = 'user_9c3f2b';
const anonUserId: string = 'anon_d4e7a1';
const votesForUser: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId);
const votesForAnon: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, undefined, anonUserId);

Brug for hjælp?

Hvis du støder på problemer eller har spørgsmål om JavaScript/TypeScript SDK'en, så:

Bidrag

Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.

Sprog 🇩🇰 Dansk

Kom godt i gang

API-reference

Dokumentation

Brug

Offentlige vs. sikrede API'er

SSO (Single Sign-On) integration

Almindelige brugsscenarier

Live-hændelser (opdateringer i realtid)

Broadcast-ID'er

Fejlhåndtering

Aggregering

Revisionslog

Bloker fra kommentar

Tjek blokerede kommentarer

Kommentarer

Domænekonfigurationer

E-mail-skabeloner

Hændelseslog

Feed-opslag

Marker kommentar

Hashtags

Moderatorer

Notifikationstælling

Notifikationer

Sider

Afventende webhook-hændelser

Spørgsmålskonfigurationer

Spørgsmålsresultater

Aggregering af spørgsmålsresultater

SSO-brugere

Abonnementer

Lejers daglige forbrug

Lejerpakker

Lejerbrugere

Lejere

Upload billede

Brugerbadge-fremgang

Brugerbadges

Brugernotifikationer

Brugertilstedeværelsesstatus

Brugersøgning

Brugere

Stemmer

FastComments JavaScript/TypeScript SDK

Repository

Installation

API Documentation

Fuld API-reference: docs/api/README.md

Browser vs Server Compatibility

Usage

Browserbrug (klientside)

Serverbrug (Node.js)

Kun typer-import

Brug af individuelle API-klasser

Browsermiljø

Servermiljø

Public vs Secured APIs

Eksempel: Brug af Public API (browser-sikkert)

Eksempel: Brug af Default API (kun på serversiden)

SSO (Single Sign-On) Integration

Simpelt SSO (Kun server-side)

Sikkert SSO (Server-side, anbefalet)

Brug af SSO fra browseren (med servergenereret token)

SSO med kommentaroprettelse

Common Use Cases

Hent kommentarer for en side

Oprettelse af en kommentar

Stem på en kommentar

Brugeradministration (Kræver API-nøgle)

Live Events (Real-time Updates)

Begivenheder på sideniveau

Abonner på brugerbegivenheder

Sådan får du userIdWS

Broadcast IDs

Error Handling

aggregate

Parametre

Svar

getAuditLogs