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-dokumentation

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

Browser- vs. serverkompatibilitet

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

Brug

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

Offentlige vs. sikrede API'er

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

Almindelige brugstilfælde

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-hændelser (opdateringer i realtid)

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-ID'er

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

Fejlhåndtering

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

Name	Type	Required
tenantId	string	Ja
limit	number	Nej
skip	number	Nej
order	SORTDIR	Nej
after	number	Nej
before	number	Nej

Svar

Returnerer: GetAuditLogs200Response

Eksempel

getAuditLogs Eksempel

Copy

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

blockFromCommentPublic

Parametre

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

Svar

Returnerer: BlockFromCommentPublic200Response

Eksempel

Eksempel på blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parametre

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

Svar

Returnerer: UnBlockCommentPublic200Response

Eksempel

unBlockCommentPublic Eksempel

Copy

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

checkedCommentsForBlocked

Parametre

Name	Type	Required
tenantId	string	Ja
commentIds	string	Ja
sso	string	Nej

Svar

Returnerer: CheckedCommentsForBlocked200Response

Eksempel

checkedCommentsForBlocked Eksempel

Copy

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

blockUserFromComment

Parametre

Navn	Type	Obligatorisk
tenantId	string	Ja
id	string	Ja
blockFromCommentParams	BlockFromCommentParams	Ja
userId	string	Nej
anonUserId	string	Nej

Respons

Returnerer: BlockFromCommentPublic200Response

Eksempel

Eksempel på blockUserFromComment

Copy

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

createCommentPublic

Parametre

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

Eksempel

createCommentPublic Eksempel

Copy

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

deleteComment

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Ja
contextUserId	string	Nej
isLive	boolean	Nej

Svar

Returnerer: DeleteComment200Response

Eksempel

Eksempel på deleteComment

Copy

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

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

Eksempel

deleteCommentPublic Eksempel

Copy

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

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

Eksempel

deleteCommentVote Eksempel

Copy

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

flagComment

Parametre

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

Svar

Returnerer: FlagComment200Response

Eksempel

flagComment Eksempel

Copy

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

getComment

Parametre

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

Svar

Returnerer: GetComment200Response

Eksempel

getComment-eksempel

Copy

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

getComments

Parametre

Name	Type	Required
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

Eksempel

getComments Eksempel

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // side
  20, // antal pr. side
  0, // spring over
  true, // som træstruktur
  1, // spring børn over
  3, // begræns antal børn
  4, // maksimal trædybde
  'articles/2026/new-product-launch', // url-id
  'user_7890', // bruger-id
  'anon_4f3b2', // anonym bruger-id
  undefined, // kontekst-bruger-id
  '#launch', // hashtag
  undefined // overordnet id
);

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

Eksempel

getCommentsPublic Eksempel

Copy

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

getCommentText

Parametre

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

Respons

Returnerer: GetCommentText200Response

Eksempel

getCommentText Eksempel

Copy

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

getCommentVoteUserNames

Parametre

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

Svar

Returnerer: GetCommentVoteUserNames200Response

Eksempel

getCommentVoteUserNames Eksempel

Copy

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

lockComment

Parametre

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

Respons

Returnerer: LockComment200Response

Eksempel

lockComment-eksempel

Copy

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

pinComment

Parametre

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

Svar

Returnerer: PinComment200Response

Eksempel

pinComment Eksempel

Copy

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

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

Eksempel

Eksempel på saveComment

Copy

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

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

Svar

Returnerer: Array<SaveComment200Response

Eksempel

Eksempel på saveCommentsBulk

Copy

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

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

Eksempel

setCommentText Eksempel

Copy

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

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

Eksempel

unBlockUserFromComment Eksempel

Copy

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

unFlagComment

Parametre

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

Svar

Returnerer: FlagComment200Response

Eksempel

unFlagComment Eksempel

Copy

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

unLockComment

Parametre

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

Svar

Returnerer: LockComment200Response

Eksempel

unLockComment Eksempel

Copy

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

unPinComment

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nej

Svar

Returnerer: PinComment200Response

Eksempel

Eksempel på unPinComment

Copy

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

updateComment

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateComment Eksempel

Copy

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

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

Eksempel

Eksempel på voteComment

Copy

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

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	Krævet	Beskrivelse
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Ja

Svar

Returnerer: CreateEmailTemplate200Response

Eksempel

Eksempel på createEmailTemplate

Copy

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

deleteEmailTemplate

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteEmailTemplate Eksempel

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // eksempel på valgfrit parameter
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteEmailTemplateRenderError

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // valgfri miljøvælger
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

getEmailTemplate

Parametre

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

Svar

Returnerer: GetEmailTemplate200Response

Eksempel

getEmailTemplate Eksempel

Copy

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

getEmailTemplateDefinitions

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: GetEmailTemplateDefinitions200Response

Eksempel

getEmailTemplateDefinitions Eksempel

Copy

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

getEmailTemplateRenderErrors

Parametre

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

Svar

Returnerer: GetEmailTemplateRenderErrors200Response

Eksempel

Eksempel på getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parametre

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

Svar

Returnerer: GetEmailTemplates200Response

Eksempel

getEmailTemplates Eksempel

Copy

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

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

updateEmailTemplate

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateEmailTemplateBody	UpdateEmailTemplateBody	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateEmailTemplate

Copy

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

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

Svar

Returnerer: GetEventLog200Response

Eksempel

getEventLog-eksempel

Copy

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

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

Eksempel

Eksempel på getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 dage siden
const endTimeOptional: number | undefined = undefined; // valgfri tidsramme slut
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

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

Respons

Returnerer: CreateFeedPost200Response

Eksempel

Eksempel på createFeedPost

Copy

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

createFeedPostPublic

Parametre

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

Svar

Returnerer: CreateFeedPostPublic200Response

Eksempel

createFeedPostPublic Eksempel

Copy

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

deleteFeedPostPublic

Parametre

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

Svar

Returnerer: DeleteFeedPostPublic200Response

Eksempel

deleteFeedPostPublic Eksempel

Copy

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

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

Eksempel

getFeedPosts Eksempel

Copy

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

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

Eksempel

Eksempel på getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametre

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

Svar

Returnerer: GetFeedPostsStats200Response

Eksempel

getFeedPostsStats Eksempel

Copy

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

getUserReactsPublic

Parametre

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

Respons

Returnerer: GetUserReactsPublic200Response

Eksempel

getUserReactsPublic Eksempel

Copy

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

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

Eksempel

reactFeedPostPublic Eksempel

Copy

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

updateFeedPost

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateFeedPost

Copy

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

updateFeedPostPublic

Parametre

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

Respons

Returnerer: CreateFeedPostPublic200Response

Eksempel

Eksempel på updateFeedPostPublic

Copy

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

flagCommentPublic

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

flagCommentPublic Eksempel

Copy

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

addHashTag

Parametre

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

Respons

Returnerer: AddHashTag200Response

Eksempel

addHashTag Eksempel

Copy

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

addHashTagsBulk

Parametre

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

Svar

Returnerer: AddHashTagsBulk200Response

Eksempel

addHashTagsBulk Eksempel

Copy

// Opret tenant-identifikator (valgfri parameter)
const tenantId: string = "tenant_9f8c2b7a";
// Forbered individuelle tag-poster
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Krop til bulk-oprettelse (valgfri parameter)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Kald den globale asynkrone funktion og tildel det typede resultat
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

deleteHashTag

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteHashTag

Copy

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

getHashTags

Parametre

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

Svar

Returnerer: GetHashTags200Response

Eksempel

getHashTags Eksempel

Copy

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

patchHashTag

Parametre

Name	Type	Required
tag	string	Ja
tenantId	string	Nej
updateHashTagBody	UpdateHashTagBody	Nej

Svar

Returnerer: PatchHashTag200Response

Eksempel

patchHashTag Eksempel

Copy

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

createModerator

Parametre

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

Svar

Returnerer: CreateModerator200Response

Eksempel

Eksempel på createModerator

Copy

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

deleteModerator

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteModerator

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
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 = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

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-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

sendInvite

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

sendInvite-eksempel

Copy

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

updateModerator

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateModerator

Copy

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

deleteNotificationCount

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

deleteNotificationCount Eksempel

Copy

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

getCachedNotificationCount

Parametre

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

Svar

Returnerer: GetCachedNotificationCount200Response

Eksempel

getCachedNotificationCount Eksempel

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // valgfrit parameter-flag (demonstreret)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

getNotificationCount

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
urlId	string	Nej
fromCommentId	string	Nej
viewed	boolean	Nej
type	string	Nej

Respons

Returnerer: GetNotificationCount200Response

Eksempel

getNotificationCount Eksempel

Copy

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

getNotifications

Parametre

Navn	Type	Påkrævet
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

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

updateNotification

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateNotification

Copy

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

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

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deletePendingWebhookEvent Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // eksempel på en valgfri parameter (ikke påkrævet af funktionen)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

Parametre

Navn	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

Svar

Returnerer: GetPendingWebhookEventCount200Response

Eksempel

getPendingWebhookEventCount Eksempel

Copy

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

getPendingWebhookEvents

Parametre

Navn	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

Eksempel på getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametre

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

Svar

Returnerer: CreateQuestionConfig200Response

Eksempel

Eksempel på createQuestionConfig

Copy

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

deleteQuestionConfig

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteQuestionConfig Eksempel

Copy

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

getQuestionConfig

Parametre

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

Respons

Returnerer: GetQuestionConfig200Response

Eksempel

getQuestionConfig Eksempel

Copy

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

getQuestionConfigs

Parametre

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

Svar

Returnerer: GetQuestionConfigs200Response

Eksempel

getQuestionConfigs Eksempel

Copy

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

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

createQuestionResult

Parametre

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

Svar

Returnerer: CreateQuestionResult200Response

Eksempel

createQuestionResult Eksempel

Copy

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

deleteQuestionResult

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

deleteQuestionResult Eksempel

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // valgfri parameter, der demonstrerer alternativt målvalg
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

getQuestionResult

Parametre

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

Svar

Returnerer: GetQuestionResult200Response

Eksempel

getQuestionResult-eksempel

Copy

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

getQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Svar

Returnerer: GetQuestionResults200Response

Eksempel

getQuestionResults Eksempel

Copy

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

updateQuestionResult

Parametre

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateQuestionResult

Copy

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

aggregateQuestionResults

Parametre

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

Respons

Returnerer: AggregateQuestionResults200Response

Eksempel

aggregateQuestionResults Eksempel

Copy

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

bulkAggregateQuestionResults

Parametre

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

Svar

Returnerer: BulkAggregateQuestionResults200Response

Eksempel

bulkAggregateQuestionResults Eksempel

Copy

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

combineCommentsWithQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

Svar

Returnerer: CombineCommentsWithQuestionResults200Response

Eksempel

Eksempel på combineCommentsWithQuestionResults

Copy

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

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

Svar

Returnerer: CreateSubscriptionAPIResponse

Eksempel

Eksempel på createSubscription

Copy

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

deleteSubscription

Parametre

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

Svar

Returnerer: DeleteSubscriptionAPIResponse

getSubscriptions

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
userId	string	Nej

Svar

Returnerer: GetSubscriptionsAPIResponse

Eksempel

getSubscriptions-eksempel

Copy

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

updateSubscription

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Ja
userId	string	Nej

Svar

Returnerer: UpdateSubscriptionAPIResponse

Eksempel

updateSubscription-eksempel

Copy

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

getTenantDailyUsages

Parametre

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

Svar

Returnerer: GetTenantDailyUsages200Response

Eksempel

getTenantDailyUsages Eksempel

Copy

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

createTenantPackage

Parametre

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

Respons

Returnerer: CreateTenantPackage200Response

Eksempel

createTenantPackage Eksempel

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // valgfrit parameter angivet
  // valgfri felter udeladt: f.eks. avancerede moderatorregler, brugerdefineret CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // illustrativ værdi; bruger CustomConfigParameters-struktur
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

deleteTenantPackage Eksempel

Copy

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

getTenantPackage

Parametre

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

Respons

Returnerer: GetTenantPackage200Response

Eksempel

getTenantPackage Eksempel

Copy

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

getTenantPackages

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
skip	number	Nej

Respons

Returnerer: GetTenantPackages200Response

Eksempel

getTenantPackages Eksempel

Copy

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

replaceTenantPackage

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

replaceTenantPackage Eksempel

Copy

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

updateTenantPackage

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateTenantPackageBody	UpdateTenantPackageBody	Ja

Svar

Returnerer: FlagCommentPublic200Response

Example

Eksempel på updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // valgfrie felter udeladt med vilje (f.eks. beskrivelse, grænser)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parametre

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

Svar

Returnerer: CreateTenantUser200Response

Eksempel

Eksempel på createTenantUser

Copy

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

deleteTenantUser

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på deleteTenantUser

Copy

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

getTenantUser

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: GetTenantUser200Response

Eksempel

getTenantUser Eksempel

Copy

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

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_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

replaceTenantUser

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på replaceTenantUser

Copy

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

sendLoginLink

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på sendLoginLink

Copy

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

updateTenantUser

Parametre

Navn	Type	Obligatorisk
tenantId	string	Ja
id	string	Ja
updateTenantUserBody	UpdateTenantUserBody	Ja
updateComments	string	Nej

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateTenantUser

Copy

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

createTenant

Parametre

Name	Type	Required	Description
tenantId	string	Ja
createTenantBody	CreateTenantBody	Ja

Svar

Returnerer: CreateTenant200Response

Eksempel

Eksempel på createTenant

Copy

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

deleteTenant

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

deleteTenant Eksempel

Copy

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

getTenant

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Respons

Returnerer: GetTenant200Response

Eksempel

getTenant-eksempel

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // valgfri override, hvis tilgængelig
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

getTenants

Parametre

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

Respons

Returnerer: GetTenants200Response

Eksempel

getTenants Eksempel

Copy

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

updateTenant

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Ja
updateTenantBody	UpdateTenantBody	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateTenant Eksempel

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // valgfri, udelad for at beholde nuværende fakturering
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parametre

Name	Type	Required
tenantId	string	Ja
userId	string	Ja
id	string	Ja
changeTicketStateBody	ChangeTicketStateBody	Ja

Svar

Returnerer: ChangeTicketState200Response

Eksempel

Eksempel på changeTicketState

Copy

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

createTicket

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Ja
createTicketBody	CreateTicketBody	Ja

Respons

Returnerer: CreateTicket200Response

Eksempel

createTicket Eksempel

Copy

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

getTicket

Parametre

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

Svar

Returnerer: GetTicket200Response

Eksempel

getTicket Eksempel

Copy

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

getTickets

Parametre

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

Svar

Returnerer: GetTickets200Response

Eksempel

getTickets Eksempel

Copy

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

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

Eksempel

getUserBadgeProgressById Eksempel

Copy

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

getUserBadgeProgressByUserId

Parametre

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

Svar

Returnerer: GetUserBadgeProgressById200Response

Eksempel

Eksempel på getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // valgfri kilde (kan være undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

getUserBadgeProgressList

Parametre

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

Svar

Returnerer: GetUserBadgeProgressList200Response

Eksempel

getUserBadgeProgressList Eksempel

Copy

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

createUserBadge

Parametre

Name	Type	Required	Description
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Ja

Svar

Returnerer: CreateUserBadge200Response

Eksempel

createUserBadge Eksempel

Copy

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

deleteUserBadge

Parametre

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

Respons

Returnerer: UpdateUserBadge200Response

Eksempel

deleteUserBadge Eksempel

Copy

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

getUserBadge

Parametre

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

Svar

Returnerer: GetUserBadge200Response

Eksempel

getUserBadge Eksempel

Copy

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

getUserBadges

Parametre

Name	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

Eksempel

getUserBadges Eksempel

Copy

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

updateUserBadge

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateUserBadgeParams	UpdateUserBadgeParams	Ja

Svar

Returnerer: UpdateUserBadge200Response

Eksempel

updateUserBadge Eksempel

Copy

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

getUserNotificationCount

Parametre

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

Svar

Returnerer: GetUserNotificationCount200Response

Eksempel

Eksempel på getUserNotificationCount

Copy

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

getUserNotifications

Parametre

Name	Type	Required
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

Eksempel

getUserNotifications Eksempel

Copy

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

resetUserNotificationCount

Parametre

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

Svar

Returnerer: ResetUserNotifications200Response

Eksempel

Eksempel på resetUserNotificationCount

Copy

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

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

Eksempel

Eksempel på resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Aktiver eller deaktiver notifikationer for en bestemt kommentar.

Parameters

Name	Type	Required
tenantId	string	Ja
notificationId	string	Ja
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Ja
commentId	string	Ja
sso	string	Nej

Response

Returnerer: UpdateUserNotificationStatus200Response

Example

Eksempel på updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

Aktivér eller deaktiver notifikationer for en side. Når brugere er tilmeldt en side, oprettes notifikationer for nye topniveau-kommentarer, 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

Eksempel

Eksempel for updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parametre

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

Svar

Returnerer: UpdateUserNotificationStatus200Response

Eksempel

updateUserNotificationStatus Eksempel

Copy

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

getUserPresenceStatuses

Parametre

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

Respons

Returnerer: GetUserPresenceStatuses200Response

Eksempel

getUserPresenceStatuses Eksempel

Copy

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

searchUsers

Parametre

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

Svar

Returnerer: SearchUsers200Response

Eksempel

searchUsers Eksempel

Copy

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

getUser

Parametre

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

Svar

Returnerer: GetUser200Response

Eksempel

getUser-eksempel

Copy

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

createVote

Parametre

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

Svar

Returnerer: VoteComment200Response

Eksempel

createVote Eksempel

Copy

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

deleteVote

Parametre

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

Respons

Returnerer: DeleteCommentVote200Response

Eksempel

deleteVote Eksempel

Copy

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

getVotes

Parametre

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

Svar

Returnerer: GetVotes200Response

Eksempel

getVotes-eksempel

Copy

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

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

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

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

Aggregering

Revisionslog

Bloker fra kommentar

Tjek blokerede kommentarer

Kommentarer

Domænekonfigurationer

E-mail-skabeloner

Hændelseslog

Feed-opslag

Flag kommentar

Hashtags

Moderatorer

Notifikationstælling

Notifikationer

Sider

Ventende webhook-hændelser

Spørgsmålskonfigurationer

Spørgsmålsresultater

Aggregering af spørgsmålsresultater

SSO-brugere

Abonnementer

Lejerens daglige forbrug

Lejerpakker

Lejerbrugere

Lejere

Sager

Upload billede

Brugerbadge-fremgang

Brugerbadges

Brugernotifikationer

Bruger-tilstedeværelsesstatus

Brugersøgning

Brugere

Stemmer

FastComments JavaScript/TypeScript SDK

Repository

Installation

API-dokumentation

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

Browser- vs. serverkompatibilitet

Brug

Browserbrug (klientside)

Serverbrug (Node.js)

Kun typer-import

Brug af individuelle API-klasser

Browsermiljø

Servermiljø

Offentlige vs. sikrede API'er

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

Almindelige brugstilfælde

Hent kommentarer for en side

Oprettelse af en kommentar

Stem på en kommentar

Brugeradministration (Kræver API-nøgle)

Live-hændelser (opdateringer i realtid)

Begivenheder på sideniveau

Abonner på brugerbegivenheder

Sådan får du userIdWS

Broadcast-ID'er

Fejlhåndtering

aggregate

Parametre

Svar

getAuditLogs

Parametre

Svar

Eksempel

blockFromCommentPublic

Parametre