FastComments JavaScript/TypeScript SDK

npm install fastcomments-sdk

Kompletna API referenca: docs/api/README.md

Овај SDK користи два улазна пута да обезбеди оптималну компатибилност и спречи грешке при извршавању:

• fastcomments-sdk/browser - Верзија безбедна за прегледаче са нативним fetch
• fastcomments-sdk/server - Пуна Node.js верзија са подршком за SSO
• fastcomments-sdk (подразумевано) - Само типови, безбедно за увоз било где

SDK пружа ове API класе:

• DefaultApi - Заштићене крајње тачке које захтијевају ваш API кључ за аутентификацију. Користите их за серверске операције.
• PublicApi - Јавне крајње тачке којима се може приступити без API кључа. Ове се могу позивати директно из прегледача/мобилних уређаја/итд.
• ModerationApi - Крајње тачке контролне табле за модерацију (модерација коментара, забране, значке, фактор повјерења, претрага). Аутентификовано сесијом модератора; прослиједите query параметар sso за модераторе аутентификоване преко SSO.
• HiddenApi - Интерне/администраторске крајње тачке за напредне случајеве употребе.

Примјер: Коришћење јавног API-ја (безбједно за прегледач)

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

const publicApi = new PublicApi();

// Преузимање коментара за страницу (API кључ није потребан)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Примјер: Коришћење Default API-а (само на серверу)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Чувајте ово у тајности!
});
const defaultApi = new DefaultApi(config);

// Добијање коментара са пуним администраторским приступом
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Примјер: Коришћење API-ја за модерацију

import { createFastCommentsSDK } from 'fastcomments-sdk/server';

const sdk = createFastCommentsSDK({ /* basePath, итд. */ });

// Позиви аутентификовани као модератор (сесијски колачић, или прослиједите `sso` за SSO модератора).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

await sdk.moderationApi.postSetCommentSpamStatus({
  commentId: 'comment-id',
  spam: true
});

FastComments подржава SSO за интеграцију са вашим постојећим системом аутентификације корисника. Функционалност SSO је доступна само у server export-у јер захтева Node.js crypto функције.

Једноставан SSO (само на серверу)

Једноставан SSO треба да буде генерисан на серверу и послат клијенту:

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

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

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

const ssoToken = sso.createToken();

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

Сигуран SSO (на серверу, препоручено)

Сигуран SSO треба да буде имплементиран на серверу и пружа бољу сигурност:

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

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

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

const ssoConfig = sso.prepareToSend();

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

// Or send ssoConfig to client for browser usage

Коришћење SSO из прегледача (са серверски генерисаним токеном)

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

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

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

SSO са креирањем коментара

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

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

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

Dobijanje komentara za stranicu

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

Kreiranje komentara

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

Glasanje za komentar

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

Upravljanje korisnicima (zahteva API ključ)

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

Претплатите се на догађаје уживо да бисте добијали ажурирања у реалном времену за коментаре, гласове и друге активности.

Догађаји на нивоу странице

Слушајте догађаје уживо за одређену страницу (коментари, гласови итд.):

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

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

// Претплатите се на догађаје уживо за страницу
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (преузмите ово из одговора getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Ажурирајте ваш кориснички интерфејс са новим коментаром
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Ажурирајте број гласова у вашем корисничком интерфејсу
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Затворите претплату када завршите
subscription.close();

Претплата на корисничке догађаје

Слушајте догађaje специфичне за корисника (обавештења, помињања итд.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Преузмите ово из одговора getComments
};

// Претплатите се на лични фид корисника
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Прикажите обавештење у вашем корисничком интерфејсу
        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');
  }
);

// Затворите када завршите
userSubscription.close();

Добијање userIdWS

Параметар userIdWS је обавезан за догађаје уживо и може се добити из одговора API-ја:

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

// Извуците userIdWS из одговора
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Сада се можете претплатити на догађаје уживо
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Видећете да треба да проследите broadcastId у неким API позивима. Када примите догађаје, добићете овај ID назад, па ћете знати да игноришете догађај ако планирате да оптимистички примените промене на клијенту (што ћете вероватно желети, јер пружа најбоље корисничко искуство). Проследите UUID овде. ID треба да буде довољно јединствен да се не појави два пута у прегледачкој сесији.

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() // Јединствени ID за ову операцију
  }
});

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

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameters

Response

Vraća: AggregateResponse

Primjer

aggregate Primjer

Copy

1

2const tenantId: string = "tenant-12345";

3

4const aggregationRequest: AggregationRequest = {

5 predicates: [

6 {

7 field: "status",

8 operator: "eq",

9 value: { type: "string", value: "approved" }

10 }

11 ],

12 operations: [

13 { type: "count", field: "commentId" }

14 ],

15 sort: { field: "createdAt", direction: "desc" }

16};

17

18const parentTenantId: string = "parent-001";

19const includeStats: boolean = true;

20

21const result: AggregateResponse = await aggregate(

22 tenantId,

23 aggregationRequest,

24 parentTenantId,

25 includeStats

26);

27

Parametri

Odgovor

Vraća: GetAuditLogsResponse1

Primjer

Primjer getAuditLogs

Copy

1

2(async () => {

3 const tenantId: string = "tenant_42";

4 const limit: number = 100;

5 const skip: number = 10;

6 const order: SORTDIR = "desc";

7 const after: number = Date.now() - 3 * 24 * 60 * 60 * 1000; // prije 3 dana

8

9 const auditResponse: GetAuditLogsResponse1 = await getAuditLogs(

10 tenantId,

11 limit,

12 skip,

13 order,

14 after

15 );

16

17 console.log(auditResponse);

18})();

19

Parametri

Odgovor

Vraća: BlockFromCommentPublicResponse

Primjer

Primjer blockFromCommentPublic

Copy

1

2async function demo() {

3 const tenantId: string = "tenant_9f8b7c";

4 const commentId: string = "cmt_1234567890";

5 const blockParams: PublicBlockFromCommentParams = {

6 reason: "spam",

7 durationHours: 24,

8 };

9 const ssoToken: string = "sso_ABCDEF123456";

10

11 const responseWithSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(

12 tenantId,

13 commentId,

14 blockParams,

15 ssoToken

16 );

17

18 const responseWithoutSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(

19 tenantId,

20 commentId,

21 blockParams

22 );

23

24 console.log(responseWithSso, responseWithoutSso);

25}

26demo();

27

Parametri

Odgovor

Vraća: UnBlockCommentPublicResponse

Primer

unBlockCommentPublic Primer

Copy

1

2const tenantId: string = "acme-corp-tenant";

3const commentId: string = "cmt-20230915-001";

4const unblockParams: PublicBlockFromCommentParams = {

5 reason: "User appealed and was cleared",

6 unblockExpiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString()

7};

8const ssoToken: string = "sso-3d9f8a7b";

9

10const result: UnBlockCommentPublicResponse = await unBlockCommentPublic(

11 tenantId,

12 commentId,

13 unblockParams,

14 ssoToken

15);

16

Parametri

Odgovor

Vraća: CheckedCommentsForBlockedResponse

Primer

checkedCommentsForBlocked Primer

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp-123";

4 const commentIds: string = "cmt_001,cmt_002";

5 const ssoToken: string = "ssoTokenXYZ";

6

7 const blockedCheck: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds);

8 const blockedCheckWithSso: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

9})();

10

Parametri

Odgovor

Vraća: BlockUserFromCommentResponse

Primjer

Primjer blockUserFromComment

Copy

1

2const tenantId: string = 'tenant_42';

3const commentId: string = 'cmt_20231101';

4

5const blockParams: BlockFromCommentParams = {

6 reason: 'spam',

7 blockDurationHours: 24,

8};

9

10const userId: string = 'user_123'; // opcionalni parametar

11

12const response: BlockUserFromCommentResponse = await blockUserFromComment(

13 tenantId,

14 commentId,

15 blockParams,

16 userId

17);

18

Parametri

Odgovor

Vraća: CreateCommentPublicResponse

Primjer

createCommentPublic Primjer

Copy

1

2(async () => {

3 const tenantId: string = "tenant-abc123";

4 const urlId: string = "post-987654";

5 const broadcastId: string = "bcast-001";

6 const commentData: CommentData = {

7 content: "I really enjoyed this article!"

8 };

9 const sessionId: string = "session-xyz789";

10 const sso: string = "sso-token-456def";

11

12 const response: CreateCommentPublicResponse = await createCommentPublic(

13 tenantId,

14 urlId,

15 broadcastId,

16 commentData,

17 sessionId,

18 sso

19 );

20

21 console.log(response);

22})();

23

Parametri

Odgovor

Returns: DeleteCommentResponse

Primer

Primer deleteComment

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_01';

4 const commentId: string = 'comment_abc123';

5 const contextUserId: string = 'user_42';

6 const isLive: boolean = false;

7

8 const deleteResult: DeleteCommentResponse = await deleteComment(tenantId, commentId, contextUserId, isLive);

9 const simpleResult: DeleteCommentResponse = await deleteComment(tenantId, commentId);

10})();

11

Parametri

Odgovor

Returns: DeleteCommentPublicResponse

Primer

deleteCommentPublic Primer

Copy

1

2(async () => {

3 const tenantId: string = 'c6f9a2e3-9b1d-4f8a-b2d2-1a2b3c4d5e6f';

4 const commentId: string = '7d9f0b1c-2e3f-4a5b-6c7d-8e9f0a1b2c3d';

5 const broadcastId: string = 'live-2023-09-15';

6 const editKey: string = 'ed1tK3y1234567890';

7 const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123';

8

9 const result: DeleteCommentPublicResponse = await deleteCommentPublic(

10 tenantId,

11 commentId,

12 broadcastId,

13 editKey,

14 sso

15 );

16})();

17

Parametri

Odgovor

Vraća: DeleteCommentVoteResponse

Primjer

deleteCommentVote Primjer

Copy

1

2async function removeVote() {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "cmt_98765";

5 const voteId: string = "vote_abcde";

6 const urlId: string = "url_56789";

7 const broadcastId: string = "brd_001";

8 const editKey: string = "edit_456";

9 // sso je opcionalno i izostavljeno

10

11 const response: DeleteCommentVoteResponse = await deleteCommentVote(

12 tenantId,

13 commentId,

14 voteId,

15 urlId,

16 broadcastId,

17 editKey

18 );

19

20 console.log(response);

21}

22

23removeVote();

24

Parametri

Odgovor

Vraća: FlagCommentResponse1

Primjer

flagComment Primjer

Copy

1

2(async () => {

3 const tenantId: string = "tenant_2023";

4 const commentId: string = "comment_5678";

5 const userId: string = "user_1234";

6 const anonUserId: string = "anon_4321";

7

8 const result: FlagCommentResponse1 = await flagComment(tenantId, commentId, userId);

9 const anonResult: FlagCommentResponse1 = await flagComment(tenantId, commentId, undefined, anonUserId);

10})();

11

Parametri

Odgovor

Vraća: GetCommentResponse

Primjer

getComment Primjer

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "comment-987654";

5 const result: GetCommentResponse = await getComment(tenantId, commentId);

6 const badgeInfo: CommentUserBadgeInfo | undefined = result.comment?.user?.badgeInfo;

7 console.log(badgeInfo?.label);

8})();

9

Parametri

Odgovor

Vraća: GetCommentsResponse

Primjer

Primjer getComments

Copy

1

2const tenantId: string = "tenant_12345";

3const page: number = 2;

4const limit: number = 50;

5const asTree: boolean = true;

6const urlId: string = "article_5678";

7const direction: SortDirections = "desc";

8const fromDate: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // prije jedne sedmice

9const toDate: number = Date.now();

10

11const commentsResponse: GetCommentsResponse = await getComments({

12 tenantId,

13 page,

14 limit,

15 asTree,

16 urlId,

17 direction,

18 fromDate,

19 toDate,

20});

21

req
tenantId
urlId

Parametri

Odgovor

Vraća: GetCommentsPublicResponse

Primjer

getCommentsPublic primjer

Copy

1

2async function fetchComments() {

3 const tenantId: string = 'acme-corp';

4 const urlId: string = 'blog/post-789';

5 const page: number = 1;

6 const direction: SortDirections = SortDirections.Desc;

7 const limit: number = 25;

8 const includeConfig: boolean = true;

9 const locale: string = 'en-GB';

10 const modules: string = 'reactions,attachments';

11 const isCrawler: boolean = false;

12 const includeNotificationCount: boolean = true;

13 const asTree: boolean = true;

14 const maxTreeDepth: number = 4;

15 const searchText: string = 'TypeScript';

16 const hashTags: string[] = ['typescript', 'api'];

17 const response: GetCommentsPublicResponse = await getCommentsPublic(

18 tenantId,

19 urlId,

20 page,

21 direction,

22 undefined,

23 undefined,

24 undefined,

25 limit,

26 undefined,

27 undefined,

28 undefined,

29 includeConfig,

30 undefined,

31 undefined,

32 locale,

33 modules,

34 isCrawler,

35 includeNotificationCount,

36 asTree,

37 maxTreeDepth,

38 undefined,

39 undefined,

40 searchText,

41 hashTags,

42 undefined,

43 undefined,

44 undefined,

45 undefined

46 );

47}

48

Parametri

Odgovor

Vraća: GetCommentTextResponse1

Primer

Primjer getCommentText

Copy

1

2async function run() {

3 const tenantId: string = "acme-corp-tenant";

4 const commentId: string = "cmt-5f2e9a1b";

5 const editKey: string = "edk-9b7c3";

6 const ssoToken: string = "sso-xyz789";

7

8 const commentOnly: GetCommentTextResponse1 = await getCommentText(tenantId, commentId);

9 const commentWithEdit: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey);

10 const commentFull: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey, ssoToken);

11}

12run();

13

Parametri

Odgovor

Vraća: GetCommentVoteUserNamesResponse

Primjer

getCommentVoteUserNames Primjer

Copy

1

2async function demoGetCommentVoteUserNames() {

3 const tenantId: string = "acme-corp";

4 const commentId: string = "cmt_5f2a1e3b";

5 const dir: number = 1; // rastući

6

7 const votesWithoutSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(

8 tenantId,

9 commentId,

10 dir

11 );

12

13 const ssoToken: string = "sso_abcdef123456";

14 const votesWithSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(

15 tenantId,

16 commentId,

17 dir,

18 ssoToken

19 );

20

21 console.log(votesWithoutSSO, votesWithSSO);

22}

23

Parametri

Odgovor

Vraća: LockCommentResponse

Primer

lockComment Primer

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4 const commentId: string = "cmt_98765";

5 const broadcastId: string = "brd_54321";

6

7 // Sa opcionalnim SSO tokenom

8 const ssoToken: string = "user-abc123";

9 const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);

10

11 // Bez SSO tokena

12 const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);

13})();

14

Parametri

Odgovor

Vraća: PinCommentResponse

Primer

pinComment Primer

Copy

1

2(async () => {

3 const tenantId: string = 'tenant-001';

4 const commentId: string = 'comment-5678';

5 const broadcastId: string = 'broadcast-2023';

6 const ssoToken: string = 'sso-xyz-789';

7

8 const pinResult: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId);

9 const pinResultWithSso: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);

10})();

11

Parametri

Odgovor

Vraća: SaveCommentResponse

Primjer

saveComment Primjer

Copy

1

2async function submitComment() {

3 const tenantId: string = "tenant_9f8e7d6c";

4 const commentParams: CreateCommentParams = {

5 text: "Great post, thanks for sharing!",

6 authorId: "user_123abc",

7 mentions: [] as CommentUserMentionInfo[],

8 hashtags: [] as CommentUserHashTagInfo[]

9 };

10 const response: SaveCommentResponse = await saveComment(

11 tenantId,

12 commentParams,

13 true, // isLive

14 false // doSpamCheck

15 );

16 console.log(response);

17}

18submitComment();

19

Parametri

Odgovor

Vraća: Array<SaveCommentsBulkResponse

Primjer

saveCommentsBulk Primjer

Copy

1

2const tenantId: string = "tenant_9f8b7c6d";

3

4const bulkComments: CreateCommentParams[] = [

5 {

6 content: "Welcome to the new forum thread!",

7 authorId: "user_42",

8 mentions: [{ userId: "user_84", username: "alice" }],

9 hashtags: [{ tag: "intro" }]

10 },

11 {

12 content: "Please review the updated guidelines.",

13 authorId: "moderator_1",

14 mentions: [],

15 hashtags: [{ tag: "guidelines" }, { tag: "update" }]

16 }

17];

18

19const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(

20 tenantId,

21 bulkComments,

22 true, // isLive

23 false, // doSpamCheck

24 true, // sendEmails

25 undefined // populateNotifications (using default)

26);

27

Parametri

Odgovor

Vraća: SetCommentTextResponse1

Primjer

setCommentText Primjer

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_12345';

4 const commentId: string = 'cmt_98765';

5 const broadcastId: string = 'brd_112233';

6 const commentTextUpdateRequest: CommentTextUpdateRequest = {

7 text: 'Updated comment with @john.doe and #important',

8 mentions: [{ userId: 'user_001', username: 'john.doe' }],

9 hashtags: [{ tag: 'important' }],

10 };

11 const editKey: string = 'edit_abc123';

12 const result: SetCommentTextResponse1 = await setCommentText(

13 tenantId,

14 commentId,

15 broadcastId,

16 commentTextUpdateRequest,

17 editKey,

18 );

19 console.log(result);

20})();

21

Parametri

Odgovor

Vraća: UnBlockUserFromCommentResponse

Primjer

Primjer unBlockUserFromComment

Copy

1

2async function demoUnblock() {

3 const tenantId: string = "acme-corp-tenant";

4 const commentId: string = "cmt_9f8b7a6d";

5

6 const params: UnBlockFromCommentParams = {

7 reason: "User resolved the issue",

8 notifyUser: true

9 };

10

11 const userId: string = "usr_12345";

12

13 const result: UnBlockUserFromCommentResponse = await unBlockUserFromComment(

14 tenantId,

15 commentId,

16 params,

17 userId

18 // anonUserId izostavljen

19 );

20

21 console.log(result);

22}

23demoUnblock();

24

Parametri

Odgovor

Vraća: UnFlagCommentResponse

Primjer

unFlagComment primjer

Copy

1

2const tenantId: string = "acme-corp";

3const commentId: string = "cmt_123456";

4const userId: string = "usr_98765";

5

6const result: UnFlagCommentResponse = await unFlagComment(tenantId, commentId, userId);

7

8const anonCommentId: string = "cmt_123457";

9const anonUserId: string = "anon_abc123";

10

11const anonResult: UnFlagCommentResponse = await unFlagComment(tenantId, anonCommentId, undefined, anonUserId);

12

Parametri

Odgovor

Vraća: UnLockCommentResponse

Primjer

unLockComment Primjer

Copy

1

2const tenantId: string = "tenant_12345";

3const commentId: string = "cmt_9876";

4const broadcastId: string = "brd_001";

5const ssoToken: string | undefined = "sso_token_abc";

6

7async function run() {

8 const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);

9 console.log(unlocked);

10

11 // Poziv bez opcionalnog sso parametra

12 const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);

13 console.log(unlockedWithoutSso);

14}

15

16run();

17

Parametri

Odgovor

Vraća: UnPinCommentResponse

Primjer

unPinComment Primjer

Copy

1

2(async () => {

3 const tenantId: string = "tenant-001"

4 const commentId: string = "comment-123"

5 const broadcastId: string = "broadcast-456"

6 const sso: string = "sso-token-xyz"

7

8 const resultWithSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId, sso)

9 const resultWithoutSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId)

10

11 console.log(resultWithSso, resultWithoutSso)

12})()

13

Parameters

Response

Returns: UpdateCommentResponse

Example

updateComment primjer

Copy

1

2const tenantId: string = "tenant_12345";

3const commentId: string = "cmt_98765";

4

5const updatableCommentParams: UpdatableCommentParams = {

6 // primjeri polja; stvarni oblik zavisi od definicije API‑ja

7 // npr., body: "Edited comment content",

8};

9

10const contextUserId: string = "user_abcde";

11const doSpamCheck: boolean = true;

12const isLive: boolean = false;

13

14const result: UpdateCommentResponse = await updateComment(

15 tenantId,

16 commentId,

17 updatableCommentParams,

18 contextUserId,

19 doSpamCheck,

20 isLive

21);

22

Parametri

Odgovor

Vraća: VoteCommentResponse

Primjer

voteComment Primjer

Copy

1

2const tenantId: string = "acme-corp";

3const commentId: string = "cmt_9f8e7d6c";

4const urlId: string = "url_123456";

5const broadcastId: string = "bcast_2024_01";

6

7const voteBodyParams: VoteBodyParams = {

8 vote: "up", // npr., "up" | "down"

9 weight: 1, // opcionalno ponderisanje glasa

10};

11

12const sessionId: string = "sess_abc123def";

13const sso: string = "sso_token_xyz";

14

15const result: VoteCommentResponse = await voteComment(

16 tenantId,

17 commentId,

18 urlId,

19 broadcastId,

20 voteBodyParams,

21 sessionId,

22 sso

23);

24

Parametri

Odgovor

Vraća: GetCommentsForUserResponse1

Primjer

Primjer getCommentsForUser

Copy

1

2async function demo() {

3 const userId: string = "user-12345";

4 const direction: SortDirections = "desc";

5 const page: number = 1;

6 const includei10n: boolean = true;

7 const locale: string = "en-US";

8 const isCrawler: boolean = false;

9

10 const response: GetCommentsForUserResponse1 = await getCommentsForUser(

11 userId,

12 direction,

13 undefined,

14 page,

15 includei10n,

16 locale,

17 isCrawler

18 );

19

20 console.log(response);

21}

22

Параметри

Одговор

Враћа: AddDomainConfigResponse

Пример

addDomainConfig Пример

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_12345';

4 const config: AddDomainConfigParams = {

5 domain: 'myblog.example.com',

6 enabled: true,

7 // opis je opcionalan i ovde izostavljen

8 };

9 const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);

10 console.log(response);

11})();

12

Parametri

Odgovor

Returns: DeleteDomainConfigResponse

Primjer

deleteDomainConfig Primjer

Copy

1

2async function runExample() {

3 const tenantId: string = 'acme-corp';

4 const domain: string = 'blog.acme.com';

5 const response: DeleteDomainConfigResponse = await deleteDomainConfig(tenantId, domain);

6 console.log(response);

7}

8runExample();

9

Parametri

Odgovor

Returns: GetDomainConfigResponse

Primjer

Primjer getDomainConfig

Copy

1

2async function main() {

3 const tenantId: string = "acme-corp-123";

4 const domain: string = "blog.acme.com";

5 const config: GetDomainConfigResponse = await getDomainConfig(tenantId, domain);

6 console.log(config);

7}

8main();

9

Parametri

Odgovor

Vraća: GetDomainConfigsResponse

Primer

Primjer getDomainConfigs

Copy

1

2async function fetchDomainConfigs(): Promise<void> {

3 const tenantId: string = "acme-corp-567";

4 const configs: GetDomainConfigsResponse = await getDomainConfigs(tenantId);

5 console.log(configs);

6}

7

Parametri

Odgovor

Vraća: PatchDomainConfigResponse

Primer

Primjer patchDomainConfig

Copy

1

2async function updateDomainConfig() {

3 const tenantId: string = "tenant_98765";

4 const domainToUpdate: string = "forum.mycompany.com";

5 const patchParams: PatchDomainConfigParams = {

6 enableComments: true,

7 moderationLevel: "strict",

8 allowAnonymous: false, // demonstriran opcionalni parametar

9 };

10 const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);

11 console.log(response);

12}

13

14updateDomainConfig();

15

Parametri

Odgovor

Vraća: PutDomainConfigResponse

Primer

putDomainConfig Primer

Copy

1

2async function runExample() {

3 const tenantId: string = 'tenant-9f8c7b1a';

4 const domainToUpdate: string = 'comments.mywebsite.org';

5 const updateDomainConfigParams: UpdateDomainConfigParams = {

6 enableModeration: true,

7 // opcionalno polje izostavljeno, npr., maxCommentLength?: number

8 };

9 const result: PutDomainConfigResponse = await putDomainConfig(

10 tenantId,

11 domainToUpdate,

12 updateDomainConfigParams,

13 );

14 console.log(result);

15}

16runExample();

17

Parametri

Odgovor

Vraća: CreateEmailTemplateResponse1

Primjer

createEmailTemplate Primjer

Copy

1

2const tenantId: string = "tenant_9f8e7d6c";

3

4const emailTemplate: CreateEmailTemplateBody = {

5 name: "Account Activation",

6 subject: "Activate Your New Account",

7 htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",

8 // opcionalna polja poput textContent, isActive su izostavljena da bi se demonstrirali opcionalni parametri

9};

10

11const result: CreateEmailTemplateResponse1 = await createEmailTemplate(

12 tenantId,

13 emailTemplate

14);

15

16console.log(result);

17

Parametri

Odgovor

Vraća: DeleteEmailTemplateResponse

Primjer

Primjer deleteEmailTemplate

Copy

1

2async () => {

3 const tenantId: string = "tenant_12345";

4 const templateId: string = "template_abcde";

5

6 const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);

7

8 // Primjer pristupa opcionalnoj svojini iz odgovora

9 const statusCode: number | undefined = response.status?.code;

10}();

11

Parametri

Odgovor

Vraća: DeleteEmailTemplateRenderErrorResponse

Primer

deleteEmailTemplateRenderError Primer

Copy

1

2async function executeDelete() {

3 const tenantId: string = "tenant_12345";

4 const templateId: string = "email_tpl_001";

5 const errorId: string = "render_err_2023";

6

7 const result: DeleteEmailTemplateRenderErrorResponse = await deleteEmailTemplateRenderError(

8 tenantId,

9 templateId,

10 errorId

11 );

12

13 console.log(result);

14}

15

16executeDelete();

17

Parametri

Odgovor

Vraća: GetEmailTemplateResponse1

Primjer

getEmailTemplate Primjer

Copy

1

2async function fetchTemplate(): Promise<void> {

3 const tenantId: string = "tenant-12345";

4 const templateId: string = "order-confirmation";

5 const response: GetEmailTemplateResponse1 = await getEmailTemplate(tenantId, templateId);

6 const emailTemplate: CustomEmailTemplate | undefined = response.customEmailTemplate;

7 const configParams: CustomConfigParameters | undefined = response.customConfigParameters;

8}

9

Parametri

Odgovor

Vraća: GetEmailTemplateDefinitionsResponse1

Primjer

getEmailTemplateDefinitions Primer

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp-123";

4 const emailTemplateDefs: GetEmailTemplateDefinitionsResponse1 = await getEmailTemplateDefinitions(tenantId);

5 console.log(emailTemplateDefs);

6})();

7

Parametri

Odgovor

Returns: GetEmailTemplateRenderErrorsResponse1

Primjer

getEmailTemplateRenderErrors Primjer

Copy

1

2const tenantId: string = "c2f5a8d9-4b3e-4f6a-9e1b-2d5c6f7a8b9c";

3const templateId: string = "welcome-email-template";

4const skip: number = 20;

5

6const result: GetEmailTemplateRenderErrorsResponse1 = await getEmailTemplateRenderErrors(

7 tenantId,

8 templateId,

9 skip

10);

11

Parameters

Response

Vraća: GetEmailTemplatesResponse1

Primer

Primer getEmailTemplates

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4

5 // Call without optional 'skip'

6 const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);

7

8 // Call with optional 'skip' parameter

9 const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);

10})();

11

Parametri

Odgovor

Vraća: RenderEmailTemplateResponse1

Primjer

renderEmailTemplate Primjer

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp-01";

4 const templateBody: RenderEmailTemplateBody = {

5 templateId: "welcome-email",

6 placeholders: {

7 userName: "John Doe",

8 signupDate: "2024-04-01"

9 }

10 };

11 const locale: string = "en-US";

12 const result: RenderEmailTemplateResponse1 = await renderEmailTemplate(tenantId, templateBody, locale);

13 console.log(result);

14})();

15

Parametri

Odgovor

Vraća: UpdateEmailTemplateResponse

Primjer

updateEmailTemplate Primjer

Copy

1

2(async () => {

3 const tenantId: string = "tenant_12345";

4 const templateId: string = "email_tpl_67890";

5

6 const updateBody: UpdateEmailTemplateBody = {

7 subject: "Comment reply notification",

8 htmlContent: "<p>Someone replied to your comment.</p>",

9 plainTextContent: "Someone replied to your comment.",

10 // primjer opcionalnog polja

11 isActive: true,

12 };

13

14 const result: UpdateEmailTemplateResponse = await updateEmailTemplate(

15 tenantId,

16 templateId,

17 updateBody

18 );

19

20 console.log(result);

21})();

22

req tenantId urlId userIdWS

Parametri

Odgovor

Vraća: GetEventLogResponse1

Primer

getEventLog Primer

Copy

1

2(async () => {

3 const tenantId: string = "tenant_9876";

4 const urlId: string = "page_54321";

5 const userIdWS: string = "ws_user_1122";

6 const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // prije jednu sedmicu

7 const endTime: number = Date.now();

8

9 const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

10 const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);

11})();

12

req tenantId urlId userIdWS

Parametri

Odgovor

Vraća: GetGlobalEventLogResponse

Primjer

Primjer getGlobalEventLog

Copy

1

2(async () => {

3 const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';

4 const urlId: string = 'article-2023-09-15';

5 const userIdWS: string = 'ws_987654321';

6 const startTime: number = Date.now() - 86400000;

7 const endTime: number = Date.now();

8

9 const fullLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

10 const recentLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);

11

12 console.log(fullLog, recentLog);

13})();

14

Parametri

Odgovor

Vraća: CreateFeedPostResponse1

Primjer

Primjer createFeedPost

Copy

1

2async function run() {

3 const tenantId = "tenant-12345";

4 const feedParams: CreateFeedPostParams = {

5 text: "New product launch!",

6 mediaItems: [{ type: "image", asset: { url: "https://cdn.example.com/img.jpg", width: 800, height: 600 } as FeedPostMediaItemAsset } as FeedPostMediaItem],

7 link: { url: "https://example.com/product", title: "Product" } as FeedPostLink

8 };

9 const result: CreateFeedPostResponse1 = await createFeedPost(tenantId, feedParams, "broadcast-987", true, false, true);

10 console.log(result);

11}

12run();

13

Parametri

Odgovor

Vraća: CreateFeedPostPublicResponse

Primjer

Primjer createFeedPostPublic

Copy

1

2async function submitPost() {

3 const tenantId: string = "tenant_12345";

4

5 const mediaItem: FeedPostMediaItem = {

6 asset: {

7 url: "https://cdn.example.com/image.jpg",

8 mimeType: "image/jpeg",

9 size: 104857,

10 },

11 type: "image",

12 };

13

14 const link: FeedPostLink = {

15 url: "https://example.com/blog/new-feature",

16 title: "New Feature Release",

17 description: "Details about our latest product update.",

18 };

19

20 const createFeedPostParams: CreateFeedPostParams = {

21 content: "Check out our new feature!",

22 media: [mediaItem],

23 link: link,

24 };

25

26 const broadcastId: string = "broadcast_9876";

27 const sso: string = "sso_token_abc123";

28

29 const response: CreateFeedPostPublicResponse = await createFeedPostPublic(

30 tenantId,

31 createFeedPostParams,

32 broadcastId,

33 sso

34 );

35}

36

Parametri

Odgovor

Vraća: DeleteFeedPostPublicResponse

Primjer

deleteFeedPostPublic Primjer

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp";

4 const postId: string = "post_987654321";

5 const broadcastId: string = "broadcast_2024Q1";

6 const sso: string = "sso_4fa3b9c2";

7

8 const response1: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId);

9 const response2: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId);

10 const response3: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

11})();

12

req tenantId afterId

Parametri

Odgovor

Vraća: GetFeedPostsResponse1

Primjer

Primjer getFeedPosts

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_12345';

4 const afterId: string = 'post_9876';

5 const limit: number = 20;

6 const tags: string[] = ['news', 'sports'];

7

8 const feedResult: GetFeedPostsResponse1 = await getFeedPosts(tenantId, afterId, limit, tags);

9})();

10

req tenantId afterId

Parametri

Odgovor

Vraća: GetFeedPostsPublicResponse

Primer

getFeedPostsPublic Primer

Copy

1

2async function example() {

3 const tenantId: string = "tenant_12345";

4 const afterId: string = "post_9876";

5 const limit: number = 20;

6 const tags: string[] = ["news", "tech"];

7 const sso: string = "userToken123";

8 const isCrawler: boolean = false;

9 const includeUserInfo: boolean = true;

10 const response: GetFeedPostsPublicResponse = await getFeedPostsPublic(

11 tenantId,

12 afterId,

13 limit,

14 tags,

15 sso,

16 isCrawler,

17 includeUserInfo

18 );

19}

20example();

21

Parametri

Odgovor

Vraća: GetFeedPostsStatsResponse

Primjer

Primjer getFeedPostsStats

Copy

1

2async function runExample(): Promise<void> {

3 const tenantId: string = "tenant_12345";

4 const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];

5 const ssoToken: string = "sso_abcdef123456";

6

7 const statsWithoutSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds);

8 const statsWithSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds, ssoToken);

9}

10

11runExample();

12