FastComments JavaScript/TypeScript SDK

To je uradni JavaScript/TypeScript SDK za FastComments.

Uradni JavaScript/TypeScript SDK za FastComments API

Repository

Installation

npm install fastcomments-sdk

API Documentation

Popolna referenca API: docs/api/README.md

Browser vs Server Compatibility

Ta SDK uporablja dvojne vstopne točke za zagotavljanje optimalne združljivosti in preprečevanje napak med izvajanjem:

fastcomments-sdk/browser - Različica varna za brskalnik z nativnim fetch
fastcomments-sdk/server - Polna Node.js različica s podporo za SSO
fastcomments-sdk (privzeto) - Samo tipi, varno za uvoz kjerkoli

Usage

Ta SDK zagotavlja ločene vstopne točke za brskalniška in strežniška okolja, da se zagotovi optimalna združljivost in varnost:

Uporaba v brskalniku (na strani odjemalca)

Za brskalniške/frontend aplikacije uporabite izvoz, varen za brskalnik, ki izključuje odvisnosti Node.js:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Uporaba na strežniku (Node.js)

Za strežniške/backend aplikacije uporabite celoten SDK z SSO in funkcijami za preverjanje pristnosti:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Uvoz samo tipov

Če potrebujete samo TypeScript tipe (brez kode v času izvajanja), uporabite privzeti uvoz:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Uporaba posameznih razredov API

Brskalniško okolje

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

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

const publicApi = new PublicApi(config);

Strežniško okolje

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 zagotavlja tri glavne razrede API:

DefaultApi - Zavarovani končni točki, ki zahtevata vaš API ključ za avtentikacijo. Uporabite jih za operacije na strežniški strani.
PublicApi - Javne končne točke, do katerih je mogoče dostopati brez API ključa. Klice lahko pošljete neposredno iz brskalnikov/mobilnih naprav/itd.
HiddenApi - Notranje/skrbniške končne točke za napredne primere uporabe.

Primer: Uporaba javnega API-ja (varno za brskalnik)

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

const publicApi = new PublicApi();

// Pridobi komentarje za stran (API ključ ni potreben)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Primer: Uporaba privzetega API-ja (samo na strežniku)

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

const config = new Configuration({
  apiKey: 'your-api-key' // To naj ostane skrivnost!
});
const defaultApi = new DefaultApi(config);

// Pridobi komentarje s popolnim skrbniškim dostopom
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On) Integration

FastComments podpira SSO za integracijo z vašim obstoječim sistemom za preverjanje pristnosti uporabnikov. Funkcionalnost SSO je na voljo le v strežniškem izvozu saj zahteva Node.js kriptografske funkcije.

Preprosto SSO (samo strežniško)

Preprosto SSO je treba generirati na strežniku in poslati odjemalcu:

// Strežniška koda (Node.js/strežnik)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Ustvari preprosto SSO z vgrajenim pripomočkom  
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();

// Pošlji ssoToken vaši odjemalski kodi
// Odjemalska koda lahko nato uporabi ta žeton z brskalniškim SDK-jem

Varen SSO (strežniško, priporočeno)

Varen SSO je treba implementirati na strežniku in nudi boljšo varnost:

// Strežniška koda (Node.js/strežnik)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Ustvari varen SSO z vgrajenim pripomočkom
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();

// Uporabi z API klici na strežniku
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Ali pošlji ssoConfig odjemalcu za uporabo v brskalniku

Uporaba SSO iz brskalnika (z žetonom, ustvarjenim na strežniku)

// Odjemalska koda (brskalnik)
import { PublicApi } from 'fastcomments-sdk/browser';

// Pridobi SSO žeton iz vašega strežniškega končnega mesta
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 // Uporabi strežniško ustvarjen SSO žeton
});

SSO z ustvarjanjem komentarja

// Strežniško: ustvari SSO in komentar
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

Pridobivanje komentarjev za stran

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

Ustvarjanje komentarja

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

Glasovanje za komentar

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

Upravljanje uporabnikov (zahteva API ključ)

// Iskanje uporabnikov (zahteva DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live Events (Real-time Updates)

Naročite se na dogodke v živo, da dobite posodobitve v realnem času za komentarje, glasove in druge dejavnosti.

Dogodki na ravni strani

Poslušajte dogodke v živo na določeni strani (komentarji, glasovi itd.):

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

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

// Naroči se na dogodke v živo za stran
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (pridobite ga iz odgovora getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Posodobite svoj uporabniški vmesnik z novim komentarjem
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Posodobite število glasov v vašem uporabniškem vmesniku
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Vrni true, če je bil dogodek obdelan
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Zaprite naročnino, ko končate
subscription.close();

Naročite se na uporabniške dogodke

Poslušajte dogodke, ki so specifični za uporabnika (obvestila, omembe itd.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Pridobite to iz odgovora getComments
};

// Naročite se na osebni vir uporabnika
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Prikažite obvestilo v vašem uporabniškem vmesniku
        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');
  }
);

// Zaprite, ko končate
userSubscription.close();

Pridobivanje userIdWS

Parameter userIdWS je obvezen za dogodke v živo in ga je mogoče pridobiti iz odgovorov API-ja:

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

// Izvlecite userIdWS iz odgovora
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Zdaj se lahko naročite na dogodke v živo
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast IDs

Videli boste, da naj bi pri nekaterih klicih API posredovali broadcastId. Ko prejmete dogodke, boste to ID prejeli nazaj, tako da boste vedeli, da dogodek prezrete, če nameravate optimistično uporabiti spremembe na odjemalcu (kar boste verjetno želeli storiti, saj ponuja najboljšo izkušnjo). Tukaj posredujte UUID. ID naj bo dovolj edinstven, da se v isti brskalni seji ne pojavi dvakrat.

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() // Edinstven ID za to operacijo
  }
});

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

Združuje dokumente z njihovo grupiranjem (če je podan groupBy) in izvajanjem več operacij. Podprte so različne operacije (npr. sum, countDistinct, avg itd.).

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
aggregationRequest	AggregationRequest	Da
parentTenantId	string	Ne
includeStats	boolean	Ne

Odgovor

Vrne: AggregationResponse

getAuditLogs

Parametri

Name	Tip	Obvezno
tenantId	string	Da
limit	number	Ne
skip	number	Ne
order	SORTDIR	Ne
after	number	Ne
before	number	Ne

Odgovor

Vrne: GetAuditLogs200Response

Primer

Primer getAuditLogs

Copy

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

blockFromCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
publicBlockFromCommentParams	PublicBlockFromCommentParams	Da
sso	string	Ne

Odgovor

Vrne: BlockFromCommentPublic200Response

Primer

Primer blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
publicBlockFromCommentParams	PublicBlockFromCommentParams	Da
sso	string	Ne

Odziv

Vrne: UnBlockCommentPublic200Response

Primer

Primer unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentIds	string	Da
sso	string	Ne

Odgovor

Vrne: CheckedCommentsForBlocked200Response

Primer

Primer checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
blockFromCommentParams	BlockFromCommentParams	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: BlockFromCommentPublic200Response

Primer

Primer blockUserFromComment

Copy

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

createCommentPublic

Parametri

Name	Type	Obvezno
tenantId	string	Da
urlId	string	Da
broadcastId	string	Da
commentData	CommentData	Da
sessionId	string	Ne
sso	string	Ne

Odgovor

Vrne: CreateCommentPublic200Response

Primer

Primer createCommentPublic

Copy

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

deleteComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
contextUserId	string	Ne
isLive	boolean	Ne

Odgovor

Vrne: DeleteComment200Response

Primer

Primer za deleteComment

Copy

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

deleteCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Da
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: DeleteCommentPublic200Response

Primer

Primer deleteCommentPublic

Copy

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

deleteCommentVote

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
voteId	string	Da
urlId	string	Da
broadcastId	string	Da
editKey	string	Ne
sso	string	Ne

Response

Vrne: DeleteCommentVote200Response

Primer

Primer deleteCommentVote

Copy

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

flagComment

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: FlagComment200Response

Primer

Primer flagComment

Copy

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

getComment

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odziv

Vrne: GetComment200Response

Primer

Primer getComment

Copy

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

getComments

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
page	number	Ne
limit	number	Ne
skip	number	Ne
asTree	boolean	Ne
skipChildren	number	Ne
limitChildren	number	Ne
maxTreeDepth	number	Ne
urlId	string	Ne
userId	string	Ne
anonUserId	string	Ne
contextUserId	string	Ne
hashTag	string	Ne
parentId	string	Ne
direction	SortDirections	Ne

Odgovor

Vrača: GetComments200Response

Primer

Primer uporabe getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // stran
  20, // omejitev
  0, // preskoči
  true, // kot drevo
  1, // preskoči podrejene
  3, // omeji podrejene
  4, // največja globina drevesa
  'articles/2026/new-product-launch', // urlId
  'user_7890', // userId
  'anon_4f3b2', // anonUserId
  undefined, // contextUserId
  '#launch', // hashTag
  undefined // parentId
);

getCommentsPublic

req tenantId urlId

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
page	number	Ne
direction	SortDirections	Ne
sso	string	Ne
skip	number	Ne
skipChildren	number	Ne
limit	number	Ne
limitChildren	number	Ne
countChildren	boolean	Ne
fetchPageForCommentId	string	Ne
includeConfig	boolean	Ne
countAll	boolean	Ne
includei10n	boolean	Ne
locale	string	Ne
modules	string	Ne
isCrawler	boolean	Ne
includeNotificationCount	boolean	Ne
asTree	boolean	Ne
maxTreeDepth	number	Ne
useFullTranslationIds	boolean	Ne
parentId	string	Ne
searchText	string	Ne
hashTags	Array	Ne
userId	string	Ne
customConfigStr	string	Ne
afterCommentId	string	Ne
beforeCommentId	string	Ne

Odgovor

Vrača: GetCommentsPublic200Response

Primer

Primer getCommentsPublic

Copy

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

getCommentText

Parametri

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

Odgovor

Vrne: GetCommentText200Response

Primer

Primer getCommentText

Copy

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

getCommentVoteUserNames

Parametri

Ime	Type	Zahtevano
tenantId	string	Da
commentId	string	Da
dir	number	Da
sso	string	Ne

Odgovor

Vrne: GetCommentVoteUserNames200Response

Primer

Primer getCommentVoteUserNames

Copy

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

lockComment

Parametri

Name	Type	Required
tenantId	string	Da
commentId	string	Da
broadcastId	string	Da
sso	string	Ne

Odgovor

Vrne: LockComment200Response

Primer

Primer lockComment

Copy

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

pinComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Da
sso	string	Ne

Odgovor

Vrne: PinComment200Response

Primer

Primer pinComment

Copy

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

saveComment

Parametri

Name	Type	Required
tenantId	string	Da
createCommentParams	CreateCommentParams	Da
isLive	boolean	Ne
doSpamCheck	boolean	Ne
sendEmails	boolean	Ne
populateNotifications	boolean	Ne

Odgovor

Vrača: SaveComment200Response

Primer

Primer saveComment

Copy

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

saveCommentsBulk

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createCommentParams	Array	Da
isLive	boolean	Ne
doSpamCheck	boolean	Ne
sendEmails	boolean	Ne
populateNotifications	boolean	Ne

Odgovor

Vrne: Array<SaveComment200Response

Primer

Primer saveCommentsBulk

Copy

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

setCommentText

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Da
commentTextUpdateRequest	CommentTextUpdateRequest	Da
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: SetCommentText200Response

Primer

Primer uporabe setCommentText

Copy

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

unBlockUserFromComment

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
unBlockFromCommentParams	UnBlockFromCommentParams	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrača: UnBlockCommentPublic200Response

Primer

Primer unBlockUserFromComment

Copy

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

unFlagComment

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrača: FlagComment200Response

Primer

Primer unFlagComment

Copy

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

unLockComment

Parametri

Name	Type	Required
tenantId	string	Da
commentId	string	Da
broadcastId	string	Da
sso	string	Ne

Odgovor

Vrne: LockComment200Response

Primer

Primer unLockComment

Copy

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

unPinComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Da
sso	string	Ne

Odgovor

Vrne: PinComment200Response

Primer

unPinComment Primer

Copy

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

updateComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updatableCommentParams	UpdatableCommentParams	Da
contextUserId	string	Ne
doSpamCheck	boolean	Ne
isLive	boolean	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateComment

Copy

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

voteComment

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
urlId	string	Da
broadcastId	string	Da
voteBodyParams	VoteBodyParams	Da
sessionId	string	Ne
sso	string	Ne

Odgovor

Vrne: VoteComment200Response

Primer

Primer voteComment

Copy

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

addDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
addDomainConfigParams	AddDomainConfigParams	Da

Odgovor

Vrača: AddDomainConfig200Response

deleteDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
domain	string	Da

Odgovor

Vrne: DeleteDomainConfig200Response

getDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
domain	string	Da

Odziv

Vrne: GetDomainConfig200Response

getDomainConfigs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrne: GetDomainConfigs200Response

patchDomainConfig

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
domainToUpdate	string	Da
patchDomainConfigParams	PatchDomainConfigParams	Da

Odgovor

Vrne: GetDomainConfig200Response

putDomainConfig

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
domainToUpdate	string	Da
updateDomainConfigParams	UpdateDomainConfigParams	Da

Odgovor

Vrne: GetDomainConfig200Response

createEmailTemplate

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createEmailTemplateBody	CreateEmailTemplateBody	Da

Odgovor

Vrne: CreateEmailTemplate200Response

Primer

Primer createEmailTemplate

Copy

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

deleteEmailTemplate

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Da

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer deleteEmailTemplate

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // primer neobveznega parametra
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
errorId	string	Da

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer deleteEmailTemplateRenderError

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // neobvezen izbirnik okolja
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

getEmailTemplate

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odziv

Vrne: GetEmailTemplate200Response

Primer

Primer getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrne: GetEmailTemplateDefinitions200Response

Primer

Primer getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
skip	number	Ne

Odgovor

Vrne: GetEmailTemplateRenderErrors200Response

Primer

Primer getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetEmailTemplates200Response

Primer

Primer getEmailTemplates

Copy

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

renderEmailTemplate

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
renderEmailTemplateBody	RenderEmailTemplateBody	Da
locale	string	Ne

Odziv

Vrne: RenderEmailTemplate200Response

Primer

Primer renderEmailTemplate

Copy

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

updateEmailTemplate

Parametri

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

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer updateEmailTemplate

Copy

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

getEventLog

zahteva tenantId urlId userIdWS

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
userIdWS	string	Da
startTime	number	Da
endTime	number	Da

Odgovor

Vrača: GetEventLog200Response

Primer

Primer getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
userIdWS	string	Da
startTime	number	Da
endTime	number	Da

Odgovor

Vrne: GetEventLog200Response

Primer

Primer getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // pred 7 dnevi
const endTimeOptional: number | undefined = undefined; // neobvezen konec časovnega okvira
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createFeedPostParams	CreateFeedPostParams	Da
broadcastId	string	Ne
isLive	boolean	Ne
doSpamCheck	boolean	Ne
skipDupCheck	boolean	Ne

Odgovor

Vrne: CreateFeedPost200Response

Primer

Primer createFeedPost

Copy

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

createFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createFeedPostParams	CreateFeedPostParams	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: CreateFeedPostPublic200Response

Primer

Primer createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrača: DeleteFeedPostPublic200Response

Primer

deleteFeedPostPublic Primer

Copy

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

getFeedPosts

req tenantId afterId

Parametri

Name	Type	Required
tenantId	string	Da
afterId	string	Ne
limit	number	Ne
tags	Array	Ne

Odgovor

Vrne: GetFeedPosts200Response

Primer

Primer getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parametri

Name	Type	Required
tenantId	string	Da
afterId	string	Ne
limit	number	Ne
tags	Array	Ne
sso	string	Ne
isCrawler	boolean	Ne
includeUserInfo	boolean	Ne

Odgovor

Vrača: GetFeedPostsPublic200Response

Primer

Primer getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postIds	Array	Da
sso	string	Ne

Odgovor

Vrne: GetFeedPostsStats200Response

Primer

Primer getFeedPostsStats

Copy

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

getUserReactsPublic

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
postIds	Array	Ne
sso	string	Ne

Odgovor

Vrne: GetUserReactsPublic200Response

Primer

Primer getUserReactsPublic

Copy

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

reactFeedPostPublic

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
postId	string	Da
reactBodyParams	ReactBodyParams	Da
isUndo	boolean	Ne
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: ReactFeedPostPublic200Response

Primer

Primer reactFeedPostPublic

Copy

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

updateFeedPost

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
feedPost	FeedPost	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

updateFeedPost Primer

Copy

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

updateFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Da
updateFeedPostParams	UpdateFeedPostParams	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: CreateFeedPostPublic200Response

Primer

Primer updateFeedPostPublic

Copy

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

flagCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
isFlagged	boolean	Da
sso	string	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer flagCommentPublic

Copy

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

addHashTag

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Odgovor

Vrača: AddHashTag200Response

Primer

Primer addHashTag

Copy

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

addHashTagsBulk

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Ne
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Ne

Odgovor

Vrne: AddHashTagsBulk200Response

Primer

Primer addHashTagsBulk

Copy

// Ustvari identifikator najemnika (neobvezen parameter)
const tenantId: string = "tenant_9f8c2b7a";
// Pripravi posamezne vnose oznak
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Telo za množično ustvarjanje (neobvezen parameter)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Kliči globalno asinhrono funkcijo in dodeli tipiziran rezultat
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

deleteHashTag

Parametri

Ime	Tip	Obvezno
tag	string	Da
tenantId	string	Ne
deleteHashTagRequest	DeleteHashTagRequest	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteHashTag

Copy

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

getHashTags

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
page	number	Ne

Odgovor

Vrne: GetHashTags200Response

Primer

Primer getHashTags

Copy

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

patchHashTag

Parametri

Ime	Tip	Zahtevano
tag	string	Da
tenantId	string	Ne
updateHashTagBody	UpdateHashTagBody	Ne

Odgovor

Vrača: PatchHashTag200Response

Primer

patchHashTag Primer

Copy

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

createModerator

Parametri

Name	Type	Required	Description
tenantId	string	Da
createModeratorBody	CreateModeratorBody	Da

Odgovor

Vrne: CreateModerator200Response

Primer

Primer createModerator

Copy

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

deleteModerator

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
sendEmail	string	Ne

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer uporabe deleteModerator

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

getModerator

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetModerator200Response

Primer

Primer getModerator

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetModerators200Response

Primer

Primer getModerators

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

sendInvite

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
fromName	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer uporabe sendInvite

Copy

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

updateModerator

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
updateModeratorBody	UpdateModeratorBody	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateModerator

Copy

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

deleteNotificationCount

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteNotificationCount

Copy

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

getCachedNotificationCount

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Da

Odgovor

Vrača: GetCachedNotificationCount200Response

Primer

Primer getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // neobvezna zastavica parametra (prikazano)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

getNotificationCount

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
urlId	string	Ne
fromCommentId	string	Ne
viewed	boolean	Ne
type	string	Ne

Odgovor

Vrača: GetNotificationCount200Response

Primer

Primer getNotificationCount

Copy

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

getNotifications

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
urlId	string	Ne
fromCommentId	string	Ne
viewed	boolean	Ne
type	string	Ne
skip	number	Ne

Odgovor

Vrne: GetNotifications200Response

Primer

Primer getNotifications

Copy

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

updateNotification

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateNotificationBody	UpdateNotificationBody	Da
userId	string	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateNotification

Copy

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

addPage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPIPageData	CreateAPIPageData	Da

Odgovor

Vrne: AddPageAPIResponse

deletePage

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeletePageAPIResponse

getPageByURLId

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrača: GetPageByURLIdAPIResponse

getPages

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odziv

Vrne: GetPagesAPIResponse

patchPage

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateAPIPageData	UpdateAPIPageData	Da

Odgovor

Vrne: PatchPageAPIResponse

deletePendingWebhookEvent

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Da

Odziv

Vrne: FlagCommentPublic200Response

Primer

Primer deletePendingWebhookEvent

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // primer neobveznega parametra (funkcija ga ne zahteva)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Ne
externalId	string	Ne
eventType	string	Ne
type	string	Ne
domain	string	Ne
attemptCountGT	number	Ne

Odgovor

Vrača: GetPendingWebhookEventCount200Response

Primer

Primer getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Ne
externalId	string	Ne
eventType	string	Ne
type	string	Ne
domain	string	Ne
attemptCountGT	number	Ne
skip	number	Ne

Odgovor

Vrača: GetPendingWebhookEvents200Response

Primer

Primer getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createQuestionConfigBody	CreateQuestionConfigBody	Da

Odgovor

Vrača: CreateQuestionConfig200Response

Primer

Primer createQuestionConfig

Copy

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

deleteQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteQuestionConfig

Copy

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

getQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetQuestionConfig200Response

Primer

Primer getQuestionConfig

Copy

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

getQuestionConfigs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrača: GetQuestionConfigs200Response

Primer

Primer getQuestionConfigs

Copy

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

updateQuestionConfig

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
updateQuestionConfigBody	UpdateQuestionConfigBody	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateQuestionConfig

Copy

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

createQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createQuestionResultBody	CreateQuestionResultBody	Da

Odgovor

Vrne: CreateQuestionResult200Response

Primer

Primer createQuestionResult

Copy

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

deleteQuestionResult

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteQuestionResult

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // neobvezni parameter, ki prikazuje izbiro alternativnega cilja
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

getQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetQuestionResult200Response

Primer

Primer getQuestionResult

Copy

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

getQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Ne
userId	string	Ne
startDate	string	Ne
questionId	string	Ne
questionIds	string	Ne
skip	number	Ne

Odgovor

Vrača: GetQuestionResults200Response

Primer

Primer getQuestionResults

Copy

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

updateQuestionResult

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateQuestionResultBody	UpdateQuestionResultBody	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateQuestionResult

Copy

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

aggregateQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
questionId	string	Ne
questionIds	Array	Ne
urlId	string	Ne
timeBucket	AggregateTimeBucket	Ne
startDate	Date	Ne
forceRecalculate	boolean	Ne

Odgovor

Vrača: AggregateQuestionResults200Response

Primer

aggregateQuestionResults Primer

Copy

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

bulkAggregateQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Da
forceRecalculate	boolean	Ne

Odgovor

Vrača: BulkAggregateQuestionResults200Response

Primer

Primer bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
questionId	string	Ne
questionIds	Array	Ne
urlId	string	Ne
startDate	Date	Ne
forceRecalculate	boolean	Ne
minValue	number	Ne
maxValue	number	Ne
limit	number	Ne

Odgovor

Vrača: CombineCommentsWithQuestionResults200Response

Primer

Primer combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPISSOUserData	CreateAPISSOUserData	Da

Odgovor

Vrne: AddSSOUserAPIResponse

deleteSSOUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
deleteComments	boolean	Ne
commentDeleteMode	string	Ne

Odgovor

Vrne: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
email	string	Da

Odgovor

Vrača: GetSSOUserByEmailAPIResponse

getSSOUserById

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrača: GetSSOUserByIdAPIResponse

getSSOUsers

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odziv

Vrne: GetSSOUsers200Response

patchSSOUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateAPISSOUserData	UpdateAPISSOUserData	Da
updateComments	boolean	Ne

Odgovor

Vrača: PatchSSOUserAPIResponse

putSSOUser

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
updateAPISSOUserData	UpdateAPISSOUserData	Da
updateComments	boolean	Ne

Odgovor

Vrne: PutSSOUserAPIResponse

createSubscription

Parametri

Ime	Vrsta	Zahtevano	Opis
tenantId	string	Da
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Da

Odgovor

Vrne: CreateSubscriptionAPIResponse

Primer

Primer createSubscription

Copy

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

deleteSubscription

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
userId	string	Ne

Odgovor

Vrne: DeleteSubscriptionAPIResponse

getSubscriptions

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
userId	string	Ne

Odgovor

Vrne: GetSubscriptionsAPIResponse

Primer

Primer getSubscriptions

Copy

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

updateSubscription

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Da
userId	string	Ne

Odgovor

Vrne: UpdateSubscriptionAPIResponse

Primer

updateSubscription Primer

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

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
yearNumber	number	Ne
monthNumber	number	Ne
dayNumber	number	Ne
skip	number	Ne

Odgovor

Vrne: GetTenantDailyUsages200Response

Primer

Primer getTenantDailyUsages

Copy

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

createTenantPackage

Parametri

Name	Type	Required	Description
tenantId	string	Da
createTenantPackageBody	CreateTenantPackageBody	Da

Odgovor

Vrne: CreateTenantPackage200Response

Primer

createTenantPackage Primer

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // neobvezni parameter je podan
  // izpuščena neobvezna polja: npr. napredna pravila moderiranja, prilagojeni CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // ilustrativna vrednost; uporablja obliko CustomConfigParameters
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Da

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer deleteTenantPackage

Copy

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

getTenantPackage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrača: GetTenantPackage200Response

Primer

Primer getTenantPackage

Copy

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

getTenantPackages

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetTenantPackages200Response

Primer

Primer getTenantPackages

Copy

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

replaceTenantPackage

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
replaceTenantPackageBody	ReplaceTenantPackageBody	Da

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer replaceTenantPackage

Copy

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

updateTenantPackage

Parametri

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

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // neobvezna polja so namenoma izpuščena (npr. description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
createTenantUserBody	CreateTenantUserBody	Da

Odgovor

Vrne: CreateTenantUser200Response

Primer

createTenantUser Primer

Copy

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

deleteTenantUser

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
deleteComments	string	Ne
commentDeleteMode	string	Ne

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer deleteTenantUser

Copy

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

getTenantUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetTenantUser200Response

Primer

Primer getTenantUser

Copy

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

getTenantUsers

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetTenantUsers200Response

Primer

Primer getTenantUsers

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

replaceTenantUser

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
replaceTenantUserBody	ReplaceTenantUserBody	Da
updateComments	string	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer replaceTenantUser

Copy

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

sendLoginLink

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
redirectURL	string	No

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer uporabe sendLoginLink

Copy

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

updateTenantUser

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
updateTenantUserBody	UpdateTenantUserBody	Da
updateComments	string	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateTenantUser

Copy

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

createTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantBody	CreateTenantBody	Da

Response

Vrne: CreateTenant200Response

Primer

Primer createTenant

Copy

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

deleteTenant

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
sure	string	Ne

Odziv

Vrne: FlagCommentPublic200Response

Primer

deleteTenant Primer

Copy

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

getTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetTenant200Response

Primer

Primer getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // neobvezen nadomestni ID, če je na voljo
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

getTenants

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
meta	string	Ne
skip	number	Ne

Odgovor

Vrača: GetTenants200Response

Primer

Primer getTenants

Copy

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

updateTenant

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateTenantBody	UpdateTenantBody	Da

Response

Vrača: FlagCommentPublic200Response

Primer

Primer uporabe updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // neobvezno; izpustite, da ohranite trenutne podatke o obračunu
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Da
id	string	Da
changeTicketStateBody	ChangeTicketStateBody	Da

Odgovor

Vrača: ChangeTicketState200Response

Primer

Primer changeTicketState

Copy

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

createTicket

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Da
createTicketBody	CreateTicketBody	Da

Odgovor

Vrne: CreateTicket200Response

Primer

Primer createTicket

Copy

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

getTicket

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
userId	string	Ne

Odgovor

Vrne: GetTicket200Response

Primer

Primer uporabe getTicket

Copy

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

getTickets

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
state	number	Ne
skip	number	Ne
limit	number	Ne

Odgovor

Vrača: GetTickets200Response

Primer

Primer getTickets

Copy

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

uploadImage

Naloži in spremeni velikost slike

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
file	Blob	Da
sizePreset	SizePreset	Ne
urlId	string	Ne

Odgovor

Vrne: UploadImageResponse

getUserBadgeProgressById

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetUserBadgeProgressById200Response

Primer

getUserBadgeProgressById Primer

Copy

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

getUserBadgeProgressByUserId

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
userId	string	Da

Odgovor

Vrača: GetUserBadgeProgressById200Response

Primer

Primer getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // neobvezen vir (lahko je undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

getUserBadgeProgressList

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
limit	number	Ne
skip	number	Ne

Odgovor

Vrne: GetUserBadgeProgressList200Response

Primer

Primer getUserBadgeProgressList

Copy

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

createUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Da
createUserBadgeParams	CreateUserBadgeParams	Da

Response

Vrne: CreateUserBadge200Response

Example

Primer createUserBadge

Copy

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

deleteUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrača: UpdateUserBadge200Response

Primer

Primer deleteUserBadge

Copy

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

getUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetUserBadge200Response

Primer

Primer getUserBadge

Copy

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

getUserBadges

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
badgeId	string	Ne
type	number	Ne
displayedOnComments	boolean	Ne
limit	number	Ne
skip	number	Ne

Odgovor

Vrača: GetUserBadges200Response

Primer

getUserBadges Primer

Copy

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

updateUserBadge

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

Odgovor

Vrne: UpdateUserBadge200Response

Primer

Primer updateUserBadge

Copy

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

getUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string	Ne

Odgovor

Vrne: GetUserNotificationCount200Response

Primer

getUserNotificationCount Primer

Copy

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

getUserNotifications

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
pageSize	number	Ne
afterId	string	Ne
includeContext	boolean	Ne
afterCreatedAt	number	Ne
unreadOnly	boolean	Ne
dmOnly	boolean	Ne
noDm	boolean	Ne
includeTranslations	boolean	Ne
sso	string	Ne

Odgovor

Vrne: GetUserNotifications200Response

Primer

Primer klica getUserNotifications

Copy

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

resetUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string	Ne

Odgovor

Vrača: ResetUserNotifications200Response

Primer

Primer resetUserNotificationCount

Copy

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

resetUserNotifications

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
afterId	string	Ne
afterCreatedAt	number	Ne
unreadOnly	boolean	Ne
dmOnly	boolean	Ne
noDm	boolean	Ne
sso	string	Ne

Odgovor

Vrne: ResetUserNotifications200Response

Primer

Primer resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Omogoči ali onemogoči obvestila za določen komentar.

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
notificationId	string	Da
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Da
commentId	string	Da
sso	string	Ne

Odziv

Vrne: UpdateUserNotificationStatus200Response

Primer

updateUserNotificationCommentSubscriptionStatus Primer

Copy

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

updateUserNotificationPageSubscriptionStatus

Omogočite ali onemogočite obvestila za stran. Ko so uporabniki naročeni na stran, se ustvarijo obvestila za nove korenske komentarje, in tudi

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
url	string	Da
pageTitle	string	Da
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Da
sso	string	Ne

Odgovor

Vrne: UpdateUserNotificationStatus200Response

Primer

Primer updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
notificationId	string	Da
newStatus	UpdateUserNotificationStatusNewStatusEnum	Da
sso	string	Ne

Odgovor

Vrne: UpdateUserNotificationStatus200Response

Primer

Primer updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlIdWS	string	Da
userIds	string	Da

Odgovor

Vrne: GetUserPresenceStatuses200Response

Primer

getUserPresenceStatuses Primer

Copy

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

searchUsers

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
usernameStartsWith	string	Ne
mentionGroupIds	Array	Ne
sso	string	Ne
searchSection	SearchUsersSearchSectionEnum	Ne

Odgovor

Vrne: SearchUsers200Response

Primer

searchUsers Primer

Copy

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

getUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetUser200Response

Primer

Primer getUser

Copy

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

createVote

Parameters

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
direction	CreateVoteDirectionEnum	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: VoteComment200Response

Primer

Primer createVote

Copy

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

deleteVote

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Da
editKey	string	Ne

Odgovor

Vrne: DeleteCommentVote200Response

Primer

Primer deleteVote

Copy

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

getVotes

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrača: GetVotes200Response

Primer

Primer getVotes

Copy

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

getVotesForUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: GetVotesForUser200Response

Primer

Primer getVotesForUser

Copy

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

Potrebujete pomoč?

Če naletite na težave ali imate vprašanja glede JavaScript/TypeScript SDK, prosimo:

Sodelovanje

Prispevki so dobrodošli! Prosimo, obiščite GitHub repozitorij za smernice za prispevanje.

Jezik 🇸🇮 Slovenščina

Začetek

API referenca

Dokumentacija

Uporaba

Pogosti primeri uporabe

Agregat

Revizijski zapisi

Blokiranje komentarja

Preverjanje blokiranih komentarjev

Komentarji

Konfiguracije domene

Predloge e-pošte

Dnevnik dogodkov

Objave

Označevanje komentarjev

Hashtagi

Moderatorji

Število obvestil

Obvestila

Strani

Čakajoči dogodki webhook

Nastavitve vprašanj

Rezultati vprašanj

Agregacija rezultatov vprašanj

SSO uporabniki

Naročnine

Dnevna poraba najemnika

Paketi najemnika

Uporabniki najemnika

Najemniki

Tiketi

Naloži sliko

Napredek uporabniške značke

Uporabniške značke

Obvestila uporabnika

Status prisotnosti uporabnika

Iskanje uporabnikov

Uporabniki

Glasovi

FastComments JavaScript/TypeScript SDK

Repository

Installation

API Documentation

Popolna referenca API: docs/api/README.md

Browser vs Server Compatibility

Usage

Uporaba v brskalniku (na strani odjemalca)

Uporaba na strežniku (Node.js)

Uvoz samo tipov

Uporaba posameznih razredov API

Brskalniško okolje

Strežniško okolje

Public vs Secured APIs

Primer: Uporaba javnega API-ja (varno za brskalnik)

Primer: Uporaba privzetega API-ja (samo na strežniku)

SSO (Single Sign-On) Integration

Preprosto SSO (samo strežniško)

Varen SSO (strežniško, priporočeno)

Uporaba SSO iz brskalnika (z žetonom, ustvarjenim na strežniku)

SSO z ustvarjanjem komentarja

Common Use Cases

Pridobivanje komentarjev za stran

Ustvarjanje komentarja

Glasovanje za komentar

Upravljanje uporabnikov (zahteva API ključ)

Live Events (Real-time Updates)

Dogodki na ravni strani

Naročite se na uporabniške dogodke

Pridobivanje userIdWS

Broadcast IDs

Error Handling

aggregate

Parametri

Odgovor

getAuditLogs

Parametri

Odgovor

Primer

blockFromCommentPublic