FastComments JavaScript/TypeScript SDK

To je uradni JavaScript/TypeScript SDK za FastComments.

Uradni JavaScript/TypeScript SDK za FastComments API

Repository

Namestitev

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

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

Odgovor

Vrne: GetAuditLogs200Response

blockFromCommentPublic

Parametri

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

Odgovor

Vrne: BlockFromCommentPublic200Response

unBlockCommentPublic

Parametri

Name	Type	Required
tenantId	string	Da
commentId	string	Da
publicBlockFromCommentParams	PublicBlockFromCommentParams	Da
sso	string	Ne

Odgovor

Vrne: UnBlockCommentPublic200Response

checkedCommentsForBlocked

Parametri

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

Odgovor

Vrne: CheckedCommentsForBlocked200Response

blockUserFromComment

Parametri

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

Odgovor

Vrne: BlockFromCommentPublic200Response

createCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
broadcastId	string	Da
commentData	CommentData	Da
sessionId	string	Ne
sso	string	Ne

Odgovor

Vrne: CreateCommentPublic200Response

deleteComment

Parametri

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

Odgovor

Vrača: DeleteComment200Response

deleteCommentPublic

Parametri

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

Odgovor

Vrne: DeleteCommentPublic200Response

deleteCommentVote

Parametri

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

Odgovor

Vrne: DeleteCommentVote200Response

flagComment

Parametri

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

Odgovor

Vrne: FlagComment200Response

getComment

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetComment200Response

getComments

Parametri

Ime	Tip	Zahtevano
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

getCommentsPublic

req tenantId urlId

Parametri

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

Vrne: GetCommentsPublic200Response

getCommentText

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: GetCommentText200Response

getCommentVoteUserNames

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
dir	number	Da
sso	string	Ne

Odgovor

Vrne: GetCommentVoteUserNames200Response

lockComment

Parametri

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

Odgovor

Vrne: LockComment200Response

pinComment

Parametri

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

Odgovor

Vrača: PinComment200Response

saveComment

Parametri

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

Odgovor

Vrne: SaveComment200Response

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

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

unBlockUserFromComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
unBlockFromCommentParams	UnBlockFromCommentParams	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: UnBlockCommentPublic200Response

unFlagComment

Parametri

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

Odgovor

Vrne: FlagComment200Response

unLockComment

Parametri

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

Odgovor

Vrača: LockComment200Response

unPinComment

Parametri

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

Odgovor

Vrne: PinComment200Response

updateComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
body	PickAPICommentUpdatableCommentFields	Da
contextUserId	string	Ne
doSpamCheck	boolean	Ne
isLive	boolean	Ne

Odgovor

Vrne: FlagCommentPublic200Response

voteComment

Parametri

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

Odgovor

Vrne: VoteComment200Response

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

Vrača: CreateEmailTemplate200Response

Primer

Primer createEmailTemplate

Copy

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

deleteEmailTemplate

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetEmailTemplate200Response

Primer

Primer getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da

Odgovor

Vrne: GetEmailTemplateDefinitions200Response

Primer

Primer getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametri

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

Odgovor

Vrača: GetEmailTemplateRenderErrors200Response

Primer

Primer getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrača: GetEmailTemplates200Response

Primer

Primer getEmailTemplates

Copy

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

renderEmailTemplate

Parametri

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

Odgovor

Vrne: RenderEmailTemplate200Response

Primer

Primer renderEmailTemplate

Copy

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

updateEmailTemplate

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateEmailTemplateBody	UpdateEmailTemplateBody	Da

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

Parametri

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

Odgovor

Vrne: GetEventLog200Response

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

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

createFeedPostPublic

Parametri

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

Odgovor

Vrača: CreateFeedPostPublic200Response

deleteFeedPostPublic

Parametri

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

Odgovor

Vrne: DeleteFeedPostPublic200Response

getFeedPosts

req tenantId afterId

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
afterId	string	Ne
limit	number	Ne
tags	Array	Ne

Odgovor

Vrne: GetFeedPosts200Response

getFeedPostsPublic

req tenantId afterId

Parametri

Ime	Tip	Obvezno
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

getFeedPostsStats

Parametri

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

Odgovor

Vrne: GetFeedPostsStats200Response

getUserReactsPublic

Parametri

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

Odgovor

Vrne: GetUserReactsPublic200Response

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

updateFeedPost

Parametri

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

Odgovor

Vrača: FlagCommentPublic200Response

updateFeedPostPublic

Parametri

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

Odgovor

Vrne: CreateFeedPostPublic200Response

flagCommentPublic

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

addHashTag

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Ne
createHashTagBody	CreateHashTagBody	Ne

Odgovor

Vrne: AddHashTag200Response

Primer

addHashTag Primer

Copy

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

addHashTagsBulk

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Ne
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Ne

Odgovor

Vrne: AddHashTagsBulk200Response

Primer

Primer addHashTagsBulk

Copy

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

deleteHashTag

Parametri

Name	Type	Required
tag	string	Da
tenantId	string	Ne
deleteHashTagRequest	DeleteHashTagRequest	Ne

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer deleteHashTag

Copy

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

getHashTags

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
page	number	Ne

Odziv

Vrne: GetHashTags200Response

Primer

getHashTags Primer

Copy

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

patchHashTag

Parametri

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

Odgovor

Vrača: PatchHashTag200Response

Primer

Primer patchHashTag

Copy

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

createModerator

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createModeratorBody	CreateModeratorBody	Da

Odgovor

Vrne: CreateModerator200Response

Primer

Primer createModerator

Copy

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

deleteModerator

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

deleteModerator Primer

Copy

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

getModerator

Parametri

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Odgovor

Vrača: GetModerator200Response

Primer

Primer getModerator

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // neobvezen vir (lahko je undefined)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

getModerators

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odziv

Vrača: GetModerators200Response

Primer

Primer getModerators

Copy

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

sendInvite

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer sendInvite

Copy

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

updateModerator

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateModerator

Copy

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

deleteNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

deleteNotificationCount Primer

Copy

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

getCachedNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odziv

Vrne: GetCachedNotificationCount200Response

Primer

Primer getCachedNotificationCount

Copy

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

getNotificationCount

Parametri

Name	Type	Required
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_8a9b7c';
const userId: string = 'user_42b3c';
const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';
const fromCommentId: string | undefined = undefined;
const viewed: boolean = false;
const type: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

getNotifications

Parametri

Name	Type	Required
tenantId	string	Da
userId	string	Ne
urlId	string	Ne
fromCommentId	string	Ne
viewed	boolean	Ne
type	string	Ne
skip	number	Ne

Odgovor

Vrača: GetNotifications200Response

Primer

Primer getNotifications

Copy

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

updateNotification

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

addPage

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

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

deletePendingWebhookEvent Primer

Copy

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

getPendingWebhookEventCount

Parametri

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

getPendingWebhookEventCount Primer

Copy

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

getPendingWebhookEvents

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

Vrne: GetPendingWebhookEvents200Response

Primer

getPendingWebhookEvents Primer

Copy

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

createQuestionConfig

Parametri

Name	Type	Required	Description
tenantId	string	Da
createQuestionConfigBody	CreateQuestionConfigBody	Da

Odgovor

Vrne: CreateQuestionConfig200Response

Primer

Primer createQuestionConfig

Copy

const tenantId: string = "tenant_live_7f8b3c2a";
const customOptions: QuestionConfigCustomOptionsInner[] = [
  { value: "under18", label: "Under 18" },
  { value: "18-24", label: "18-24" },
  { value: "25-34", label: "25-34", defaultSelected: true }
];
const createQuestionConfigBody: CreateQuestionConfigBody = {
  key: "age_range",
  label: "What is your age range?",
  required: false, // izbirno: prikaže izpuščena v primerjavi z vključenimi izbirnimi polji
  renderingType: QuestionRenderingType.Dropdown,
  options: customOptions,
  whenSave: QuestionWhenSave.Always
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer deleteQuestionConfig

Copy

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

getQuestionConfig

Parametri

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetQuestionConfig200Response

Primer

Primer getQuestionConfig

Copy

const tenantId: string = 'acme-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata je izbiren; implementacija je izpuščena zaradi jedrnatosti
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

getQuestionConfigs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetQuestionConfigs200Response

Primer

getQuestionConfigs Primer

Copy

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

updateQuestionConfig

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateQuestionConfig

Copy

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

createQuestionResult

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
createQuestionResultBody	CreateQuestionResultBody	Da

Odgovor

Vrne: CreateQuestionResult200Response

Primer

Primer createQuestionResult

Copy

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

deleteQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

deleteQuestionResult Primer

Copy

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

getQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetQuestionResult200Response

Primer

Primer getQuestionResult

Copy

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

getQuestionResults

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

Vrne: GetQuestionResults200Response

Primer

Primer getQuestionResults

Copy

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

updateQuestionResult

Parametri

Ime	Tip	Zahtevano
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer updateQuestionResult

Copy

const tenantId: string = 'tenant_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // neobvezen parameter je vključen
};
const response: 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

bulkAggregateQuestionResults

Parametri

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

Odgovor

Vrača: BulkAggregateQuestionResults200Response

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

Vrne: CombineCommentsWithQuestionResults200Response

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	Tip	Obvezno	Opis
tenantId	string	Da
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Da

Odgovor

Vrača: CreateSubscriptionAPIResponse

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

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_89f3c2-prod";
const yearNumber: number = 2026;
const monthNumber: number = 1;
const skip: number = 0;
const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

createTenantPackage

Parametri

Name	Type	Required	Description
tenantId	string	Da
createTenantPackageBody	CreateTenantPackageBody	Da

Odgovor

Vrača: CreateTenantPackage200Response

Primer

Primer createTenantPackage

Copy

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

deleteTenantPackage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: FlagCommentPublic200Response

Primer

deleteTenantPackage Primer

Copy

const tenantId: string = 'fc-tenant-8a9c2b';
const packageId: string = 'pkg-47f3c9';
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_westus_01';
const packageId: string = 'pkg_premium_annual_2026';
interface FetchOptions { includeArchived?: boolean }
const options: FetchOptions = { includeArchived: false };
const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetTenantPackages200Response

Primer

Primer getTenantPackages

Copy

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

replaceTenantPackage

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-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // Neobvezna polja, kot so "notes" ali "trialExpiry", so tukaj namerno izpuščena
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

updateTenantPackage

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateTenantPackage

Copy

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

createTenantUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantUserBody	CreateTenantUserBody	Da

Odgovor

Vrača: CreateTenantUser200Response

Primer

Primer createTenantUser

Copy

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

deleteTenantUser

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

deleteTenantUser Primer

Copy

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

getTenantUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrača: GetTenantUser200Response

Primer

Primer getTenantUser

Copy

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

getTenantUsers

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetTenantUsers200Response

Primer

Primer getTenantUsers

Copy

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

replaceTenantUser

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer replaceTenantUser

Copy

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

sendLoginLink

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer sendLoginLink

Copy

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

updateTenantUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Da
updateTenantUserBody	UpdateTenantUserBody	Da
updateComments	string	Ne

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer updateTenantUser

Copy

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

createTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

Odgovor

Vrne: CreateTenant200Response

Primer

Primer createTenant

Copy

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

deleteTenant

Parametri

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

Odgovor

Vrne: FlagCommentPublic200Response

Primer

Primer deleteTenant

Copy

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

getTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetTenant200Response

Primer

Primer getTenant

Copy

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

getTenants

Parametri

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

Odgovor

Vrne: GetTenants200Response

Primer

Primer getTenants

Copy

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

updateTenant

Parametri

Name	Type	Obvezno
tenantId	string	Yes
id	string	Yes
updateTenantBody	UpdateTenantBody	Yes

Odgovor

Vrača: FlagCommentPublic200Response

Primer

Primer uporabe updateTenant

Copy

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

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

Vrača: GetUserBadgeProgressById200Response

getUserBadgeProgressByUserId

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
userId	string	Da

Odgovor

Vrne: GetUserBadgeProgressById200Response

getUserBadgeProgressList

Parametri

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

Odgovor

Vrne: GetUserBadgeProgressList200Response

createUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createUserBadgeParams	CreateUserBadgeParams	Da

Odgovor

Vrne: CreateUserBadge200Response

deleteUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: UpdateUserBadge200Response

getUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetUserBadge200Response

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

Vrne: GetUserBadges200Response

updateUserBadge

Parametri

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

Odgovor

Vrne: UpdateUserBadge200Response

getUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string	Ne

Odgovor

Vrne: GetUserNotificationCount200Response

getUserNotifications

Parametri

Name	Tip	Zahtevano
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

Vrača: GetUserNotifications200Response

resetUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string	Ne

Odgovor

Vrne: ResetUserNotifications200Response

resetUserNotifications

Parametri

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

Odgovor

Vrne: ResetUserNotifications200Response

updateUserNotificationCommentSubscriptionStatus

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

Parametri

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

Odgovor

Vrne: UpdateUserNotificationStatus200Response

updateUserNotificationPageSubscriptionStatus

Omogoči ali onemogoči 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

Vrača: UpdateUserNotificationStatus200Response

updateUserNotificationStatus

Parametri

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

Odgovor

Vrne: UpdateUserNotificationStatus200Response

getUserPresenceStatuses

Parametri

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

Odgovor

Vrača: GetUserPresenceStatuses200Response

searchUsers

Parametri

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

Odgovor

Vrne: SearchUsers200Response

getUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrača: GetUser200Response

Primer

Primer getUser

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // je lahko undefined v nekaterih potekih (neobvezno)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

createVote

Parametri

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

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

deleteVote

Parametri

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

Odgovor

Vrne: DeleteCommentVote200Response

Primer

Primer deleteVote

Copy

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

getVotes

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: GetVotes200Response

Primer

Primer getVotes

Copy

const tenantId: string = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// Če bi obstajal izbirni parameter, npr. includeHidden, bi ga lahko uporabili tako:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

getVotesForUser

Parametri

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

Odgovor

Vrne: GetVotesForUser200Response

Primer

Primer getVotesForUser

Copy

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

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 dokumentacija

Dokumentacija

Uporaba

API referenca

Integracija SSO (enkratna prijava)

Pogosti primeri uporabe

Dogodki v živo (posodobitve v realnem času)

ID-ji oddajanja

Obvladovanje napak

Agregiranje

Revizijski zapisi

Blokiranje komentarja

Preverjanje blokiranih komentarjev

Komentarji

Nastavitve domen

Predloge e-pošte

Dnevnik dogodkov

Objave vira

Označevanje komentarja

Hashtagi

Moderatorji

Število obvestil

Obvestila

Strani

Čakajoči webhook dogodki

Nastavitve vprašanj

Rezultati vprašanj

Agregacija rezultatov vprašanj

SSO uporabniki

Naročnine

Dnevna uporaba najemnika

Paketi najemnikov

Uporabniki najemnika

Najemniki

Naloži sliko

Napredek značke uporabnika

Uporabniške značke

Uporabniška obvestila

Stanja prisotnosti uporabnikov

Iskanje uporabnikov

Uporabniki

Glasovi

FastComments JavaScript/TypeScript SDK

Repository

Namestitev

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