FastComments JavaScript/TypeScript SDK

Dette er det officielle JavaScript/TypeScript SDK til FastComments.

Administrer kommentarer, brugere, SSO og moderering fra Node.js eller i browseren.

Arkiv

Installation

npm install fastcomments-sdk

API Documentation

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

Browser vs Server Compatibility

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

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

Usage

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

Browserbrug (klientside)

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

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

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

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

Serverbrug (Node.js)

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

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

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

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

Kun typer-import

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

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

Brug af individuelle API-klasser

Browsermiljø

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

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

const publicApi = new PublicApi(config);

Servermiljø

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

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

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

Public vs Secured APIs

SDK'et leverer tre hoved-API-klasser:

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

Eksempel: Brug af Public API (browser-sikkert)

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

const publicApi = new PublicApi();

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

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

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

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

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

SSO (Single Sign-On) Integration

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

Simpelt SSO (Kun server-side)

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

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

// Create simple SSO using the built-in helper  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

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

Sikkert SSO (Server-side, anbefalet)

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

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

// Create secure SSO using the built-in helper
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

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

// Or send ssoConfig to client for browser usage

Brug af SSO fra browseren (med servergenereret token)

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

// Get SSO token from your server endpoint
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use the server-generated SSO token
});

SSO med kommentaroprettelse

// Server-side: Create SSO and comment
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Common Use Cases

Hent kommentarer for en side

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

Oprettelse af en kommentar

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

Stem på en kommentar

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

Brugeradministration (Kræver API-nøgle)

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

Live Events (Real-time Updates)

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

Begivenheder på sideniveau

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

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

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

// Abonner på live-begivenheder for en side
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (hent dette fra getComments-responsen)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Opdater din UI med den nye kommentar
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Opdater stemmetællinger i din UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Returner true hvis begivenheden blev håndteret
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

Abonner på brugerbegivenheder

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

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

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

// Abonner på brugerens personlige feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Vis notifikation i din UI
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

Sådan får du userIdWS

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

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

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

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

Broadcast IDs

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

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // Unikt ID for denne operation
  }
});

Error Handling

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

aggregate

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

Parametre

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

Svar

Returnerer: Aggregate200Response

Eksempel

Eksempel på aggregate

Copy

const tenantId: string = 'tenant_78a9';
const parentTenantId: string = 'parent_tenant_01';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  operation: { type: 'COUNT' },
  groupBy: ['pageUrl'],
  predicate: { field: 'status', operator: 'EQUALS', value: 'approved' },
  sort: [{ field: 'count', direction: 'DESC' }],
  limit: 25
};
const result: Aggregate200Response = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

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

const tenantId: string = 'tenant_5f8d7c3a';
const limit: number = 100;
const skip: number = 0;
const order: SORTDIR = 'DESC' as SORTDIR;
const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // en uge siden
const before: number = Date.now();
const result: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after, before);

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 = 'tenant_6b3f9a2d';
const commentId: string = 'cmt_8f4b12a9';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'Repeated promotional links',
  durationMinutes: 60 * 24 * 30, // 30 dage
  escalateToModeration: true
};
const sso: string = 'sso_token_3fH7kLw';
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-42-production";
const commentId: string = "comment_7f3b2a9d";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "flag reviewed and determined not to violate policy",
  restoredBy: "moderator_jane",
  restoredAt: new Date().toISOString()
};
const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

checkedCommentsForBlocked

Parametre

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

Svar

Returnerer: CheckedCommentsForBlocked200Response

Eksempel

checkedCommentsForBlocked Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_fa3b2c9e';
  const commentIds: string = 'cmt_112233,cmt_445566';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0Njc4IiwidGVuYW50IjoidGVuYW50X2ZhM2IifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, sso);
  const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
  console.log(resultWithSSO, resultWithoutSSO);
})();

blockUserFromComment

Parametre

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

Svar

Returnerer: BlockFromCommentPublic200Response

Eksempel

Eksempel på blockUserFromComment

Copy

const tenantId: string = "tenant_7f3b4c";
const id: string = "comment_9a8b7c6d";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated spam links",
  durationHours: 168,
  notifyModerators: true
};
const userId: string | undefined = "user_42";
const anonUserId: string | undefined = undefined;
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

Svar

Returnerer: CreateCommentPublic200Response

Eksempel

Eksempel på createCommentPublic

Copy

const tenantId: string = 'tenant_9a1b2c';
const urlId: string = 'https://www.news-site.com/article/67890';
const broadcastId: string = 'broadcast_2026-06-15-01';
const sessionId: string | undefined = 'sess_abc123xyz';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiam9yZGFuIiwiaWF0IjoxNjI0MDAwMDB9.signature';
const commentData: CommentData = {
  content: 'Insightful piece — I appreciated the data-backed points and sources cited.',
  authorDisplayName: 'Jordan Miles'
} as CommentData;
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Parametre

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

Respons

Returnerer: DeleteComment200Response

Eksempel

Eksempel på deleteComment

Copy

const tenantId: string = 'tenant_84a9f2';
const id: string = 'comment_5f3b21';
const contextUserId: string | undefined = 'user_1122';
const isLive: boolean | undefined = true;
async function run(): Promise<void> {
  const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);
  console.log(result);
}
run();

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_acme_42';
const commentId: string = 'c0mment-9f8b7a6';
const broadcastId: string = 'site_homepage_2026-06-15';
const editKey: string = 'ek_3b7a1f59-4d2c-11eb-8dcd-0242ac130003';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

deleteCommentVote

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
voteId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
editKey	string	Nej
sso	string	Nej

Svar

Returnerer: DeleteCommentVote200Response

Eksempel

Eksempel på deleteCommentVote

Copy

const tenantId: string = 'tenant_8f3a2b7c';
const commentId: string = 'cmt-5a1f3d92';
const voteId: string = 'vote-3b9c7e1a';
const urlId: string = 'articles/2026/06/typescript-best-practices';
const broadcastId: string = 'broadcast-77f4d2';
const editKey: string = 'edk-9b2f4c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const result: 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_4f21c9a";
const commentId: string = "cmt_7a12b3e9";
const userId: string = "user_82bd123";
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

getComment

Parametre

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

Svar

Returnerer: GetComment200Response

Eksempel

Eksempel på getComment

Copy

const tenantId: string = 'tenant_6f1a2b';
const commentId: string = 'cmt_4d9e8f';
const includeReplies: boolean | undefined = true; // eksempel på en valgfri parameter (ikke sendt til getComment)
const result: GetComment200Response = await getComment(tenantId, commentId);
console.log('Fetched comment for tenant:', tenantId, 'comment id:', commentId);
console.log('API response received:', result);

getComments

Parametre

Navn	Type	Påkrævet
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
fromDate	number	Nej
toDate	number	Nej

Svar

Returnerer: GetComments200Response

Eksempel

getComments Eksempel

Copy

const tenantId: string = "tenant_9a12b3";
const response: GetComments200Response = await getComments(tenantId, 1, 20, 0, true, 0, 3, 2, "https://mysite.com/posts/678", undefined, undefined, undefined, undefined, "parent_987", undefined, 1716873600000, 1719552000000);

getCommentsPublic

req tenantId urlId

Parametre

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

Svar

Returnerer: GetCommentsPublic200Response

Eksempel

Eksempel på getCommentsPublic

Copy

const tenantId: string = 'acme-news';
const urlId: string = '/articles/2026/fastcomments-update';
const page: number = 1;
const skip: number = 0;
const limit: number = 25;
const countChildren: boolean = true;
const includeConfig: boolean = true;
const result: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  page,
  undefined,
  undefined,
  skip,
  undefined,
  limit,
  undefined,
  countChildren,
  undefined,
  includeConfig
);

getCommentText

Parametre

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

Svar

Returnerer: GetCommentText200Response

Eksempel

getCommentText Eksempel

Copy

const tenantId: string = 'tenant_42b7e9';
const commentId: string = 'cmt_9f3a2b';
const editKey: string = 'edk_3f1b7c9d';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
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

const tenantId: string = "tenant_67890";
const commentId: string = "comment_abc123";
const dir: number = 1;
const ssoToken: string = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const responseWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
const responseWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

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_42f6c1';
const commentId: string = 'cmt-9a8b7c';
const broadcastId: string = 'brd_2026_06_15';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY1MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const lockedWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const lockedWithoutSso: 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 = "acme-corp-tenant-72";
const commentId: string = "cmt_8f3a2b4c9d";
const broadcastId: string = "live_2026-06-15_21z";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload.signature";
const responseNoSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId);
const responseWithSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

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

saveComment Eksempel

Copy

const tenantId: string = "fastcomments-tenant-42";
const createCommentParams: CreateCommentParams = {
  threadId: "article-2026-06-0142",
  content: "Great write-up — I followed the migration steps and everything worked as described.",
  userId: "u_9c72b",
  userName: "Ava R.",
  userAvatarUrl: "https://cdn.example.com/avatars/u_9c72b.png",
  metadata: { platform: "web", locale: "en-US" }
};
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

saveCommentsBulk Eksempel

Copy

const tenantId: string = "tenant_42a1b7";
const mentions: CommentUserMentionInfo[] = [{ userId: "user_2b9", displayName: "Alex Chen" }];
const hashtags: CommentUserHashTagInfo[] = [{ tag: "performance" }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: "Thanks for the detailed article — the alternative approach worked for me.",
    authorId: "user_8f3c2",
    authorName: "Maya Patel",
    authorEmail: "maya.patel@example.com",
    url: "/articles/optimizing-ts-performance",
    createdAt: new Date().toISOString(),
    mentions,
    hashtags
  }
];
const isLive: boolean = true;
const doSpamCheck: boolean = false;
const sendEmails: boolean = true;
const populateNotifications: boolean = true;
const result: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

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

Respons

Returnerer: SetCommentText200Response

Eksempel

setCommentText Eksempel

Copy

const tenantId: string = 'tenant_4f9a2b'
const commentId: string = 'cmt-8421'
const broadcastId: string = 'brd-2026-06-15'
const commentTextUpdateRequest: CommentTextUpdateRequest = { text: 'Updated comment text to clarify the schedule.', mentions: [], hashtags: [] }
const editKey: string = 'editkey_9b12'
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso.signature'
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_7b9c2a';
const id: string = 'comment_4f8e1d';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'User submitted appeal and provided additional context',
  effectiveAt: new Date().toISOString()
};
const userId: string = 'user_92a3f6';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

unFlagComment

Parametre

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

Svar

Returnerer: FlagComment200Response

Eksempel

Eksempel på unFlagComment

Copy

const tenantId: string = 'tenant_8f3b2a1f';
const commentId: string = 'cmt_20250614_01';
const userId: string = 'user_47d2b9';
const result: FlagComment200Response = await unFlagComment(tenantId, commentId, userId);

unLockComment

Parametre

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

Respons

Returnerer: LockComment200Response

Eksempel

unLockComment Eksempel

Copy

const tenantId: string = "tenant-8f3b2c4a";
const commentId: string = "cmt_92a7f3e6";
const broadcastId: string = "brd_1b4c9d20";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

unPinComment

Parametre

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

Svar

Returnerer: PinComment200Response

Eksempel

unPinComment-eksempel

Copy

const tenantId: string = "tenant_9f3b2c1a";
const commentId: string = "comment_4d2e8a7f";
const broadcastId: string = "broadcast_live_2026_06_15_18";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.invalid-signature";
const response: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);
console.log(response);

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

Eksempel på updateComment

Copy

const tenantId: string = 'tenant_7f3c1b2a';
const commentId: string = 'cmt_8d9f2a4b';
const updatableCommentParams: UpdatableCommentParams = {
  body: 'Updating this comment to clarify the feature behavior and include a timestamp.',
  metadata: { category: 'support', editedReason: 'clarify instructions' },
  visible: true
};
const contextUserId: string = 'user_42';
const doSpamCheck: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, commentId, updatableCommentParams, contextUserId, doSpamCheck);

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

Respons

Returnerer: VoteComment200Response

Eksempel

Eksempel på voteComment

Copy

const tenantId: string = 'tenant_7f9d2e';
const commentId: string = '5a1d3f9b-2c4e-4a2b-bf7b-1234567890ab';
const urlId: string = 'articles/2026/06/15/typescript-api-patterns';
const broadcastId: string = 'broadcast-20260615-01';
const voteBodyParams: VoteBodyParams = { vote: 'up' };
const sessionId: string = 'sess_9d2f3b45';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY5NzE2MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const response: VoteComment200Response = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

getCommentsForUser

Parametre

Name	Type	Påkrævet
userId	string	Nej
direction	SortDirections	Nej
repliesToUserId	string	Nej
page	number	Nej
includei10n	boolean	Nej
locale	string	Nej
isCrawler	boolean	Nej

Svar

Returnerer: GetCommentsForUser200Response

Eksempel

Eksempel på getCommentsForUser

Copy

const userId: string = "550e8400-e29b-41d4-a716-446655440000";
const page: number = 2;
const includei10n: boolean = true;
const locale: string = "en-US";
const isCrawler: boolean = false;
const comments: GetCommentsForUser200Response = await getCommentsForUser(
  userId,
  undefined, // direction udeladt
  undefined, // repliesToUserId udeladt
  page,
  includei10n,
  locale,
  isCrawler
);
console.log(comments);

addDomainConfig

Parametre

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

Respons

Returnerer: AddDomainConfig200Response

deleteDomainConfig

Parametre

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

Svar

Returnerer: DeleteDomainConfig200Response

getDomainConfig

Parametre

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

Svar

Returnerer: GetDomainConfig200Response

getDomainConfigs

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: GetDomainConfigs200Response

patchDomainConfig

Parametre

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

Svar

Returnerer: GetDomainConfig200Response

putDomainConfig

Parametre

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

Response

Returnerer: GetDomainConfig200Response

createEmailTemplate

Parametre

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

Svar

Returnerer: CreateEmailTemplate200Response

Eksempel

createEmailTemplate Eksempel

Copy

const tenantId: string = "tenant_4f2b1c9e";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "New Comment Notification",
  subject: "Someone replied to your discussion",
  fromName: "Community Team",
  fromAddress: "no-reply@community.example.com",
  htmlBody: "<p>\{{comment.author}} replied: \{{comment.text}}</p>",
  plaintextBody: "\{{comment.author}} replied: \{{comment.text}}",
  previewText: "A new reply on a discussion you follow",
  isDefault: false // valgfrit flag der demonstrerer brugen af en valgfri parameter
};
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_9c4f1b2a";
const id: string = "emailtmpl_4d2b9a5e";
const requestorNote: string | undefined = undefined; // valgfri metadata (ikke påkrævet af funktionen)
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, id);

deleteEmailTemplateRenderError

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteEmailTemplateRenderError Eksempel

Copy

const tenantId: string = 'tenant-72f3b4';
const templateId: string = 'email_template-9c3a1';
let providedErrorId: string | undefined = undefined; // valgfri værdi, kan være sat andetsteds
const errorId: string = providedErrorId ?? 'render_err-5d2f7';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);

getEmailTemplate

Parametre

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

Svar

Returnerer: GetEmailTemplate200Response

Eksempel

getEmailTemplate Eksempel

Copy

const tenantId: string = 'tenant_7f3b2c';
const templateId: string = 'welcome-email-2024';
const includeDrafts: boolean | undefined = undefined;
const emailTemplate: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

getEmailTemplateDefinitions

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Respons

Returnerer: GetEmailTemplateDefinitions200Response

Eksempel

getEmailTemplateDefinitions Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_acme_001';
  const options: { includeDrafts?: boolean } = { includeDrafts: true }; // valgfrit parameter demonstreret
  const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, options);
  console.log(templates);
})();

getEmailTemplateRenderErrors

Parametre

Navn	Type	Obligatorisk
tenantId	string	Ja
id	string	Ja
skip	number	Nej

Svar

Returnerer: GetEmailTemplateRenderErrors200Response

Eksempel

getEmailTemplateRenderErrors Eksempel

Copy

const tenantId: string = 'acme-tenant-01';
const id: string = 'tmpl_7f9a2b4c';
const skip: number = 20;
const errorsWithSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
const errorsFirstPage: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id);

getEmailTemplates

Parametre

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

Svar

Returnerer: GetEmailTemplates200Response

Eksempel

getEmailTemplates Eksempel

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme-marketing-tenant-001";
  const templatesDefault: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 25);
  console.log(templatesDefault, templatesPaged);
}
run();

renderEmailTemplate

Parametre

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

Svar

Returnerer: RenderEmailTemplate200Response

Eksempel

renderEmailTemplate Eksempel

Copy

const tenantId: string = '7f7e2b90-3a2b-4d9b-9df1-5f0b6b2e8a1c';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'welcome_email',
  recipient: { email: 'jordan.smith@acme.co', name: 'Jordan Smith' },
  variables: { siteName: 'Acme Forum', verificationUrl: 'https://acme.forum/verify?code=abc123' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateEmailTemplate

Copy

const tenantId: string = 'acme-corp-123';
const id: string = 'template-789';
const locale: string | undefined = 'en-US';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  subject: 'Welcome to Acme — Get started',
  bodyHtml: '<p>Hi \{{firstName}}, welcome to Acme. Start by visiting your dashboard.</p>',
  fromName: 'Acme Support',
  fromEmail: 'support@acme.com',
  enabled: true,
  ...(locale ? { locale } : {})
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parametre

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Nej

Svar

Returnerer: GetEventLog200Response

Eksempel

getEventLog Eksempel

Copy

const tenantId: string = 'tenant_9f3a2b';
const urlId: string = 'news/2026/06/fastcomments-release';
const userIdWS: string = 'ws_user_48291';
const startTime: number = Date.now() - 86_400_000;
const endTime: number = Date.now();
const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

getGlobalEventLog

req tenantId urlId userIdWS

Parametre

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

Svar

Returnerer: GetEventLog200Response

Eksempel

getGlobalEventLog Eksempel

Copy

const tenantId: string = "tenant_639b7f12";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/important-update-987";
const userIdWS: string = "user_ws_42b7";
const startTime: number = new Date("2026-06-14T00:00:00Z").getTime();
const endTime: number = 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

createFeedPost Eksempel

Copy

const tenantId: string = 'tenant_4f2b1c';
const createFeedPostParams: CreateFeedPostParams = {
  content: 'Launching our summer collection today — check it out!',
  authorId: 'user_879',
  media: [
    {
      type: 'image',
      assets: [
        { url: 'https://cdn.myshop.com/uploads/summer-look.jpg', width: 1200, height: 800 } as FeedPostMediaItemAsset
      ]
    } as FeedPostMediaItem
  ],
  links: [
    { url: 'https://myshop.com/new-arrival', title: 'Summer Collection' } as FeedPostLink
  ],
  allowComments: true
};
const broadcastId: string = 'broadcast-2026-06-15-001';
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const response: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

createFeedPostPublic

Parametre

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

Svar

Returnerer: CreateFeedPostPublic200Response

Eksempel

createFeedPostPublic Eksempel

Copy

(async () => {
  const tenantId: string = "tenant_9f8b7c";
  const media: FeedPostMediaItem[] = [{ type: "image", assets: [{ url: "https://cdn.example.com/roadmap.jpg", mimeType: "image/jpeg" }] }];
  const links: FeedPostLink[] = [{ url: "https://company.example.com/roadmap", title: "Full roadmap" }];
  const createFeedPostParams: CreateFeedPostParams = {
    title: "Weekly Product Roadmap Update",
    body: "This week we shipped enhancements to search relevance and fixed top customer bugs.",
    authorId: "user_8321",
    media,
    links,
    visibility: "public"
  };
  const broadcastId: string = "broadcast_2026_06_15";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload";
  const response: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);
  console.log(response);
})();

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 = 'acme-tenant-42';
const postId: string = 'post_8f3d2a7c';
const broadcastId: string = 'broadcast_2026-06-15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

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 tenantId: string = "tenant_74321";
const afterId: string = "post_20250610_9b2f3";
const limit: number = 25;
const tags: Array<string> = ["product-updates", "announcements"];
const response: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

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

getFeedPostsPublic Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const afterId: string = 'post_20250610_842';
  const limit: number = 25;
  const tags: string[] = ['news', 'technology'];
  const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1Ni';
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
  console.log(response);
})();

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_98765";
const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, ssoToken);

getUserReactsPublic

Parametre

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

Svar

Returnerer: GetUserReactsPublic200Response

Eksempel

getUserReactsPublic Eksempel

Copy

const tenantId: string = 'fastcomments-tenant-4f2b9c';
const postIds: Array<string> = ['post_7a1f9e', 'post_2b3c88'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTQ0MDAwMH0.signature';
const response: 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 = 'acme-tenant-001';
const postId: string = 'feedpost_78901';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_2026_06_15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const response: 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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateFeedPost Eksempel

Copy

const tenantId: string = "tenant_72f3b4c9";
const id: string = "post_ba4f6e18-2d3c-4b7a-91f2-8c0e3a6b5d4f";
const feedPost: FeedPost = {
  title: "June feature rollout",
  body: "Announcing performance improvements and moderation updates available to all sites.",
  authorName: "Platform Team",
  mediaItems: [
    {
      type: "image",
      caption: "Release banner",
      asset: { url: "https://cdn.fastcomments.com/assets/june-banner.jpg", mimeType: "image/jpeg", width: 1200, height: 600 }
    }
  ],
  links: [{ title: "Release notes", url: "https://docs.fastcomments.com/releases/june-2026" }]
} as FeedPost;
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

Svar

Returnerer: CreateFeedPostPublic200Response

Eksempel

updateFeedPostPublic Eksempel

Copy

const tenantId: string = 'tenant_acme_01';
const postId: string = 'post_20260615_001';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Weekly Update: Product Launch',
  content: 'We shipped the 2.0 release today — highlights and links below.',
  media: [{ url: 'https://cdn.acme.com/releases/launch.jpg', type: 'image' }],
  tags: ['release', 'product'],
  isPublic: true
};
const broadcastId: string = 'broadcast_live_42';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

flagCommentPublic

Parametre

Navn	Type	Obligatorisk
tenantId	string	Ja
commentId	string	Ja
isFlagged	boolean	Ja
sso	string	Nej

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

flagCommentPublic Eksempel

Copy

const tenantId: string = "tenant_4f1b2a9c";
const commentId: string = "comment_8d3e6f12";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

getGifLarge

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
largeInternalURLSanitized	string	Ja

Svar

Returnerer: GetGifLarge200Response

Eksempel

getGifLarge Eksempel

Copy

const tenantId: string = "tenant_9f8b7c";
const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/07d3f6_large.gif";
const preferWebP: boolean | undefined = true; // valgfri præference
const urlToUse: string = preferWebP ? largeInternalURLSanitized.replace(".gif", ".webp") : largeInternalURLSanitized;
const response: GetGifLarge200Response = await getGifLarge(tenantId, urlToUse);

getGifsSearch

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
search	string	Ja
locale	string	Nej
rating	string	Nej
page	number	Nej

Svar

Returnerer: GetGifsSearch200Response

Eksempel

Eksempel på getGifsSearch

Copy

const tenantId: string = "tenant_acme_9876";
const search: string = "cat playing piano";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 1;
const result: GetGifsSearch200Response = await getGifsSearch(tenantId, search, locale, rating, page);

getGifsTrending

Parametre

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

Svar

Returnerer: GetGifsTrending200Response

Eksempel

getGifsTrending Eksempel

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_8b3f2c';
  const locale: string = 'en-US';
  const rating: string = 'pg';
  const page: number = 1;
  const result: GetGifsTrending200Response = await getGifsTrending(tenantId, locale, rating, page);
  console.log(result);
}
main();

addHashTag

Parametre

Name	Type	Required	Description
tenantId	string	Nej
createHashTagBody	CreateHashTagBody	Nej

Svar

Returnerer: AddHashTag200Response

Eksempel

addHashTag Eksempel

Copy

const tenantId: string | undefined = "tenant_3c9f7b";
const createHashTagBody: CreateHashTagBody = {
  name: "support",
  title: "Support",
  description: "Questions about product usage, bugs, and account issues",
  color: "#0066CC",
  isActive: true,
  aliases: ["help", "customer-service"]
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

addHashTagsBulk

Parametre

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

Svar

Returnerer: AddHashTagsBulk200Response

Eksempel

addHashTagsBulk Eksempel

Copy

const tenantId: string = "tenant_acme_corp_987";
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: "product-update", description: "Announcements about new product releases", visible: true },
    { name: "customer-support", description: "Customer support related discussions", visible: false }
  ],
  createdBy: "moderator_jane"
};
const resultWithTenant: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const resultWithoutTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

deleteHashTag

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteHashTag-eksempel

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_72a1";
const deleteHashTagRequest: DeleteHashTagRequest = {
  reason: "consolidate-duplicates",
  requestedBy: "moderator@dailypress.com",
  forceDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

getHashTags

Parametre

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

Svar

Returnerer: GetHashTags200Response

Eksempel

getHashTags Eksempel

Copy

const tenantId: string = 'tenant_7f4b2c3a';
const tagsFirstPage: GetHashTags200Response = await getHashTags(tenantId);
const tagsSecondPage: GetHashTags200Response = await getHashTags(tenantId, 2);
console.log(tagsFirstPage, tagsSecondPage);

patchHashTag

Parametre

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

Svar

Returnerer: PatchHashTag200Response

Eksempel

patchHashTag Eksempel

Copy

const tag: string = "feature-request";
const tenantId: string = "tenant_8f7a3b2c";
const updateHashTagBody: UpdateHashTagBody = {
  displayName: "Feature Request",
  description: "Use this tag for requests to add new features to the product",
  enabled: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parametre

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

Svar

Returnerer: CreateModerator200Response

Eksempel

Eksempel på createModerator

Copy

const tenantId: string = 'tenant_9f3b21';
const createModeratorBody: CreateModeratorBody = {
  moderator: {
    name: 'Alex Rivera',
    email: 'alex.rivera@fastcomments.io',
    role: 'global_moderator',
    enabled: true,
  },
  // valgfrie parametre demonstreret:
  notifyUser: true,
  permissions: ['delete_comment', 'edit_comment', 'ban_user'],
  customConfig: { dashboardTheme: 'dark' } as unknown as CustomConfigParameters
};
const result: 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

deleteModerator Eksempel

Copy

const tenantId: string = 'tenant_4f3b2c9a';
const id: string = 'mod_9c2d1f7b';
const sendEmail: string = 'true';
const response: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);
console.log(response);

getModerator

Parametre

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

Svar

Returnerer: GetModerator200Response

Eksempel

getModerator Eksempel

Copy

const tenantId: string = 'acme-media-58';
const id: string = 'mod-82f3b9c1';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Parametre

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

Respons

Returnerer: GetModerators200Response

Eksempel

getModerators Eksempel

Copy

const tenantId: string = 'tenant_0a1b2c3d';
const moderators: GetModerators200Response = await getModerators(tenantId);
const skip: number = 20;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

sendInvite

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på sendInvite

Copy

(async () => {
  const tenantId: string = "tenant_acme_42";
  const id: string = "cmt_8f3b21";
  const fromName: string = "Ava Thompson";
  const inviteResult: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);
  console.log(inviteResult);
})();

updateModerator

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

updateModerator Eksempel

Copy

const tenantId: string = 'acme-tenant-81';
const id: string = 'mod_7f3a2b';
const updateModeratorBody: UpdateModeratorBody = {
  email: 'j.reyes@acme-corp.com',
  displayName: 'Jordan Reyes',
  roles: ['moderator', 'content_reviewer'],
  active: true,
  notes: 'Promoted to senior moderator; monitor flagged content weekly'
};
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 tenantId: string = 'tenant_5f3d2e1b';
const id: string = 'notification_9a4b1c2';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);

getCachedNotificationCount

Parametre

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

Respons

Returnerer: GetCachedNotificationCount200Response

Eksempel

getCachedNotificationCount Eksempel

Copy

const tenantId: string = 'fastcomments-tenant-23';
const id: string = 'user_987654';
const cachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);
const maybeId: string | undefined = Math.random() > 0.5 ? 'user_123456' : undefined;
if (maybeId) {
  const optionalCachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, maybeId);
}

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_82a3b9f';
const userId: string = 'user_43721';
const urlId: string = 'https://news.example.com/articles/2026/06/15/coverage-123';
const fromCommentId: string = 'comment_98765';
const viewed: boolean = false;
const notificationType: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, notificationType);

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

Respons

Returnerer: GetNotifications200Response

Eksempel

getNotifications Eksempel

Copy

const tenantId: string = 'tenant_9f8b7c6a';
const userId: string = 'user_5a4b3c2d';
const urlId: string = 'post_84f2a1b9';
const fromCommentId: string = 'cmt_0a1b2c3d';
const viewed: boolean = false;
const type: string = 'reply';
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

updateNotification Eksempel

Copy

const tenantId: string = 'tenant_9f3b2c';
const id: string = 'notification_4a1d2e';
const updateNotificationBody: UpdateNotificationBody = {
  enabled: true,
  channels: ['email', 'push'],
  frequency: 'immediate',
  templateId: 'tmpl_77aa'
} as UpdateNotificationBody;
const userId: string = 'user_2468';
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

createV1PageReact

Parametre

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

Svar

Returnerer: CreateV1PageReact200Response

Eksempel

Eksempel på createV1PageReact

Copy

(async () => {
  const tenantId: string = 'b12f3c4d-5678-90ab-cdef-1234567890ab';
  const urlId: string = 'https://www.news-site.com/world/2026/election-results';
  const title: string = 'Election results: key takeaways and analysis';
  const responseWithTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId, title);
  const responseWithoutTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId);
  console.log(responseWithTitle, responseWithoutTitle);
})();

createV2PageReact

Parametre

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

Svar

Returnerer: CreateV2PageReact200Response

Eksempel

createV2PageReact Eksempel

Copy

const tenantId: string = "fastcomments-tenant-72";
const urlId: string = "articles/2026/06/15/product-update";
const id: string = "page-8f3b2a";
const title: string = "Product Update: June 15, 2026";
(async function run(): Promise<void> {
  const response: CreateV2PageReact200Response = await createV2PageReact(tenantId, urlId, id, title);
  console.log(response);
})();

deleteV1PageReact

Parameters

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

Response

Returnerer: DeleteV1PageReact200Response

Eksempel

Eksempel på deleteV1PageReact

Copy

const tenantId: string = process.env.TENANT_ID ?? 'd3b07384-9f6a-4c2b-8c3e-0a1b2c3d4e5f';
const urlId: string = 'https://acme.com/articles/2026/06/fastcomments-integration';
const result: DeleteV1PageReact200Response = await deleteV1PageReact(tenantId, urlId);

deleteV2PageReact

Parametre

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

Svar

Returnerer: DeleteV2PageReact200Response

Eksempel

deleteV2PageReact Eksempel

Copy

const tenantId: string = "tenant_79021";
const urlId: string = "blog/my-first-post";
const id: string = "reaction_9f8b7c";
let includeHistory: boolean | undefined = undefined; // valgfrit flag, anvendes i nogle kald
const result: DeleteV2PageReact200Response = await deleteV2PageReact(tenantId, urlId, id);
console.log(result);

getV1PageLikes

Parametre

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

Svar

Returnerer: GetV1PageLikes200Response

Eksempel

getV1PageLikes Eksempel

Copy

const tenantId: string = 'fastcomments-742';
const urlId: string = 'sports/2026/06/15/world-cup-preview';
const pageLikes: GetV1PageLikes200Response = await getV1PageLikes(tenantId, urlId);

getV2PageReacts

Parametre

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

Respons

Returnerer: GetV2PageReacts200Response

Eksempel

getV2PageReacts Eksempel

Copy

const tenantId: string = "tenant_82f4b3a9";
const urlId: string = "https://news.site.com/articles/2026/06/15/product-launch";
const response: GetV2PageReacts200Response = await getV2PageReacts(tenantId, urlId);
console.log(response);

getV2PageReactUsers

Parametre

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

Respons

Returnerer: GetV2PageReactUsers200Response

Eksempel

getV2PageReactUsers Eksempel

Copy

const tenantId: string = "7421";
const urlId: string = "sports/london-marathon";
const id: string = "reactUser-3fa85f64-5717-4562-b3fc-2c963f66afa6";
const includeDeleted: boolean | undefined = undefined; // valgfrit flag (demonstration)
const result: GetV2PageReactUsers200Response = await getV2PageReactUsers(tenantId, urlId, id);

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

getOfflineUsers

Tidligere kommentatorer på siden, som IKKE er online lige nu. Sorteret efter displayName. Brug dette efter at have udtømt /users/online for at gengive en "Medlemmer" sektion. Cursor-paginering på commenterName: serveren går igennem det delvise {tenantId, urlId, commenterName} index fra afterName fremad via $gt, uden $skip-omkostning.

Parametre

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nej
afterUserId	string	Nej

Svar

Returnerer: GetOfflineUsers200Response

Eksempel

getOfflineUsers Eksempel

Copy

const tenantId: string = 'tenant_prod_001';
const urlId: string = 'article-2026-06-15-how-ai-impacts';
const afterName: string = 'michael.smith';
const afterUserId: string = 'user_72b9';
const response: GetOfflineUsers200Response = await getOfflineUsers(tenantId, urlId, afterName, afterUserId);

getOnlineUsers

Brugere, der i øjeblikket er online på en side: personer, hvis websocket-session lige nu abonnerer på siden. Returnerer anonCount + totalCount (abonnenter for hele rummet, inklusive anonyme seere, som vi ikke opregner).

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nej
afterUserId	string	Nej

Svar

Returnerer: GetOnlineUsers200Response

Eksempel

getOnlineUsers Eksempel

Copy

const tenantId: string = 'tenant_14f9c3';
const urlId: string = 'article_20250615';
const afterName: string = 'marie.curie';
const afterUserId: string = 'u_92b7';
const result: GetOnlineUsers200Response = await getOnlineUsers(tenantId, urlId, afterName, afterUserId);

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

getPagesPublic

Lister sider for en tenant. Bruges af FChat desktop-klienten til at udfylde dens rumliste. Kræver, at enableFChat er true i den løste brugerdefinerede konfiguration for hver side. Sider, der kræver SSO, filtreres i forhold til den forespørgende brugers gruppeadgang.

Parametre

Name	Type	Required
tenantId	string	Yes
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

Respons

Returnerer: GetPagesPublic200Response

Eksempel

getPagesPublic Eksempel

Copy

const tenantId: string = 'tenant_8f3b2c';
const cursor: string = 'eyJwYWdlIjoiMTIwIn0';
const limit: number = 25;
const q: string = 'homepage hero';
const hasComments: boolean = true;
const response: GetPagesPublic200Response = await getPagesPublic(
  tenantId,
  cursor,
  limit,
  q,
  undefined,
  hasComments
);

getUsersInfo

Bulk brugerinformation for en tenant. Givet userIds, returner visningsoplysninger fra User / SSOUser. Bruges af kommentar-widgeten til at berige brugere, der lige er dukket op via en presence-begivenhed. Ingen sidekontekst: privatliv håndhæves ensartet (private profiler maskeres).

Parametre

Name	Type	Required	Description
tenantId	string	Ja
ids	string	Ja

Respons

Returnerer: GetUsersInfo200Response

Eksempel

getUsersInfo Eksempel

Copy

const tenantId: string = 'acme-tenant-007';
const userIdsList: string[] = ['user_12a', 'user_34b', 'user_56c'];
const separator: string | undefined = undefined; // optional; if undefined default to comma
const ids: string = userIdsList.join(separator ?? ',');
const usersInfo: GetUsersInfo200Response = await getUsersInfo(tenantId, ids);

patchPage

Parametre

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

Svar

Returnerer: PatchPageAPIResponse

deletePendingWebhookEvent

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deletePendingWebhookEvent Eksempel

Copy

const tenantId: string = "tenant_5f8d7a34";
const id: string = "webhook_evt_987654321";
const requestNote: string | undefined = undefined;
const response: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);

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_9f8b3b';
const commentId: string = 'cmt_1a2b3c';
const eventType: string = 'comment.created';
const domain: string = 'news-site.com';
const attemptCountGT: number = 2;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined, // externalId udeladt
  eventType,
  undefined, // type udeladt
  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

getPendingWebhookEvents Eksempel

Copy

const tenantId: string = 'tenant_9f3b2a';
const commentId: string = 'cmt_8a7d1';
const eventType: string = 'comment.created';
const domain: string = 'reviews.myshop.com';
const attemptCountGT: number = 1;
const skip: number = 0;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parametre

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

Svar

Returnerer: CreateQuestionConfig200Response

Eksempel

Eksempel på createQuestionConfig

Copy

const tenantId: string = "tenant_9f3b1c2a";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  name: "Product feedback",
  key: "product_quality",
  description: "Short survey question shown after posting a comment",
  required: true,
  renderingType: "singleChoice",
  customOptions: [
    { label: "Excellent", value: "5" },
    { label: "Good", value: "4" },
    { label: "Fair", value: "3" }
  ] as QuestionConfigCustomOptionsInner[],
  notifyModerators: false // valgfrit parameter demonstreret
};
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

Eksempel på deleteQuestionConfig

Copy

const tenantId: string = 'acme-corp-47a9';
const id: string = 'qcfg_20260615_001';
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

getQuestionConfig

Parametre

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

Svar

Returnerer: GetQuestionConfig200Response

Eksempel

Eksempel på getQuestionConfig

Copy

const tenantId: string = "acme-corp-47";
const questionId: string = "q-4f2b9a";
const includeDrafts: boolean | undefined = undefined; // pladsholder for valgfri parameter
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
console.log(result);

getQuestionConfigs

Parametre

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

Svar

Returnerer: GetQuestionConfigs200Response

Eksempel

Eksempel på getQuestionConfigs

Copy

const tenantId: string = "tenant_4c9f2b";
const responseWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const skip: number = 50;
const responseWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, skip);

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_9f3b8a2e-4c6d-4b4f-a1b2-9e8f7d6c5b3a";
const id: string = "q_7c2e1b4a-5d6f-4a8b-9c3d-2e1f0b9a4c5d";
const options: QuestionConfigCustomOptionsInner[] = [
  { value: "1", label: "Very dissatisfied" },
  { value: "2", label: "Dissatisfied" },
  { value: "3", label: "Neutral" },
  { value: "4", label: "Satisfied" },
  { value: "5", label: "Very satisfied" }
];
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  label: "How satisfied are you with the article?",
  enabled: true,
  required: false, // valgfrit parameter demonstreret
  options
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parametre

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

Svar

Returnerer: CreateQuestionResult200Response

Eksempel

Eksempel på createQuestionResult

Copy

const tenantId: string = 'fc-tenant-512';
const meta: MetaItem[] = [{ key: 'source', value: 'article' }];
const body: CreateQuestionResultBody = {
  questionId: 'q-94',
  userId: 'user_332',
  answers: [{ optionId: 'opt_a', score: 1 }],
  meta, // valgfri metadata angivet
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, body);

deleteQuestionResult

Parametre

Name	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteQuestionResult Eksempel

Copy

const tenantId: string = "acme-corp-tenant-01";
const id: string = "qres_9f8b7c3a";
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);
const optionalResponse: FlagCommentPublic200Response | undefined = response;

getQuestionResult

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Svar

Returnerer: GetQuestionResult200Response

Eksempel

getQuestionResult Eksempel

Copy

const tenantId: string = 'tenant_9f3b2a7c9';
const questionId: string = 'q_8d4f1b2c3a';
const options: { includeMeta?: boolean } = { includeMeta: true }; // eksempel på valgfri parameter
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
const apiStatus: APIStatus | undefined = (result as unknown as { apiStatus?: APIStatus }).apiStatus;
const question: QuestionResult | undefined = (result as unknown as { question?: QuestionResult }).question;

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 = 'fc-tenant-7a9c';
const urlId: string = 'news/article-2026-06-15';
const userId: string = 'user-8421';
const startDate: string = '2026-05-01T00:00:00Z';
const questionId: string = 'q-13';
const questionIds: string = 'q-13,q-14';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

updateQuestionResult

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateQuestionResult

Copy

const tenantId: string = "tenant_prod_84b2";
const id: string = "question_9f3a";
const updateQuestionResultBody: UpdateQuestionResultBody = {
  outcome: "accepted",
  confidence: 0.88,
  moderatorId: "moderator_17",
  notes: "Validated by automated review" // valgfrit felt inkluderet
};
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parametre

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

Svar

Returnerer: AggregateQuestionResults200Response

Eksempel

aggregateQuestionResults Eksempel

Copy

const tenantId: string = 'tenant_6f2b3c';
const questionIds: Array<string> = ['q-7a1b2c', 'q-8d3e4f'];
const urlId: string = 'url_9f8e7d';
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, urlId, undefined, startDate, true);

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_0012";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: "quality_score",
      startTime: "2026-06-01T00:00:00Z",
      endTime: "2026-06-14T00:00:00Z",
      timeBucket: "day",
      dimensions: ["threadId"]
    }
  ],
  includeTotals: true
};
const forceRecalculate: boolean = false;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

combineCommentsWithQuestionResults

Parametre

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

Respons

Returnerer: CombineCommentsWithQuestionResults200Response

Eksempel

combineCommentsWithQuestionResults Eksempel

Copy

const tenantId: string = 'tenant_12345';
const questionId: string = 'q_98765';
const questionIds: string[] = ['q_98765', 'q_12345'];
const urlId: string = 'url_abc123';
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 0;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  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

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

Respons

Returnerer: PutSSOUserAPIResponse

Eksempel

putSSOUser Eksempel

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

createSubscription

Parametre

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

Svar

Returnerer: CreateSubscriptionAPIResponse

Eksempel

createSubscription Eksempel

Copy

const tenantId: string = "acme-corp-tenant-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_98765",
  planId: "pro_monthly",
  paymentMethod: { type: "card", cardId: "card_abc123" },
  autoRenew: true,
  trialDays: 14, // valgfrit parameter demonstreret
  metadata: { campaign: "spring_launch" } // valgfrit parameter demonstreret
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

deleteSubscription

Parametre

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

Svar

Returnerer: DeleteSubscriptionAPIResponse

getSubscriptions

Parametre

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

Svar

Returnerer: GetSubscriptionsAPIResponse

Eksempel

getSubscriptions Eksempel

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

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	Required
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_7a3c2e';
const dailyUsages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, 2026, 6, undefined, 0);

createTenantPackage

Parametre

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

Svar

Returnerer: CreateTenantPackage200Response

Eksempel

createTenantPackage Eksempel

Copy

const tenantId: string = "tenant_7890";
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Growth Plan",
  maxSeats: 2500,
  features: {
    moderation: true,
    analytics: true,
    sso: { enabled: true, provider: "saml" }
  },
  billing: { interval: "monthly", priceCents: 19900 },
  // valgfri parameter demonstreret: notes er ikke påkrævet, men er angivet
  notes: "Onboarding bundle with priority support"
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

deleteTenantPackage

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

deleteTenantPackage Eksempel

Copy

const tenantId: string = 'acme-corp-tenant-01';
const packageId: string = 'pkg-2026-06-15-001';
const dryRun: boolean | undefined = undefined; // valgfrit flag-eksempel (ikke krævet af funktionen)
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parametre

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

Svar

Returnerer: GetTenantPackage200Response

Eksempel

getTenantPackage Eksempel

Copy

const tenantId: string = 'tenant_4b8c2a9f';
const packageId: string = 'pkg_7d3e1b5c';
const includeMetadata: boolean | undefined = true;
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parametre

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

Svar

Returnerer: GetTenantPackages200Response

Eksempel

getTenantPackages Eksempel

Copy

const tenantId: string = 'tenant_8421';
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, 25);
const packagesWithoutSkip: GetTenantPackages200Response = await getTenantPackages(tenantId);

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 = "fastcomments-tenant-114";
const id: string = "pkg-enterprise-2026-06";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: "EnterpriseModeration",
  version: "2.4.7",
  enabled: true,
  apiStatus: { state: "active", lastUpdated: "2026-06-10T12:00:00Z" },
  customConfigParameters: { maxCommentLength: 1200, allowImages: true }, // valgfrie indstillinger inkluderet
  voteStyle: { style: "updown" }
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

updateTenantPackage

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateTenantPackage

Copy

const tenantId: string = 'tenant_9f3b2a';
const id: string = 'pkg_pro_2026';
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Pro Plan',
  monthlyPriceUsd: 49,
  isActive: true,
  features: ['moderation', 'analytics', 'sso'],
  trialDays: 14 // valgfri parameter demonstreret
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parametre

Name	Type	Required	Description
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Ja

Svar

Returnerer: CreateTenantUser200Response

Eksempel

createTenantUser Eksempel

Copy

const tenantId: string = "tenant_7f4a2b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "commenter",
  approved: true,
  displayName: "Jane D." // valgfrit: angiv et venligt navn
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
console.log(result);

deleteTenantUser

Parametre

Name	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 = "tenant_8f3a2b1c4d";
const id: string = "user_62a4f9e0b7";
const deleteComments: string = "true";
const commentDeleteMode: string = "permanent";
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

getTenantUser

Parametre

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

Svar

Returnerer: GetTenantUser200Response

Eksempel

getTenantUser Eksempel

Copy

const tenantId: string = 'tenant_ab12c3';
const id: string = 'user_9f8e7d';
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log(response);

getTenantUsers

Parametre

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

Respons

Returnerer: GetTenantUsers200Response

Eksempel

getTenantUsers Eksempel

Copy

const tenantId: string = 'tenant_7b8f3a2c-9e4d-4f1a';
const skip: number = 50;
const usersResponseDefault: GetTenantUsers200Response = await getTenantUsers(tenantId);
const usersResponsePaged: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

replaceTenantUser

Parametre

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

Respons

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på replaceTenantUser

Copy

const tenantId: string = "f3b9a2d1-8b4e-4c6a-9f2b-1d5c4e6a7b8c";
const id: string = "user_92f7c3b1";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: "auth0|1234567890",
  email: "jane.doe@company.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  metadata: { department: "support" }
};
const updateComments: string = "reassign-comments-to-new-user";
const response: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parametre

Name	Type	Required
tenantId	string	Yes
id	string	Yes
redirectURL	string	No

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på sendLoginLink

Copy

const tenantId: string = "tenant_0a1b2c3d";
const id: string = "user_984321";
const redirectURL: string = "https://app.acme-corp.com/welcome";
const responseWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
const responseWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);

updateTenantUser

Parametre

Name	Type	Påkrævet
tenantId	string	Yes
id	string	Yes
updateTenantUserBody	UpdateTenantUserBody	Yes
updateComments	string	No

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

Eksempel på updateTenantUser

Copy

const tenantId: string = 'acme-corp';
const userId: string = 'u_72b9f4';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  suspended: false
};
const updateComments: string = 'Promoted to moderator after review of activity and community feedback';
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, userId, updateTenantUserBody, updateComments);

createTenant

Parametre

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

Svar

Returnerer: CreateTenant200Response

Eksempel

createTenant-eksempel

Copy

const tenantId: string = 'acme-news-01';
const createTenantBody: CreateTenantBody = {
  name: 'Acme News',
  domainConfiguration: { primaryDomain: 'news.acme.com', redirectHttps: true } as APIDomainConfiguration,
  importedSites: [{ siteId: 'site-92', url: 'https://news.acme.com' }] as ImportedSiteType[],
  billingInfo: { planId: 'business_monthly', contactEmail: 'billing@acme.com' } as BillingInfo
};
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_742b9c';
const flagId: string = 'flag_1a2b3c';
const resultWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId);
const sureConfirmation: string = 'confirmed';
const resultWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId, sureConfirmation);

getTenant

Parametre

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

Svar

Returnerer: GetTenant200Response

Eksempel

getTenant Eksempel

Copy

const tenantId: string = 'fc_tenant_6b3e2a';
const id: string = 'site_42f1';
const tenantResponse: GetTenant200Response = await getTenant(tenantId, id);
const tenant: APITenant | undefined = tenantResponse.tenant;
const primaryDomain: APIDomainConfiguration | undefined = tenant?.domainConfiguration?.[0];

getTenants

Parametre

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

Svar

Returnerer: GetTenants200Response

Eksempel

getTenants Eksempel

Copy

const tenantId: string = "fcom-tenant-8b4f2a1c";
const meta: string = "include=domains,billing&status=active";
const skip: number = 20;
const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
console.log(response);

updateTenant

Parametre

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

Svar

Returnerer: FlagCommentPublic200Response

Eksempel

updateTenant-eksempel

Copy

const tenantId: string = 'tenant_84f12';
const id: string = 'flag_192b';
const updateTenantBody: UpdateTenantBody = {
  name: 'Acme Media',
  billingInfo: { plan: 'enterprise', seats: 25, nextBillingDate: '2026-07-01' },
  apiDomainConfiguration: { primaryDomain: 'comments.acme.com', additionalDomains: ['acme.com'] },
  importedSites: [{ siteUrl: 'https://blog.acme.com', archived: false }], // valgfri
  commentSettings: { htmlRenderingMode: 'sanitized', deletionMode: 'soft' } // valgfri
} as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parametre

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

Svar

Returnerer: ChangeTicketState200Response

Eksempel

changeTicketState Eksempel

Copy

const tenantId: string = 'tenant_8a7d3f4b';
const userId: string = 'user_5d1a9b2c';
const id: string = 'ticket_1024';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'closed',
  notifyParticipants: true, // valgfri parameter demonstreret
  comment: 'Resolved by support — follow-up not required.'
};
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 = 'tenant_acme_corp';
const userId: string = 'moderator_jane';
const createTicketBody: CreateTicketBody = {
  subject: 'Mass spam reports on article 789',
  description: 'Multiple identical spam comments posted under article 789. Needs moderation and bulk removal.',
  priority: 'high',
  contactEmail: 'jane@acme-corp.com',
  metadata: { articleId: '789', reportedCount: 12 } // optional metadata demonstrated
};
const ticket: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

getTicket

Parametre

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

Respons

Returnerer: GetTicket200Response

Eksempel

getTicket-eksempel

Copy

const tenantId: string = 'acme-corp';
const ticketId: string = 'TCKT-20250615-42';
const userId: string = 'user_84b2';
const ticketWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);
console.log(ticketWithUser.id, ticketWithoutUser.id);

getTickets

Parametre

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

Response

Returnerer: GetTickets200Response

Eksempel

getTickets Eksempel

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_87b3';
const state: number = 2;
const skip: number = 0;
const limit: number = 50;
const tickets: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);

getTranslations

Parametre

Navn	Type	Påkrævet
namespace	string	Ja
component	string	Ja
locale	string	Nej
useFullTranslationIds	boolean	Nej

Svar

Returnerer: GetTranslations200Response

Eksempel

getTranslations Eksempel

Copy

const namespaceName: string = 'site-ui';
const componentName: string = 'comment-widget';
const locale: string = 'fr-FR';
const useFullTranslationIds: boolean = true;
const translationsWithLocale: GetTranslations200Response = await getTranslations(namespaceName, componentName, locale, useFullTranslationIds);
const translationsDefault: GetTranslations200Response = await getTranslations(namespaceName, componentName);

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

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Svar

Returnerer: GetUserBadgeProgressById200Response

Eksempel

Eksempel på getUserBadgeProgressById

Copy

const tenantId: string = 'fastcomments-tenant-241';
const badgeId: string = 'user-78b3d-badge-3';
const response: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, badgeId);
const progress: UserBadgeProgress | undefined = (response as unknown as { progress?: UserBadgeProgress }).progress;
const percentComplete: number | undefined = progress?.percentage;
console.log('Badge progress percent complete:', percentComplete);

getUserBadgeProgressByUserId

Parametre

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

Svar

Returnerer: GetUserBadgeProgressById200Response

Eksempel

getUserBadgeProgressByUserId Eksempel

Copy

const tenantId: string = 'acme-inc-tenant-01';
const userId: string = 'user_73c9b2';
const progress: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
async function maybeFetchProgress(tenant: string, user?: string): Promise<GetUserBadgeProgressById200Response | null> {
  if (!user) return null;
  return await getUserBadgeProgressByUserId(tenant, user);
}
const optionalResult: GetUserBadgeProgressById200Response | null = await maybeFetchProgress(tenantId, userId);

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

const tenantId: string = 'tenant_4f3a2b9c';
const userId: string = 'user_7721d';
const limit: number = 20;
const skip: number = 0;
const result: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);

createUserBadge

Parametre

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

Respons

Returnerer: CreateUserBadge200Response

Eksempel

createUserBadge Eksempel

Copy

const tenantId: string = "tenant_7f4b2a";
const createUserBadgeParams: CreateUserBadgeParams = {
  code: "top_contributor",
  title: "Top Contributor",
  description: "Awarded for 100 high-quality comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top_contributor.svg",
  isActive: true,
  criteria: { commentsRequired: 100 },
  customConfig: { displayOnProfile: true } // Eksempel på valgfrit parameter
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

deleteUserBadge

Parametre

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

Svar

Returnerer: UpdateUserBadge200Response

Eksempel

Eksempel på deleteUserBadge

Copy

const tenantId: string = "tenant_8b3f2c7a";
const badgeIdOptional: string | undefined = Math.random() > 0.5 ? "badge_4f9a21" : undefined;
const id: string = badgeIdOptional ?? "badge_backup_01";
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Parametre

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

Respons

Returnerer: GetUserBadge200Response

Eksempel

getUserBadge Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_6b8f2a1c';
  const id: string = 'badge_9f3d4b2a';
  const response: GetUserBadge200Response = await getUserBadge(tenantId, id);
  const badge: UserBadge | undefined = response.userBadge;
  const badgeName: string | undefined = badge?.name;
  console.log('Retrieved badge name:', badgeName);
})();

getUserBadges

Parametre

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

Svar

Returnerer: GetUserBadges200Response

Eksempel

Eksempel på getUserBadges

Copy

const tenantId: string = 'tenant_7f9a12';
const userId: string = 'user_42b7';
const badgeId: string = 'badge_top_contributor';
const type: number = 2;
const displayedOnComments: boolean = true;
const limit: number = 25;
const skip: number = 0;
const badges: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Parametre

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

Svar

Returnerer: UpdateUserBadge200Response

Eksempel

updateUserBadge Eksempel

Copy

const tenantId: string = "tenant_9a8b7c";
const id: string = "badge_a1b2c3";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  title: "Community Helper",
  description: "Awarded for providing 50 helpful answers",
  iconUrl: "https://cdn.fastcomments.com/badges/community-helper.png",
  isActive: true,
  expiryDate: undefined
};
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

getUserNotificationCount

Parametre

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

Svar

Returnerer: GetUserNotificationCount200Response

Eksempel

getUserNotificationCount Eksempel

Copy

const tenantId: string = 'tenant_acme_01';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const notificationCountNoSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const notificationCountWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);

getUserNotifications

Parametre

Name	Type	Required
tenantId	string	Ja
urlId	string	Nej
pageSize	number	Nej
afterId	string	Nej
includeContext	boolean	Nej
afterCreatedAt	number	Nej
unreadOnly	boolean	Nej
dmOnly	boolean	Nej
noDm	boolean	Nej
includeTranslations	boolean	Nej
includeTenantNotifications	boolean	Nej
sso	string	Nej

Svar

Returnerer: GetUserNotifications200Response

Eksempel

getUserNotifications Eksempel

Copy

const tenantId: string = "tenant_8271";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/ai-updates";
const pageSize: number = 25;
const afterId: string = "notif_abc123";
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 86_400_000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const includeTenantNotifications: boolean = true;
const sso: string = "sso_token_xyz_987";
const notifications: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  urlId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  includeTenantNotifications,
  sso
);

resetUserNotificationCount

Parametre

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

Svar

Returnerer: ResetUserNotifications200Response

Eksempel

Eksempel på resetUserNotificationCount

Copy

const tenantId: string = "tenant_8a3f2b6c";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyX2QxMjM0IiwiaWF0IjoxNjI1MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resetResponseWithSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
const resetResponseWithoutSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);

resetUserNotifications

Parametre

Name	Type	Required
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_9b1f2";
const afterId: string = "notification_0001";
const afterCreatedAt: number = Date.now() - 60 * 60 * 1000; // en time siden
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = "sso_session_7f2d";
const result: ResetUserNotifications200Response = await resetUserNotifications(
  tenantId,
  afterId,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  sso
);

updateUserNotificationCommentSubscriptionStatus

Aktiver eller deaktiver notifikationer for en specifik kommentar.

Parametre

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

Svar

Returnerer: UpdateUserNotificationStatus200Response

Eksempel

updateUserNotificationCommentSubscriptionStatus Eksempel

Copy

const tenantId: string = 'f3a9c8b0-4d2e-4f8a-9c3b-1234567890ab';
const notificationId: string = '62a1f4d2-8c7b-4e1a-aaa1-abcdef123456';
const commentId: string = '7e4a2b1c-1234-5678-90ab-cdef12345678';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptedIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

updateUserNotificationPageSubscriptionStatus

Aktiver eller deaktiver notifikationer for en side. Når brugere abonnerer på en side, oprettes notifikationer for nye root-kommentarer, og også

Parametre

Navn	Type	Krævet
tenantId	string	Ja
urlId	string	Ja
url	string	Ja
pageTitle	string	Ja
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Ja
sso	string	Nej

Svar

Returnerer: UpdateUserNotificationStatus200Response

Eksempel

updateUserNotificationPageSubscriptionStatus Eksempel

Copy

const tenantId: string = 'tenant_7f3b2';
const urlId: string = 'article_987';
const url: string = 'https://www.news-site.com/articles/2026/pasta-guide';
const pageTitle: string = 'The Definitive Guide to Cooking Pasta';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso-token-62b9f1';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

updateUserNotificationStatus

Parametre

Name	Type	Required
tenantId	string	Ja
notificationId	string	Ja
newStatus	UpdateUserNotificationStatusNewStatusEnum	Ja
sso	string	Nej

Svar

Returnerer: UpdateUserNotificationStatus200Response

Eksempel

Eksempel på updateUserNotificationStatus

Copy

const tenantId: string = 'tenant_5f2a8b9c';
const notificationId: string = 'notif_987654321';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature';
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

Svar

Returnerer: GetUserPresenceStatuses200Response

Eksempel

getUserPresenceStatuses Eksempel

Copy

const tenantId: string = 'tenant_42';
const urlIdWS: string = 'wss://comments.fastsite.com/ws/tenant_42';
const userIds: string = 'user_9012,user_3478';
const includePresenceMetadata: boolean | undefined = true; // eksempel på en valgfri parameter
const presenceStatuses: 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_7890';
const urlId: string = 'news/2026-06-15-world-cup-final';
const usernameStartsWith: string = 'mar';
const mentionGroupIds: string[] = ['staff', 'trusted-commenters'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0NTY3OCJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Commenters;
const response: 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

Eksempel på getUser

Copy

const tenantId: string = 'fastcomments_corp';
const id: string = 'user_9f8b7c6d-5e4a-3b2c-1f0e-123456789abc';
const response: GetUser200Response = await getUser(tenantId, id);
const userEmail: string | undefined = response.user?.email;
const displayName: string | undefined = response.user?.displayName

createVote

Parametre

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

Respons

Returnerer: VoteComment200Response

Eksempel

createVote Eksempel

Copy

const tenantId: string = 'fastcomments-tenant-001';
const commentId: string = 'cmt_8f3b2a9d';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const userId: string = 'user_5021';
const anonUserId: string = 'anon_7a9c';
const voteResponse: VoteComment200Response = await createVote(tenantId, commentId, direction, userId, anonUserId);

deleteVote

Parametre

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

Respons

Returnerer: DeleteCommentVote200Response

Eksempel

deleteVote Eksempel

Copy

(async () => {
  const tenantId: string = 'tenant_8421';
  const id: string = 'vote_3f9b7c2a';
  const editKey: string = 'edit_7Xk9LpQ';
  const responseWithoutEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id);
  const responseWithEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
  console.log(responseWithoutEdit, responseWithEdit);
})();

getVotes

Parametre

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

Svar

Returnerer: GetVotes200Response

Eksempel

Eksempel på getVotes

Copy

const tenantId: string = 'tenant_7f8e91c2';
const urlId: string = 'https://www.sportsdaily.com/news/2026/06/15/championship-game-recap';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
console.log(votes);

getVotesForUser

Parametre

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

Svar

Returnerer: GetVotesForUser200Response

Eksempel

getVotesForUser Eksempel

Copy

const tenantId: string = 'tenant_9b8f7c6d';
const urlId: string = 'articles/product-update-2026';
const userId: string = 'user_c12345';
const anonUserId: string = 'anon_7f4e2a';
const votes: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);

Brug for hjælp?

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

Bidrag

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

Sprog 🇩🇰 Dansk

Kom godt i gang

API-reference

Dokumentation

Brug

Aggregering

Revisionslog

Bloker fra kommentar

Kontroller blokerede kommentarer

Kommentarer

Kommentarer for bruger

Domænekonfigurationer

E-mail-skabeloner

Hændelseslog

Feedindlæg

Marker kommentar

GIFs

Hashtags

Moderatorer

Notifikationstælling

Notifikationer

Side-reaktioner

Sider

Ventende webhook-hændelser

Spørgsmålsindstillinger

Spørgsmålsresultater

Aggregering af spørgsmålsresultater

SSO-brugere

Abonnementer

Lejers daglige forbrug

Lejerpakker

Lejerbrugere

Lejere

Billetter

Oversættelser

Upload billede

Brugerbadge-fremgang

Brugerbadges

Brugernotifikationer

Brugertilstedeværelsesstatus

Søgning efter brugere

Brugere

Stemmer

FastComments JavaScript/TypeScript SDK

Arkiv

Installation

API Documentation

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

Browser vs Server Compatibility

Usage

Browserbrug (klientside)

Serverbrug (Node.js)

Kun typer-import

Brug af individuelle API-klasser

Browsermiljø

Servermiljø

Public vs Secured APIs

Eksempel: Brug af Public API (browser-sikkert)

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

SSO (Single Sign-On) Integration

Simpelt SSO (Kun server-side)

Sikkert SSO (Server-side, anbefalet)

Brug af SSO fra browseren (med servergenereret token)

SSO med kommentaroprettelse

Common Use Cases

Hent kommentarer for en side

Oprettelse af en kommentar

Stem på en kommentar

Brugeradministration (Kræver API-nøgle)

Live Events (Real-time Updates)

Begivenheder på sideniveau

Abonner på brugerbegivenheder

Sådan får du userIdWS

Broadcast IDs

Error Handling

aggregate

Parametre

Svar

Eksempel

getAuditLogs