FastComments SDK za JavaScript/TypeScript

To je uradni JavaScript/TypeScript SDK za FastComments.

Upravljajte komentarje, uporabnike, SSO in moderiranje iz Node.js ali iz brskalnika.

Repozitorij

Namestitev

npm install fastcomments-sdk

Dokumentacija API-ja

Popolna referenca API: docs/api/README.md

Združljivost brskalnika in strežnika

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

Uporaba

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

Javni in zaščiteni API-ji

The SDK zagotavlja naslednje API razrede:

DefaultApi - Zaščitene končne točke, ki zahtevajo vaš API ključ za overjanje. Uporabite jih za operacije na strežniku.
PublicApi - Javne končne točke, do katerih je mogoče dostopati brez API ključa. Te lahko kličete neposredno iz brskalnikov/mobilnih naprav/itd.
ModerationApi - Končne točke nadzorne plošče moderatorja (moderacija komentarjev, prepovedi, značke, faktor zaupanja, iskanje). Avtenticirano z moderatorjevo sejo; posredujte poizvedni parameter sso za moderatorje, avtenticirane preko SSO.
HiddenApi - Notranje/admin končne točke za napredne primere uporabe.

Primer: Uporaba Public API (varno v brskalniku)

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 Default API (samo na strežniku)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Hranite to skrivno!
});
const defaultApi = new DefaultApi(config);

// Pridobi komentarje z polnim administratorskim dostopom
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Primer: Uporaba Moderation API

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

const sdk = createFastCommentsSDK({ /* basePath, itd. */ });

// Klici, avtenticirani z moderatorsko sejo (sejni piškotek) ali posredujte `sso` za moderatorja, avtenticiranega preko SSO.
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

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

Integracija enotne prijave (SSO)

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

Pogosti primeri uporabe

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

Dogodki v živo (posodobitve v realnem času)

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

ID-ji za oddajanje

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

Ravnanje z napakami

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

Agregiraj

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Različne operacije (npr. sum, countDistinct, avg, itd.) so podprte.

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

Odgovor

Vrne: AggregateResponse

Primer

Primer agregacije

Copy

const tenantId: string = "tenant-12345";
const aggregationRequest: AggregationRequest = {
  predicates: [
    {
      field: "status",
      operator: "eq",
      value: { type: "string", value: "approved" }
    }
  ],
  operations: [
    { type: "count", field: "commentId" }
  ],
  sort: { field: "createdAt", direction: "desc" }
};
const parentTenantId: string = "parent-001";
const includeStats: boolean = true;
const result: AggregateResponse = await aggregate(
  tenantId,
  aggregationRequest,
  parentTenantId,
  includeStats
);

Pridobi revizijske dnevnike

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Odgovor

Vrne: GetAuditLogsResponse1

Primer

Primer getAuditLogs

Copy

(async () => {
  const tenantId: string = "tenant_42";
  const limit: number = 100;
  const skip: number = 10;
  const order: SORTDIR = "desc";
  const after: number = Date.now() - 3 * 24 * 60 * 60 * 1000; // pred 3 dnevi
  const auditResponse: GetAuditLogsResponse1 = await getAuditLogs(
    tenantId,
    limit,
    skip,
    order,
    after
  );
  console.log(auditResponse);
})();

Blokiraj iz javnega komentarja

Parametri

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

Odgovor

Vrne: BlockFromCommentPublicResponse

Primer

blockFromCommentPublic Primer

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const commentId: string = "cmt_1234567890";
  const blockParams: PublicBlockFromCommentParams = {
    reason: "spam",
    durationHours: 24,
  };
  const ssoToken: string = "sso_ABCDEF123456";
  const responseWithSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams,
    ssoToken
  );
  const responseWithoutSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams
  );
  console.log(responseWithSso, responseWithoutSso);
}
demo();

Odblokiraj javni komentar

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

Odgovor

Vrne: UnBlockCommentPublicResponse

Primer

unBlockCommentPublic Primer

Copy

const tenantId: string = "acme-corp-tenant";
const commentId: string = "cmt-20230915-001";
const unblockParams: PublicBlockFromCommentParams = {
  reason: "User appealed and was cleared",
  unblockExpiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString()
};
const ssoToken: string = "sso-3d9f8a7b";
const result: UnBlockCommentPublicResponse = await unBlockCommentPublic(
  tenantId,
  commentId,
  unblockParams,
  ssoToken
);

Preveri blokirane komentarje

Parametri

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

Odgovor

Vrne: CheckedCommentsForBlockedResponse

Primer

checkedCommentsForBlocked Primer

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const commentIds: string = "cmt_001,cmt_002";
  const ssoToken: string = "ssoTokenXYZ";
  const blockedCheck: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds);
  const blockedCheckWithSso: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
})();

Blokiraj uporabnika iz komentarja

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	Yes
blockFromCommentParams	BlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

Odgovor

Vrne: BlockUserFromCommentResponse

Primer

blockUserFromComment Primer

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // neobvezen parameter
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

Ustvari javni komentar

Parametri

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

Odgovor

Vrne: CreateCommentPublicResponse

Primer

createCommentPublic Primer

Copy

(async () => {
  const tenantId: string = "tenant-abc123";
  const urlId: string = "post-987654";
  const broadcastId: string = "bcast-001";
  const commentData: CommentData = {
    content: "I really enjoyed this article!"
  };
  const sessionId: string = "session-xyz789";
  const sso: string = "sso-token-456def";
  const response: CreateCommentPublicResponse = await createCommentPublic(
    tenantId,
    urlId,
    broadcastId,
    commentData,
    sessionId,
    sso
  );
  console.log(response);
})();

Izbriši komentar

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
contextUserId	string	No
isLive	boolean	No

Odgovor

Vrne: DeleteCommentResponse

Primer

deleteComment Primer

Copy

(async () => {
  const tenantId: string = 'tenant_01';
  const commentId: string = 'comment_abc123';
  const contextUserId: string = 'user_42';
  const isLive: boolean = false;
  const deleteResult: DeleteCommentResponse = await deleteComment(tenantId, commentId, contextUserId, isLive);
  const simpleResult: DeleteCommentResponse = await deleteComment(tenantId, commentId);
})();

Izbriši javni komentar

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Odgovor

Vrne: DeleteCommentPublicResponse

Primer

deleteCommentPublic Primer

Copy

(async () => {
  const tenantId: string = 'c6f9a2e3-9b1d-4f8a-b2d2-1a2b3c4d5e6f';
  const commentId: string = '7d9f0b1c-2e3f-4a5b-6c7d-8e9f0a1b2c3d';
  const broadcastId: string = 'live-2023-09-15';
  const editKey: string = 'ed1tK3y1234567890';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123';
  const result: DeleteCommentPublicResponse = await deleteCommentPublic(
    tenantId,
    commentId,
    broadcastId,
    editKey,
    sso
  );
})();

Izbriši glas za komentar

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
voteId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Odgovor

Vrne: DeleteCommentVoteResponse

Primer

deleteCommentVote Primer

Copy

async function removeVote() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const voteId: string = "vote_abcde";
  const urlId: string = "url_56789";
  const broadcastId: string = "brd_001";
  const editKey: string = "edit_456";
  // sso je opcijski in izpuščen
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

Označi komentar

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Odgovor

Vrne: FlagCommentResponse1

Primer

flagComment Primer

Copy

(async () => {
  const tenantId: string = "tenant_2023";
  const commentId: string = "comment_5678";
  const userId: string = "user_1234";
  const anonUserId: string = "anon_4321";
  const result: FlagCommentResponse1 = await flagComment(tenantId, commentId, userId);
  const anonResult: FlagCommentResponse1 = await flagComment(tenantId, commentId, undefined, anonUserId);
})();

Pridobi komentar

Parametri

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetCommentResponse

Primer

getComment Primer

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-987654";
  const result: GetCommentResponse = await getComment(tenantId, commentId);
  const badgeInfo: CommentUserBadgeInfo | undefined = result.comment?.user?.badgeInfo;
  console.log(badgeInfo?.label);
})();

Pridobi komentarje

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No
fromDate	number	No
toDate	number	No

Odgovor

Vrne: GetCommentsResponse

Primer

Primer getComments

Copy

const tenantId: string = "tenant_12345";
const page: number = 2;
const limit: number = 50;
const asTree: boolean = true;
const urlId: string = "article_5678";
const direction: SortDirections = "desc";
const fromDate: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // one week ago
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

Pridobi javne komentarje

req tenantId urlId

Parametri

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

Odgovor

Vrne: GetCommentsPublicResponse

Primer

getCommentsPublic Primer

Copy

async function fetchComments() {
  const tenantId: string = 'acme-corp';
  const urlId: string = 'blog/post-789';
  const page: number = 1;
  const direction: SortDirections = SortDirections.Desc;
  const limit: number = 25;
  const includeConfig: boolean = true;
  const locale: string = 'en-GB';
  const modules: string = 'reactions,attachments';
  const isCrawler: boolean = false;
  const includeNotificationCount: boolean = true;
  const asTree: boolean = true;
  const maxTreeDepth: number = 4;
  const searchText: string = 'TypeScript';
  const hashTags: string[] = ['typescript', 'api'];
  const response: GetCommentsPublicResponse = await getCommentsPublic(
    tenantId,
    urlId,
    page,
    direction,
    undefined,
    undefined,
    undefined,
    limit,
    undefined,
    undefined,
    undefined,
    includeConfig,
    undefined,
    undefined,
    locale,
    modules,
    isCrawler,
    includeNotificationCount,
    asTree,
    maxTreeDepth,
    undefined,
    undefined,
    searchText,
    hashTags,
    undefined,
    undefined,
    undefined,
    undefined
  );
}

Pridobi besedilo komentarja

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: GetCommentTextResponse1

Primer

Primer getCommentText

Copy

async function run() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt-5f2e9a1b";
  const editKey: string = "edk-9b7c3";
  const ssoToken: string = "sso-xyz789";
  const commentOnly: GetCommentTextResponse1 = await getCommentText(tenantId, commentId);
  const commentWithEdit: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey);
  const commentFull: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey, ssoToken);
}
run();

Pridobi uporabniška imena glasovalcev za komentar

Parametri

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

Odgovor

Vrne: GetCommentVoteUserNamesResponse

Primer

Primer getCommentVoteUserNames

Copy

async function demoGetCommentVoteUserNames() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_5f2a1e3b";
  const dir: number = 1; // naraščajoče
  const votesWithoutSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir
  );
  const ssoToken: string = "sso_abcdef123456";
  const votesWithSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir,
    ssoToken
  );
  console.log(votesWithoutSSO, votesWithSSO);
}

Zakleni komentar

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Odgovor

Vrne: LockCommentResponse

Primer

lockComment Primer

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // Z neobveznim SSO žetonom
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // Brez SSO žetona
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

Pripni komentar

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Odziv

Returns: PinCommentResponse

Primer

pinComment Primer

Copy

(async () => {
  const tenantId: string = 'tenant-001';
  const commentId: string = 'comment-5678';
  const broadcastId: string = 'broadcast-2023';
  const ssoToken: string = 'sso-xyz-789';
  const pinResult: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId);
  const pinResultWithSso: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);
})();

Shrani komentar

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Odgovor

Vrne: SaveCommentResponse

Primer

saveComment Primer

Copy

async function submitComment() {
  const tenantId: string = "tenant_9f8e7d6c";
  const commentParams: CreateCommentParams = {
    text: "Great post, thanks for sharing!",
    authorId: "user_123abc",
    mentions: [] as CommentUserMentionInfo[],
    hashtags: [] as CommentUserHashTagInfo[]
  };
  const response: SaveCommentResponse = await saveComment(
    tenantId,
    commentParams,
    true,   // isLive
    false   // doSpamCheck
  );
  console.log(response);
}
submitComment();

Masovno shranjevanje komentarjev

Parametri

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

Odgovor

Vrne: Array<SaveCommentsBulkResponse

Primer

saveCommentsBulk Primer

Copy

const tenantId: string = "tenant_9f8b7c6d";
const bulkComments: CreateCommentParams[] = [
  {
    content: "Welcome to the new forum thread!",
    authorId: "user_42",
    mentions: [{ userId: "user_84", username: "alice" }],
    hashtags: [{ tag: "intro" }]
  },
  {
    content: "Please review the updated guidelines.",
    authorId: "moderator_1",
    mentions: [],
    hashtags: [{ tag: "guidelines" }, { tag: "update" }]
  }
];
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  bulkComments,
  true,      // isLive
  false,     // doSpamCheck
  true,      // sendEmails
  undefined  // populateNotifications (using default)
);

Nastavi besedilo komentarja

Parametri

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
commentTextUpdateRequest	CommentTextUpdateRequest	Yes
editKey	string	No
sso	string	No

Odziv

Vrne: SetCommentTextResponse1

Primer

setCommentText Primer

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const commentId: string = 'cmt_98765';
  const broadcastId: string = 'brd_112233';
  const commentTextUpdateRequest: CommentTextUpdateRequest = {
    text: 'Updated comment with @john.doe and #important',
    mentions: [{ userId: 'user_001', username: 'john.doe' }],
    hashtags: [{ tag: 'important' }],
  };
  const editKey: string = 'edit_abc123';
  const result: SetCommentTextResponse1 = await setCommentText(
    tenantId,
    commentId,
    broadcastId,
    commentTextUpdateRequest,
    editKey,
  );
  console.log(result);
})();

Odblokiraj uporabnika iz komentarja

Parametri

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

Odgovor

Vrne: UnBlockUserFromCommentResponse

Primer

unBlockUserFromComment Primer

Copy

async function demoUnblock() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt_9f8b7a6d";
  const params: UnBlockFromCommentParams = {
    reason: "User resolved the issue",
    notifyUser: true
  };
  const userId: string = "usr_12345";
  const result: UnBlockUserFromCommentResponse = await unBlockUserFromComment(
    tenantId,
    commentId,
    params,
    userId
    // anonUserId izpuščen
  );
  console.log(result);
}
demoUnblock();

Odznači komentar

Parametri

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

Odgovor

Vrne: UnFlagCommentResponse

Primer

Primer unFlagComment

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_123456";
const userId: string = "usr_98765";
const result: UnFlagCommentResponse = await unFlagComment(tenantId, commentId, userId);
const anonCommentId: string = "cmt_123457";
const anonUserId: string = "anon_abc123";
const anonResult: UnFlagCommentResponse = await unFlagComment(tenantId, anonCommentId, undefined, anonUserId);

Odkleni komentar

Parametri

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

Odgovor

Vrne: UnLockCommentResponse

Primer

Primer unLockComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const broadcastId: string = "brd_001";
const ssoToken: string | undefined = "sso_token_abc";
async function run() {
  const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
  console.log(unlocked);
  // Klic brez izbirnega parametra sso
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

Odstrani pripenjanje komentarja

Parametri

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

Odgovor

Vrne: UnPinCommentResponse

Primer

unPinComment Primer

Copy

(async () => {
  const tenantId: string = "tenant-001"
  const commentId: string = "comment-123"
  const broadcastId: string = "broadcast-456"
  const sso: string = "sso-token-xyz"
  const resultWithSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId, sso)
  const resultWithoutSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId)
  console.log(resultWithSso, resultWithoutSso)
})()

Posodobi komentar

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
updatableCommentParams	UpdatableCommentParams	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Odziv

Vrne: UpdateCommentResponse

Primer

Primer updateComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // primer polj; dejanska struktura je odvisna od definicije API-ja
  // npr., body: "Edited comment content",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

Glasuj za komentar

Parameters

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

Response

Vrne: VoteCommentResponse

Example

voteComment Primer

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_9f8e7d6c";
const urlId: string = "url_123456";
const broadcastId: string = "bcast_2024_01";
const voteBodyParams: VoteBodyParams = {
  vote: "up",               // npr., "up" | "down"
  weight: 1,                // neobvezno tehtanje glasovanja
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

Pridobi komentarje za uporabnika

Parametri

Ime	Vrsta	Obvezno
userId	string	Ne
direction	SortDirections	Ne
repliesToUserId	string	Ne
page	number	Ne
includei10n	boolean	Ne
locale	string	Ne
isCrawler	boolean	Ne

Odgovor

Vrne: GetCommentsForUserResponse1

Primer

Primer getCommentsForUser

Copy

async function demo() {
    const userId: string = "user-12345";
    const direction: SortDirections = "desc";
    const page: number = 1;
    const includei10n: boolean = true;
    const locale: string = "en-US";
    const isCrawler: boolean = false;
    const response: GetCommentsForUserResponse1 = await getCommentsForUser(
        userId,
        direction,
        undefined,
        page,
        includei10n,
        locale,
        isCrawler
    );
    console.log(response);
}

Dodaj konfiguracijo domene

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

Response

Returns: AddDomainConfigResponse

Example

addDomainConfig Primer

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // opis je neobvezen in je izpuščen tukaj
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

Izbriši konfiguracijo domene

Parametri

Name	Type	Required	Description
tenantId	string	Da
domain	string	Da

Odgovor

Vrne: DeleteDomainConfigResponse

Primer

deleteDomainConfig Primer

Copy

async function runExample() {
  const tenantId: string = 'acme-corp';
  const domain: string = 'blog.acme.com';
  const response: DeleteDomainConfigResponse = await deleteDomainConfig(tenantId, domain);
  console.log(response);
}
runExample();

Pridobi konfiguracijo domene

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
domain	string	Yes

Odgovor

Vrne: GetDomainConfigResponse

Primer

Primer getDomainConfig

Copy

async function main() {
  const tenantId: string = "acme-corp-123";
  const domain: string = "blog.acme.com";
  const config: GetDomainConfigResponse = await getDomainConfig(tenantId, domain);
  console.log(config);
}
main();

Pridobi konfiguracije domen

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrne: GetDomainConfigsResponse

Primer

getDomainConfigs Primer

Copy

async function fetchDomainConfigs(): Promise<void> {
  const tenantId: string = "acme-corp-567";
  const configs: GetDomainConfigsResponse = await getDomainConfigs(tenantId);
  console.log(configs);
}

Delno posodobi konfiguracijo domene

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
domainToUpdate	string	Yes
patchDomainConfigParams	PatchDomainConfigParams	Yes

Odgovor

Vrne: PatchDomainConfigResponse

Primer

patchDomainConfig Primer

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // demonstriran neobvezen parametar
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

Zamenjaj konfiguracijo domene

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
domainToUpdate	string	Yes
updateDomainConfigParams	UpdateDomainConfigParams	Yes

Odgovor

Returns: PutDomainConfigResponse

Primer

Primer putDomainConfig

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // izpuščen neobvezen polje, npr., maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

Ustvari e-poštno predlogo

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
createEmailTemplateBody	CreateEmailTemplateBody	Da

Odziv

Vrne: CreateEmailTemplateResponse1

Primer

createEmailTemplate Primer

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // opcijska polja, kot sta textContent, isActive, so izpuščena, da pokažemo opcijske parametre
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

Izbriši e-poštno predlogo

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: DeleteEmailTemplateResponse

Primer

deleteEmailTemplate Primer

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // Primer dostopanja do neobvezne lastnosti iz odgovora
  const statusCode: number | undefined = response.status?.code;
}();

Izbriši napako upodabljanja e-poštne predloge

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

Odgovor

Vrne: DeleteEmailTemplateRenderErrorResponse

Primer

deleteEmailTemplateRenderError Primer

Copy

async function executeDelete() {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_001";
  const errorId: string = "render_err_2023";
  const result: DeleteEmailTemplateRenderErrorResponse = await deleteEmailTemplateRenderError(
    tenantId,
    templateId,
    errorId
  );
  console.log(result);
}
executeDelete();

Pridobi e-poštno predlogo

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetEmailTemplateResponse1

Primer

getEmailTemplate Primer

Copy

async function fetchTemplate(): Promise<void> {
    const tenantId: string = "tenant-12345";
    const templateId: string = "order-confirmation";
    const response: GetEmailTemplateResponse1 = await getEmailTemplate(tenantId, templateId);
    const emailTemplate: CustomEmailTemplate | undefined = response.customEmailTemplate;
    const configParams: CustomConfigParameters | undefined = response.customConfigParameters;
}

Pridobi definicije e-poštnih predlog

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes

Odgovor

Vrne: GetEmailTemplateDefinitionsResponse1

Primer

getEmailTemplateDefinitions Primer

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const emailTemplateDefs: GetEmailTemplateDefinitionsResponse1 = await getEmailTemplateDefinitions(tenantId);
  console.log(emailTemplateDefs);
})();

Pridobi napake upodabljanja e-poštnih predlog

Parametri

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

Odgovor

Vrne: GetEmailTemplateRenderErrorsResponse1

Primer

getEmailTemplateRenderErrors Primer

Copy

const tenantId: string = "c2f5a8d9-4b3e-4f6a-9e1b-2d5c6f7a8b9c";
const templateId: string = "welcome-email-template";
const skip: number = 20;
const result: GetEmailTemplateRenderErrorsResponse1 = await getEmailTemplateRenderErrors(
  tenantId,
  templateId,
  skip
);

Pridobi e-poštne predloge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
skip	number	No

Odgovor

Vrne: GetEmailTemplatesResponse1

Primer

getEmailTemplates Primer

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Klic brez izbirnega 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Klic z izbirnim parametrom 'skip'
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

Upodobi e-poštno predlogo

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	Yes
locale	string	No

Odziv

Returns: RenderEmailTemplateResponse1

Primer

Primer renderEmailTemplate

Copy

(async () => {
  const tenantId: string = "acme-corp-01";
  const templateBody: RenderEmailTemplateBody = {
    templateId: "welcome-email",
    placeholders: {
      userName: "John Doe",
      signupDate: "2024-04-01"
    }
  };
  const locale: string = "en-US";
  const result: RenderEmailTemplateResponse1 = await renderEmailTemplate(tenantId, templateBody, locale);
  console.log(result);
})();

Posodobi e-poštno predlogo

Parametri

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

Odgovor

Vrne: UpdateEmailTemplateResponse

Primer

updateEmailTemplate Primer

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "Comment reply notification",
    htmlContent: "<p>Someone replied to your comment.</p>",
    plainTextContent: "Someone replied to your comment.",
    // primer neobveznega polja
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

Pridobi dnevnik dogodkov

req tenantId urlId userIdWS

Parametri

Ime	Tip	Zahtevano
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	No

Odgovor

Vrne: GetEventLogResponse1

Primer

getEventLog Primer

Copy

(async () => {
    const tenantId: string = "tenant_9876";
    const urlId: string = "page_54321";
    const userIdWS: string = "ws_user_1122";
    const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // one week ago
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

Pridobi globalni dnevnik dogodkov

req tenantId urlId userIdWS

Parametri

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

Odgovor

Vrne: GetGlobalEventLogResponse

Primer

Primer getGlobalEventLog

Copy

(async () => {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const urlId: string = 'article-2023-09-15';
  const userIdWS: string = 'ws_987654321';
  const startTime: number = Date.now() - 86400000;
  const endTime: number = Date.now();
  const fullLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
  const recentLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);
  console.log(fullLog, recentLog);
})();

Ustvari objavo vira

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Odgovor

Vrne: CreateFeedPostResponse1

Primer

createFeedPost Primer

Copy

async function run() {
  const tenantId = "tenant-12345";
  const feedParams: CreateFeedPostParams = {
    text: "New product launch!",
    mediaItems: [{ type: "image", asset: { url: "https://cdn.example.com/img.jpg", width: 800, height: 600 } as FeedPostMediaItemAsset } as FeedPostMediaItem],
    link: { url: "https://example.com/product", title: "Product" } as FeedPostLink
  };
  const result: CreateFeedPostResponse1 = await createFeedPost(tenantId, feedParams, "broadcast-987", true, false, true);
  console.log(result);
}
run();

Ustvari javno objavo vira

Parameters

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

Odgovor

Vrne: CreateFeedPostPublicResponse

Primer

createFeedPostPublic Primer

Copy

async function submitPost() {
  const tenantId: string = "tenant_12345";
  const mediaItem: FeedPostMediaItem = {
    asset: {
      url: "https://cdn.example.com/image.jpg",
      mimeType: "image/jpeg",
      size: 104857,
    },
    type: "image",
  };
  const link: FeedPostLink = {
    url: "https://example.com/blog/new-feature",
    title: "New Feature Release",
    description: "Details about our latest product update.",
  };
  const createFeedPostParams: CreateFeedPostParams = {
    content: "Check out our new feature!",
    media: [mediaItem],
    link: link,
  };
  const broadcastId: string = "broadcast_9876";
  const sso: string = "sso_token_abc123";
  const response: CreateFeedPostPublicResponse = await createFeedPostPublic(
    tenantId,
    createFeedPostParams,
    broadcastId,
    sso
  );
}

Izbriši javno objavo vira

Parametri

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

Odgovor

Vrne: DeleteFeedPostPublicResponse

Primer

deleteFeedPostPublic Primer

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const postId: string = "post_987654321";
  const broadcastId: string = "broadcast_2024Q1";
  const sso: string = "sso_4fa3b9c2";
  const response1: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId);
  const response2: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId);
  const response3: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
})();

Pridobi objave vira

req tenantId afterId

Parametri

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

Odziv

Vrne: GetFeedPostsResponse1

Primer

Primer getFeedPosts

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const afterId: string = 'post_9876';
  const limit: number = 20;
  const tags: string[] = ['news', 'sports'];
  const feedResult: GetFeedPostsResponse1 = await getFeedPosts(tenantId, afterId, limit, tags);
})();

Pridobi javne objave vira

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

Vrne: GetFeedPostsPublicResponse

Primer

getFeedPostsPublic Primer

Copy

async function example() {
  const tenantId: string = "tenant_12345";
  const afterId: string = "post_9876";
  const limit: number = 20;
  const tags: string[] = ["news", "tech"];
  const sso: string = "userToken123";
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublicResponse = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
}
example();

Pridobi statistiko objav vira

Parametri

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

Odgovor

Vrne: GetFeedPostsStatsResponse

Primer

Primer getFeedPostsStats

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
    const ssoToken: string = "sso_abcdef123456";
    const statsWithoutSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds);
    const statsWithSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds, ssoToken);
}
runExample();

Pridobi javne reakcije uporabnika

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
postIds	Array	No
sso	string	No

Odgovor

Vrne: GetUserReactsPublicResponse

Primer

Primer getUserReactsPublic

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const postIds: string[] = ["post_1a2b3c", "post_4d5e6f"];
  const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
  const fullResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId, postIds, ssoToken);
  const minimalResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId);
}
demo();

Reagiraj na javno objavo vira

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
sso	string	No

Odgovor

Vrne: ReactFeedPostPublicResponse

Primer

reactFeedPostPublic Primer

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const postId: string = 'post_98765';
  const reactBodyParams: ReactBodyParams = { reaction: 'thumbs_up' };
  const isUndo: boolean = false;
  const broadcastId: string = 'broadcast_abcde';
  const sso: string = 'sso_token_xyz';
  const response: ReactFeedPostPublicResponse = await reactFeedPostPublic(
    tenantId,
    postId,
    reactBodyParams,
    isUndo,
    broadcastId,
    sso
  );
  console.log(response);
})();

Posodobi objavo vira

Parametri

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

Odgovor

Vrne: UpdateFeedPostResponse

Primer

Primer updateFeedPost

Copy

const tenantId: string = "tenant_3421";
const postId: string = "feedpost_a9b8c7";
const feedPost: FeedPost = {
  content: "We've refreshed the announcement with the latest project milestones.",
  media: [
    {
      type: "image",
      url: "https://assets.example.com/images/milestone.png",
      caption: "Project Milestones"
    } as FeedPostMediaItem
  ],
  link: {
    url: "https://example.com/project-updates",
    title: "Project Updates",
    description: "Read about the recent progress and upcoming goals."
  } as FeedPostLink
};
const result: UpdateFeedPostResponse = await updateFeedPost(tenantId, postId, feedPost);

Posodobi javno objavo vira

Parametri

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

Odziv

Vrne: UpdateFeedPostPublicResponse

Primer

updateFeedPostPublic Primer

Copy

async function updatePostExample() {
  const tenantId: string = 'tenant-9f8b7c';
  const postId: string = 'post-3a4d5e';
  const updateParams: UpdateFeedPostParams = {
    title: 'New Announcement',
    content: 'We have updated our terms of service.',
    media: [
      {
        url: 'https://cdn.example.com/assets/image.png',
        type: 'image',
        asset: {
          width: 800,
          height: 600,
          size: 124000
        } as FeedPostMediaItemAsset
      } as FeedPostMediaItem
    ],
    link: {
      url: 'https://example.com/terms',
      title: 'Read the new TOS'
    } as FeedPostLink
  };
  const broadcastId: string = 'broadcast-2023-09';
  const sso: string = 'sso-abc123xyz';
  const result: UpdateFeedPostPublicResponse = await updateFeedPostPublic(
    tenantId,
    postId,
    updateParams,
    broadcastId,
    sso
  );
}

Označi javni komentar

Parametri

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

Odgovor

Vrne: FlagCommentPublicResponse

Primer

flagCommentPublic Primer

Copy

async function demoFlagComment() {
    const tenantId: string = "acme-tenant-123";
    const commentId: string = "comment-987654";
    const isFlagged: boolean = true;
    const sso: string = "sso-token-abc123";
    const result: FlagCommentPublicResponse = await flagCommentPublic(
        tenantId,
        commentId,
        isFlagged,
        sso
    );
    console.log(result);
}
demoFlagComment();

Pridobi velik GIF

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
largeInternalURLSanitized	string	Da

Odziv

Vrne: GetGifLargeResponse

Primer

getGifLarge Primer

Copy

(async () => {
  const tenantId: string = 'c9f4a1b2-3d5e-4f6a-8b9c-0d1e2f3a4b5c';
  const largeInternalURLSanitized: string = 'https://cdn.fastcomments.com/gifs/awesome-cat-large.gif';
  const result: GetGifLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
  console.log(result);
})();

Išči GIF-e

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
search	string	Yes
locale	string	No
rating	string	No
page	number	No

Odgovor

Vrne: GetGifsSearchResponse

Primer

getGifsSearch Primer

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const search: string = "funny cats";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 1;
  const result: GetGifsSearchResponse = await getGifsSearch(
    tenantId,
    search,
    locale,
    rating,
    page
  );
  console.log(result);
}
demo();

Pridobi priljubljene GIF-e

Parameters

Name	Type	Required
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

Response

Returns: GetGifsTrendingResponse

Example

getGifsTrending Primer

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const locale: string = "en-US";
  const rating: string = "PG-13";
  const page: number = 1;
  const trendingAll: GetGifsTrendingResponse = await getGifsTrending(tenantId, locale, rating, page);
  console.log(trendingAll);
  // Using only the required parameter
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

Dodaj hashtag

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Ne
createHashTagBody	CreateHashTagBody	Ne

Odziv

Vrne: AddHashTagResponse

Primer

addHashTag Primer

Copy

const tenantId: string = "tenant_9876";
const newHashTag: CreateHashTagBody = {
  tag: "typescript",
  description: "Discussions about TypeScript"
};
const responseWithTenant: AddHashTagResponse = await addHashTag(tenantId, newHashTag);
const responseWithoutTenant: AddHashTagResponse = await addHashTag(undefined, newHashTag);

Dodaj hashtage v množici

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Odgovor

Vrne: AddHashTagsBulkResponse

Primer

addHashTagsBulk Primer

Copy

async () => {
    const tenantId: string | undefined = "tenant_9f8b7c6d";
    const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
        tags: [
            {
                name: "typescript",
                description: "Discussions about TypeScript",
                color: "#3178c6"
            },
            {
                name: "fastcomments",
                description: "Tags for FastComments integration",
                color: "#00aaff"
            }
        ]
    };
    const result: AddHashTagsBulkResponse = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    console.log(result);
}();

Izbriši hashtag

Parametri

Ime	Tip	Obvezno
tag	string	Yes
tenantId	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Odgovor

Vrne: DeleteHashTagResponse

Primer

deleteHashTag Primer

Copy

(async () => {
  const tag: string = "announcement";
  const tenantId: string = "tenant_9876";
  const requestBody: DeleteHashTagRequestBody = {
    confirmDeletion: true
  };
  const response: DeleteHashTagResponse = await deleteHashTag(tag, tenantId, requestBody);
  console.log(response);
})();

Pridobi hashtage

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
page	number	Ne

Odziv

Vrne: GetHashTagsResponse1

Primer

Primer getHashTags

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const responseWithPage: GetHashTagsResponse1 = await getHashTags(tenantId, 1);
  const responseDefault: GetHashTagsResponse1 = await getHashTags(tenantId);
  console.log(responseWithPage, responseDefault);
})();

Delno posodobi hashtag

Parametri

Ime	Vrsta	Obvezno
tag	string	Yes
tenantId	string	No
updateHashTagBody	UpdateHashTagBody	No

Odgovor

Vrne: PatchHashTagResponse

Primer

patchHashTag Primer

Copy

const response1: PatchHashTagResponse = await patchHashTag("new-feature");
const response2: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c"
);
const updateBody: UpdateHashTagBody = {
  description: "Mark comments related to the upcoming beta release",
  color: "#1e90ff"
};
const response3: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c",
  updateBody
);

Izbriši glas moderacije

Parametri

Ime	Vrsta	Obvezno
commentId	string	Yes
voteId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Odziv

Vrne: DeleteModerationVoteResponse

Primer

deleteModerationVote Primer

Copy

const commentId: string = "cmt_12345";
const voteId: string = "vote_9876";
const broadcastId: string = "brd_001";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc";
const result: DeleteModerationVoteResponse = await deleteModerationVote(
  commentId,
  voteId,
  broadcastId,
  tenantId,
  sso
);

Pridobi API komentarje

Parameters

Ime	Tip	Obvezno
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Response

Vrne: GetApiCommentsResponse

Example

Primer getApiComments

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // stran
    25,                    // število
    "feedback",           // iskanje besedila
    "192.168.1.100",      // poIPIzKomentarja
    "approved",           // filtri
    "hasReplies",         // filtriIskanja
    "dateDesc",           // razvrščanje
    false,                // demo
    "tenant-abc123",      // ID najemnika
    "sso-token-xyz"       // sso
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

Pridobi stanje izvoza API-ja

Parametri

Ime	Vrsta	Obvezno
batchJobId	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetApiExportStatusResponse

Primer

getApiExportStatus Primer

Copy

async function demoExportStatus() {
    const batchJobId: string = "exportBatch-20231101-001";
    const tenantId: string = "tenant-abc123";
    const ssoToken: string = "sso-xyz789";
    const fullStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId, tenantId, ssoToken);
    const simpleStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId);
    console.log(fullStatus, simpleStatus);
}

Pridobi API ID-je

Parametri

Ime	Vrsta	Obvezno
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetApiIdsResponse

Primer

getApiIds Primer

Copy

const textSearch: string = "urgent feedback";
const byIPFromComment: string = "203.0.113.42";
const filters: string = "status:approved";
const afterId: string = "comment-789";
const demo: boolean = true;
const tenantId: string = "tenant-001";
const apiIds: GetApiIdsResponse = await getApiIds({
  textSearch,
  byIPFromComment,
  filters,
  afterId,
  demo,
  tenantId,
});

Pridobi uporabnike na črni listi iz komentarja

Parametri

Ime	Vrsta	Obvezno
commentId	string	Da
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetBanUsersFromCommentResponse

Primer

Primer getBanUsersFromComment

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // Klic z vsemi parametri
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // Klic le s potrebnim parametrom
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

Pridobi stanje prepovedi komentarja

Parametri

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

Odgovor

Vrne: GetCommentBanStatusResponse1

Primer

Primer getCommentBanStatus

Copy

async function checkCommentBanStatus() {
  const banStatus: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654321', 'tenant_42', 'sso_token_abc123');
  const banStatusNoTenant: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654322', undefined, 'sso_token_def456');
}

Pridobi podkomentarje

Parametri

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

Odgovor

Vrne: GetCommentChildrenResponse

Primer

Primer getCommentChildren

Copy

const commentId: string = "cmt_12345";
const tenantId: string = "tenant_xyz";
const sso: string = "sso_987654";
const fullResponse: GetCommentChildrenResponse = await getCommentChildren(commentId, tenantId, sso);
const minimalResponse: GetCommentChildrenResponse = await getCommentChildren(commentId);

Pridobi število

Parametri

Ime	Tip	Obvezno
textSearch	string	Ne
byIPFromComment	string	Ne
filter	string	Ne
searchFilters	string	Ne
demo	boolean	Ne
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetCountResponse

Primer

Primer getCount

Copy

async function main(): Promise<void> {
  const count: GetCountResponse = await getCount({
    textSearch: "order issue",
    byIPFromComment: "198.51.100.23",
    filter: "pending",
    demo: true,
    tenantId: "acme_corp",
    sso: "sso_abcdef123456"
  });
  console.log(count);
}
main();

Pridobi številke

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Ne
sso	string	Ne

Odziv

Vrne: GetCountsResponse

Primer

Primer getCounts

Copy

async function runExample() {
    const tenantId: string = "acme-corp";
    const ssoToken: string = "sso-token-2024";
    const withBoth: GetCountsResponse = await getCounts(tenantId, ssoToken);
    const withTenantOnly: GetCountsResponse = await getCounts(tenantId);
    const withoutParams: GetCountsResponse = await getCounts();
    console.log(withBoth, withTenantOnly, withoutParams);
}
runExample();

Pridobi dnevnike

Parametri

Ime	Vrsta	Obvezno
commentId	string	Yes
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetLogsResponse

Primer

getLogs Primer

Copy

async function fetchLogs() {
    const commentId: string = "cmt_9a8b7c6d5e4f3a2b";
    const tenantId: string = "tenant_9876";
    const sso: string = "sso_abcdef123456";
    const fullResponse: GetLogsResponse = await getLogs(commentId, tenantId, sso);
    const minimalResponse: GetLogsResponse = await getLogs(commentId);
}

Pridobi ročne značke

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetManualBadgesResponse

Primer

getManualBadges Primer

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // Klic z obema neobveznima parametroma
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // Klic samo s tenantId
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

Pridobi ročne značke za uporabnika

Parameters

Name	Type	Required
badgesUserId	string	No
commentId	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetManualBadgesForUserResponse

Primer

Primer getManualBadgesForUser

Copy

(async () => {
  const userId: string = "user_42";
  const commentId: string = "comment_1001";
  const tenantId: string = "tenant_acme";
  const ssoToken: string = "sso_5f6g7h8i9j";
  const badges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId, commentId, tenantId, ssoToken);
  const limitedBadges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId);
})();

Pridobi moderacijski komentar

Parametri

Ime	Tip	Obvezno
commentId	string	Yes
includeEmail	boolean	No
includeIP	boolean	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetModerationCommentResponse

Primer

Primer getModerationComment

Copy

async function fetchCommentDetails() {
  // Polni nabor parametrov
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // Minimalni klic z uporabo samo zahtevanega argumenta
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // Uporabite rezultate po potrebi...
}

Pridobi besedilo moderacijskega komentarja

Parametri

Ime	Vrsta	Obvezno
commentId	string	Yes
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetModerationCommentTextResponse

Primer

getModerationCommentText Primer

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // Pokličite samo z obveznim parametrom
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // Pokličite z neobveznimi parametri
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

Pridobi povzetek pred prepovedjo

Parametri

Ime	Tip	Obvezno
commentId	string	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetPreBanSummaryResponse

Primer

Primer getPreBanSummary

Copy

const commentId: string = "5f8d0c2e4b1a2c3d4e5f6a7b";
const includeByUserIdAndEmail: boolean = true;
const includeByIP: boolean = true;
const includeByEmailDomain: boolean = false;
const tenantId: string = "tenant-001";
const sso: string = "sso-xyz-123";
const preBanSummary: GetPreBanSummaryResponse = await getPreBanSummary(
  commentId,
  includeByUserIdAndEmail,
  includeByIP,
  includeByEmailDomain,
  tenantId,
  sso
);

Pridobi povzetek iskanja komentarjev

Parametri

Ime	Tip	Obvezno
value	string	No
filters	string	No
searchFilters	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetSearchCommentsSummaryResponse

Primer

getSearchCommentsSummary Primer

Copy

async function runExample(): Promise<void> {
    const searchTerm: string = "fastcomments integration";
    const filterString: string = "status:approved";
    const searchFilterString: string = "author:jane";
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
    const summary: GetSearchCommentsSummaryResponse = await getSearchCommentsSummary(
        searchTerm,
        filterString,
        searchFilterString,
        tenantId,
        ssoToken
    );
    console.log(summary);
}
runExample();

Pridobi strani v iskanju

Parametri

Ime	Tip	Obvezno
value	string	Ne
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetSearchPagesResponse

Primer

Primer getSearchPages

Copy

(async () => {
  const query: string = "network outage";
  const tenantId: string = "tenant-9876";
  const ssoToken: string = "sso-abc123def456";
  const searchResult: GetSearchPagesResponse = await getSearchPages(query, tenantId, ssoToken);
  const searchResultNoSso: GetSearchPagesResponse = await getSearchPages(query, tenantId);
})();

Pridobi spletna mesta v iskanju

Parametri

Ime	Tip	Obvezno
value	string	Ne
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetSearchSitesResponse

Primer

Primer getSearchSites

Copy

async function fetchSites() {
  const value: string = "customer support"
  const tenantId: string = "tenant-9876"
  const sso: string = "sso-abc123"
  const sites: GetSearchSitesResponse = await getSearchSites(value, tenantId, sso)
  const sitesOnlyTenant: GetSearchSitesResponse = await getSearchSites(undefined, tenantId)
}

Pridobi predloge iskanja

Parametri

Ime	Tip	Obvezno
textSearch	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetSearchSuggestResponse

Primer

getSearchSuggest Primer

Copy

async function example(): Promise<void> {
    const term: string = "fastcomments api";
    const tenant: string = "tenant_001";
    const sso: string = "sso_9a8b7c";
    const fullResult: GetSearchSuggestResponse = await getSearchSuggest(term, tenant, sso);
    const partialResult: GetSearchSuggestResponse = await getSearchSuggest(term);
}
example();

Pridobi uporabnike v iskanju

Parametri

Ime	Vrsta	Obvezno
value	string	Ne
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetSearchUsersResponse

Primer

getSearchUsers Primer

Copy

async function demoSearch() {
    const query: string = "john.doe@example.com";
    const tenantId: string = "tenant_12345";
    const ssoToken: string = "sso_token_abc";
    const resultWithSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId, ssoToken);
    const resultWithoutSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId);
}

Pridobi faktor zaupanja

Parametri

Ime	Vrsta	Obvezno
userId	string	Ne
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetTrustFactorResponse

Primer

Primer getTrustFactor

Copy

async function runDemo(): Promise<void> {
    const trustFull: GetTrustFactorResponse = await getTrustFactor("user_12345", "tenant_abc", "sso_token_987");
    const trustUserOnly: GetTrustFactorResponse = await getTrustFactor("user_12345");
    console.log(trustFull, trustUserOnly);
}
runDemo();

Pridobi nastavitve prepovedi uporabnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: GetUserBanPreferenceResponse

Primer

getUserBanPreference Primer

Copy

async function demoGetUserBanPreference(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-2024";
  const sso: string = "sso-token-9f8b7a6c";
  const result: GetUserBanPreferenceResponse = await getUserBanPreference(tenantId, sso);
  console.log(result);
}
demoGetUserBanPreference();

Pridobi notranji profil uporabnika

Parametri

Ime	Tip	Obvezno
commentId	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: GetUserInternalProfileResponse1

Primer

Primer getUserInternalProfile

Copy

(async () => {
  const fullProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_12345",
    tenantId: "tenant_67890",
    sso: "sso_token_abcdef"
  });
  const partialProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_98765"
  });
})();

Prilagodi glasove za komentarje

Parametri

Ime	Tip	Obvezno
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: PostAdjustCommentVotesResponse

Primer

postAdjustCommentVotes Primer

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // dodatna polja, kot zahtevajo AdjustCommentVotesParams
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

Zaženi izvoz API-ja

Parametri

Ime	Vrsta	Obvezno
textSearch	string	Ne
byIPFromComment	string	Ne
filters	string	Ne
searchFilters	string	Ne
sorts	string	Ne
tenantId	string	Ne
sso	string	Ne

Odziv

Vrne: PostApiExportResponse

Primer

postApiExport Primer

Copy

(async () => {
  const textSearch: string = "keyword:feedback"
  const byIPFromComment: string = "203.0.113.45"
  const filters: string = "status:pending,category:support"
  const searchFilters: string = "createdAt>2023-01-01"
  const sorts: string = "createdAt:desc"
  const tenantId: string = "tenant_9876"
  const sso: string = "sso_7e2a9b"
  const exportResult: PostApiExportResponse = await postApiExport(
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    sorts,
    tenantId,
    sso
  )
  console.log(exportResult)
})()

Prepovej uporabnika iz komentarja

Parametri

Ime	Tip	Obvezno
commentId	string	Da
banEmail	boolean	Ne
banEmailDomain	boolean	Ne
banIP	boolean	Ne
deleteAllUsersComments	boolean	Ne
bannedUntil	string	Ne
isShadowBan	boolean	Ne
updateId	string	Ne
banReason	string	Ne
tenantId	string	Ne
sso	string	Ne

Odziv

Vrne: PostBanUserFromCommentResponse

Primer

postBanUserFromComment Primer

Copy

async function runBan() {
  const commentId: string = "cmt_5f8a2b3c";
  const banEmail: boolean = true;
  const banIP: boolean = false;
  const deleteAllUsersComments: boolean = true;
  const bannedUntil: string = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString();
  const isShadowBan: boolean = false;
  const banReason: string = "Repeated spam posting";
  const tenantId: string = "tenant_12345";
  const response: PostBanUserFromCommentResponse = await postBanUserFromComment(
    commentId,
    banEmail,
    undefined,
    banIP,
    deleteAllUsersComments,
    bannedUntil,
    isShadowBan,
    undefined,
    banReason,
    tenantId
  );
  console.log(response);
}
runBan();

Razveljavi prepoved uporabnika

Parametri

Ime	Vrsta	Obvezno
banUserUndoParams	BanUserUndoParams	Da
tenantId	string	Ne
sso	string	Ne

Odziv

Returns: PostBanUserUndoResponse

Primer

postBanUserUndo Primer

Copy

const undoParams: BanUserUndoParams = {
  userId: "user-8421",
  commentId: "comment-6702",
  reason: "Accidental ban"
};
const tenantId: string = "tenant-7f9e";
const ssoToken: string = "sso-4b2c1d";
async function runUndo() {
  const resultAll: PostBanUserUndoResponse = await postBanUserUndo(undoParams, tenantId, ssoToken);
  console.log(resultAll);
  const resultMinimal: PostBanUserUndoResponse = await postBanUserUndo(undoParams);
  console.log(resultMinimal);
}
runUndo();

Masovni povzetek pred prepovedjo

Parametri

Ime	Vrsta	Obvezno
bulkPreBanParams	BulkPreBanParams	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: PostBulkPreBanSummaryResponse

Primer

postBulkPreBanSummary Primer

Copy

async function runExample() {
  const bulkPreBanParams: BulkPreBanParams = {
    userIds: [10234, 56789],
    emails: ["spam_user@example.com", "abuse@badsite.org"],
    ips: ["203.0.113.45", "198.51.100.22"],
    emailDomains: ["maliciousdomain.com"]
  };
  const includeByUserIdAndEmail: boolean = true;
  const includeByIP: boolean = false;
  const includeByEmailDomain: boolean = true;
  const tenantId: string = "tenant_8f4b2c1a";
  const sso: string = "sso-3948abf0";
  const summary: PostBulkPreBanSummaryResponse = await postBulkPreBanSummary(
    bulkPreBanParams,
    includeByUserIdAndEmail,
    includeByIP,
    includeByEmailDomain,
    tenantId,
    sso
  );
  console.log(summary);
}
runExample();

Objavi komentarje po ID-jih

Parametri

Ime	Tip	Obvezno
commentsByIdsParams	CommentsByIdsParams	Da
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: PostCommentsByIdsResponse

Primer

postCommentsByIds Primer

Copy

const commentsByIdsParams: CommentsByIdsParams = {
  commentIds: ['cmt001', 'cmt002'],
  includeUserInfo: true,
  includeThreadInfo: false,
} as CommentsByIdsParams;
const fullResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams,
  'tenant-12345',
  'sso-token-xyz'
);
const minimalResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams
);

Označi komentar (moderacija)

Parametri

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

Odziv

Vrne: PostFlagCommentResponse

Primer

postFlagComment Primer

Copy

const commentId: string = "cmt_20230915_001";
const broadcastId: string = "brd_20230915_live";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc123";
const flaggedResponse: PostFlagCommentResponse = await postFlagComment(
  commentId,
  broadcastId,
  tenantId,
  sso
);

Odstrani komentar (moderacija)

Parametri

Ime	Vrsta	Obvezno
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: PostRemoveCommentResponse

Primer

postRemoveComment Primer

Copy

async function removeCommentExample(): Promise<void> {
  const commentId: string = "cmt_7f9a3e2b";
  const result1: PostRemoveCommentResponse = await postRemoveComment(commentId);
  const broadcastId: string = "brd_12ab34cd";
  const tenantId: string = "tenant_5678efgh";
  const sso: string = "sso_XYZ12345";
  const result2: PostRemoveCommentResponse = await postRemoveComment(commentId, broadcastId, tenantId, sso);
  console.log(result1, result2);
}

Obnovi izbrisani komentar

Parametri

Ime	Vrsta	Obvezno
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Odziv

Vrne: PostRestoreDeletedCommentResponse

Primer

postRestoreDeletedComment Primer

Copy

async function restoreCommentDemo(): Promise<void> {
    const commentId: string = "cmt_5f2a9b7e1234567890abcd";
    const broadcastId: string | undefined = "brd_2023_09";
    const tenantId: string | undefined = "tenant_42";
    const sso: string | undefined = "sso_token_abcdef123456";
    const response: PostRestoreDeletedCommentResponse = await postRestoreDeletedComment(
        commentId,
        broadcastId,
        tenantId,
        sso
    );
    console.log(response);
}
restoreCommentDemo();

Nastavi status odobritve komentarja

Parametri

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

Odgovor

Vrne: PostSetCommentApprovalStatusResponse

Primer

postSetCommentApprovalStatus Primer

Copy

async function main() {
  const commentIdOnly: string = "cmt_1001";
  const resultOnly: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(commentIdOnly);
  const commentIdFull: string = "cmt_2002";
  const approvedFull: boolean = true;
  const broadcastIdFull: string = "brd_3003";
  const tenantIdFull: string = "tenant_abc";
  const ssoFull: string = "sso_token_xyz";
  const resultFull: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(
    commentIdFull,
    approvedFull,
    broadcastIdFull,
    tenantIdFull,
    ssoFull
  );
  console.log(resultOnly, resultFull);
}
main();

Nastavi status pregleda komentarja

Parametri

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

Odziv

Vrne: PostSetCommentReviewStatusResponse

Primer

postSetCommentReviewStatus Primer

Copy

async function updateCommentReviewStatus(): Promise<void> {
  const commentId: string = "cmt_9f8a7b6c5d4e3f2a1b0c";
  const reviewed: boolean = true;
  const broadcastId: string = "broadcast_2024Q1";
  const tenantId: string = "tenant_1001";
  const sso: string = "alice@example.com";
  const response: PostSetCommentReviewStatusResponse = await postSetCommentReviewStatus(
    commentId,
    reviewed,
    broadcastId,
    tenantId,
    sso
  );
  console.log(response);
}

Nastavi status spama komentarja

Parametri

Ime	Tip	Obvezno
commentId	string	Da
spam	boolean	Ne
permNotSpam	boolean	Ne
broadcastId	string	Ne
tenantId	string	Ne
sso	string	Ne

Odgovor

Vrne: PostSetCommentSpamStatusResponse

Primer

postSetCommentSpamStatus Primer

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // Samo obvezen parameter
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // Vsi neobvezni parametri podani
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

Nastavi besedilo komentarja (moderacija)

Parametri

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

Odgovor

Vrne: PostSetCommentTextResponse

Primer

postSetCommentText Primer

Copy

(async () => {
  const commentId: string = "cmt_9f8b7a6d5e4c3b2a1";
  const setParams: SetCommentTextParams = {
    text: "Edited comment to correct a typo and add clarification."
  };
  const broadcastId: string = "brd_1a2b3c4d5e6f7g8h9";
  const tenantId: string = "tenant_xyz123";
  const sso: string = "sso_user_456def";
  const fullResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams,
    broadcastId,
    tenantId,
    sso
  );
  const minimalResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams
  );
  console.log(fullResult, minimalResult);
})();

Odstrani označitev komentarja

Parametri

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

Odziv

Vrne: PostUnFlagCommentResponse

Primer

postUnFlagComment Primer

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // ID komentarja
    "brd_67890",          // broadcastId (neobvezno)
    "tenant_abc",         // tenantId (neobvezno)
    "sso_user_token_789"  // sso (neobvezno)
  );
};

Oddaj glas

Parametri

Ime	Tip	Obvezno
commentId	string	Yes
direction	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Odziv

Vrne: PostVoteResponse

Primer

postVote Primer

Copy

let commentId: string = 'cmt_12345';
let direction: string = 'up';
let broadcastId: string = 'brd_67890';
let tenantId: string = 'tenant_abc';
let sso: string = 'sso_token_xyz';
const fullVote: PostVoteResponse = await postVote(
  commentId,
  direction,
  broadcastId,
  tenantId,
  sso
);
const simpleVote: PostVoteResponse = await postVote('cmt_67890');

Dodeli značko

Parametri

Ime	Tip	Potrebno
badgeId	string	Da
userId	string	Ne
commentId	string	Ne
broadcastId	string	Ne
tenantId	string	Ne
sso	string	Ne

Odziv

Vrne: PutAwardBadgeResponse

Primer

putAwardBadge Primer

Copy

(async () => {
    const badgeId: string = "badge-superstar"
    const userId: string = "user-42"
    const commentId: string = "comment-7f9c3"
    const broadcastId: string = "broadcast-2023-09"
    const result: PutAwardBadgeResponse = await putAwardBadge(badgeId, userId, commentId, broadcastId)
    console.log(result)
})()

Zapri nit

Parametri

Ime	Tip	Obvezno
urlId	string	Yes
tenantId	string	No
sso	string	No

Odgovor

Vrne: PutCloseThreadResponse

Primer

putCloseThread Primer

Copy

async function closeThreadDemo(): Promise<void> {
  const urlId: string = "article-2023-09-15";
  const tenantId: string = "tenant-42";
  const sso: string = "sso-token-xyz";
  const response: PutCloseThreadResponse = await putCloseThread(urlId, tenantId, sso);
  console.log(response);
}
closeThreadDemo();

Odstrani značko

Parametri

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

Odgovor

Vrne: PutRemoveBadgeResponse

Primer

putRemoveBadge Primer

Copy

const badgeId: string = "badge-12345";
const userId: string = "user-9876";
const commentId: string = "comment-5555";
const broadcastId: string = "broadcast-001";
const result: PutRemoveBadgeResponse = await putRemoveBadge(
  badgeId,
  userId,
  commentId,
  broadcastId
);

Znova odpri nit

Parametri

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

Odgovor

Vrne: PutReopenThreadResponse

Primer

putReopenThread Primer

Copy

async function exampleUsage() {
  const urlId: string = "thread-9f8b7c6a";
  const tenantId: string = "tenant-001";
  const sso: string = "sso-3f9d2e1a";
  const resultAll: PutReopenThreadResponse = await putReopenThread(urlId, tenantId, sso);
  console.log(resultAll);
  const resultMinimal: PutReopenThreadResponse = await putReopenThread(urlId);
  console.log(resultMinimal);
}

Nastavi faktor zaupanja

Parametri

Ime	Vrsta	Obvezno
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

Odgovor

Vrne: SetTrustFactorResponse

Primer

setTrustFactor Primer

Copy

(async () => {
  const userId: string = "user_8421";
  const trustFactor: string = "high";
  const tenantId: string = "tenant_33";
  const ssoToken: string = "sso_7d9f";
  const fullResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor, tenantId, ssoToken);
  const minimalResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor);
})();

Ustvari moderatorja

Parameters

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
createModeratorBody	CreateModeratorBody	Da

Response

Vrne: CreateModeratorResponse1

Primer

Primer createModerator

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // opcijska polja, kot je opis, so izpuščena
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

Izbriši moderatorja

Parametri

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

Odgovor

Vrne: DeleteModeratorResponse

Primer

deleteModerator Primer

Copy

async function runDeleteModeratorExample() {
  const tenantId: string = "tenant_2023";
  const moderatorId: string = "mod_001";
  const notificationEmail: string = "admin@mycompany.com";
  const resultWithEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId, notificationEmail);
  const resultWithoutEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId);
}

Pridobi moderatorja

Parametri

Ime	Vrsta	Potrebno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetModeratorResponse1

Primer

getModerator Primer

Copy

(async () => {
  const tenantId: string = "acme-corp-001";
  const id: string = "mod-12345";
  const result: GetModeratorResponse1 = await getModerator(tenantId, id);
  const moderatorName: string | undefined = result.moderator?.name;
  console.log(moderatorName);
})();

Pridobi moderatorje

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
skip	number	No

Odgovor

Vrne: GetModeratorsResponse1

Primer

getModerators Primer

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // neobvezni zamik paginacije
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // Primer brez paginacije:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

Pošlji povabilo

Parametri

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

Odgovor

Vrne: SendInviteResponse

Primer

sendInvite Primer

Copy

const tenantId: string = "acme-corp-tenant";
const inviteId: string = "invite-12345";
const fromName: string = "John Doe";
const inviteResult: SendInviteResponse = await sendInvite(tenantId, inviteId, fromName);

Posodobi moderatorja

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
id	string	Da
updateModeratorBody	UpdateModeratorBody	Da

Odgovor

Vrne: UpdateModeratorResponse

Primer

updateModerator Primer

Copy

async function demoUpdateModerator(): Promise<void> {
    const tenantId: string = "tenant_42abc";
    const moderatorId: string = "moderator_8f9e";
    const updateBody: UpdateModeratorBody = {
        isActive: true,
        role: "admin",
        // opcijsko polje
        notes: "Promoted to senior moderator"
    };
    const result: UpdateModeratorResponse = await updateModerator(tenantId, moderatorId, updateBody);
    console.log(result);
}
demoUpdateModerator();

Izbriši število obvestil

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
id	string	Da

Odziv

Vrne: DeleteNotificationCountResponse

Primer

deleteNotificationCount Primer

Copy

async function run() {
  const tenantId: string = "tenant_12345";
  const notificationId: string = "notif_98765";
  const result: DeleteNotificationCountResponse = await deleteNotificationCount(tenantId, notificationId);
  console.log(result);
}
run();

Pridobi predpomnjeno število obvestil

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetCachedNotificationCountResponse1

Primer

getCachedNotificationCount Primer

Copy

const tenantId: string = "e3f1a9b2-4c5d-6e7f-8a9b-0c1d2e3f4a5b";
const userId: string = "u-20231101-001";
const notificationResult: GetCachedNotificationCountResponse1 = await getCachedNotificationCount(tenantId, userId);
console.log(notificationResult);

Pridobi število obvestil

Parameters

Ime	Vrsta	Obvezno
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

Response

Vrne: GetNotificationCountResponse1

Example

Primer getNotificationCount

Copy

async function demoNotificationCount() {
    const tenantId: string = "tenant_001";
    const userId: string = "user_42";
    const urlId: string = "url_9f8e7d";
    const fromCommentId: string = "comment_12345";
    const viewed: boolean = false;
    const type: string = "mention";
    const result: GetNotificationCountResponse1 = await getNotificationCount(
        tenantId,
        userId,
        urlId,
        fromCommentId,
        viewed,
        type
    );
    console.log(result);
}
demoNotificationCount();

Pridobi obvestila

Parametri

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

Odziv

Vrne: GetNotificationsResponse1

Primer

getNotifications Primer

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const notifications: GetNotificationsResponse1 = await getNotifications(tenantId, userId);
  console.log(notifications);
  const more: GetNotificationsResponse1 = await getNotifications(
    tenantId,
    undefined,
    "article-5678",
    undefined,
    true,
    "reply",
    10
  );
  console.log(more);
}
demo();

Posodobi obvestilo

Parametri

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

Odgovor

Vrne: UpdateNotificationResponse

Primer

Primer updateNotification

Copy

const tenantId: string = "tenant_5f4d2c";
const notificationId: string = "notif_9b8a7c";
const updateBody: UpdateNotificationBody = {
  enabled: false,
  sendEmail: true,
  schedule: "2023-12-01T08:00:00Z"
};
const userId: string = "user_123e4567";
const responseWithUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody,
  userId
);
const responseWithoutUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody
);

Ustvari V1 reakcijo strani

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
title	string	No

Odgovor

Vrne: CreateV1PageReactResponse

Primer

createV1PageReact Primer

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "article-2024-06-improvements";
const title: string = "FastComments API Integration Guide";
const responseWithTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId, title);
const responseWithoutTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId);

Ustvari V2 reakcijo strani

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
id	string	Da
title	string	Ne

Odgovor

Vrne: CreateV2PageReactResponse

Primer

createV2PageReact Primer

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const urlId: string = "blog/posts/fastcomments-integration";
  const pageId: string = "page-12345";
  const title: string = "FastComments API Integration Guide";
  const responseWithoutTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId);
  const responseWithTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId, title);
  console.log(responseWithoutTitle, responseWithTitle);
})();

Izbriši V1 reakcijo strani

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Vrne: DeleteV1PageReactResponse

Primer

deleteV1PageReact Primer

Copy

const tenantId: string = "acme-corp";
const urlId: string = "article-2024-06-01";
const response: DeleteV1PageReactResponse = await deleteV1PageReact(tenantId, urlId);
console.log(response);

Izbriši V2 reakcijo strani

Parameters

Ime	Vrsta	Obvezno
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Odgovor

Vrne: DeleteV2PageReactResponse

Primer

deleteV2PageReact Primer

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "page_98765";
const reactionId: string = "react_abcde";
const deleteResult: DeleteV2PageReactResponse = await deleteV2PageReact(tenantId, urlId, reactionId);

Pridobi V1 všečke strani

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: GetV1PageLikesResponse

Primer

getV1PageLikes Primer

Copy

async function fetchPageLikes() {
  const tenantId: string = "acme-corp-tenant-42";
  const urlId: string = "blog-post-2024-06-typescript-best-practices";
  const likes: GetV1PageLikesResponse = await getV1PageLikes(tenantId, urlId);
  console.log(likes);
}

Pridobi V2 reakcije strani

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Vrne: GetV2PageReactsResponse

Primer

getV2PageReacts Primer

Copy

async function demoGetPageReacts(): Promise<void> {
    const tenantId: string = "acme-corp-tenant";
    const urlId: string = "article-2024-06-01";
    const reacts: GetV2PageReactsResponse = await getV2PageReacts(tenantId, urlId);
    // primer neobveznega dostopa do lastnosti
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

Pridobi uporabnike V2 reakcij strani

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
urlId	string	Da
id	string	Da

Odgovor

Vrne: GetV2PageReactUsersResponse1

Primer

getV2PageReactUsers Primer

Copy

async function fetchReactUsers() {
  const tenantId: string = 'tenant_12345';
  const urlId: string = 'article-9876';
  const id: string = 'user_abcde';
  const response: GetV2PageReactUsersResponse1 = await getV2PageReactUsers(tenantId, urlId, id);
  console.log(response);
}
fetchReactUsers();

Dodaj stran

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPIPageData	CreateAPIPageData	Da

Odgovor

Vrne: AddPageAPIResponse

Primer

Primer addPage

Copy

const tenantId: string = "tenant_9f8432b1-4c2e-4f9d-8a5d-7bc9e2f6d9a0";
const pageData: CreateAPIPageData = {
    url: "https://example.com/articles/fastcomments-intro",
    title: "FastComments Introduction",
    description: "An introductory guide to FastComments API usage.",
    tags: ["fastcomments", "api", "tutorial"],
    metadata: {
        author: "Jane Doe",
        publishedAt: "2024-03-15T08:00:00Z"
    }
};
const response: AddPageAPIResponse = await addPage(tenantId, pageData);

Izbriši stran

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeletePageAPIResponse

Primer

deletePage Primer

Copy

async function example() {
    const tenantId: string = "acme-corp-001";
    const pageId: string = "page-987654321";
    const result: DeletePageAPIResponse = await deletePage(tenantId, pageId);
    console.log(result);
}
example();

Pridobi uporabnike, ki niso povezani

Prejšnji komentatorji na strani, ki trenutno NI online. Razvrščeni po displayName.
Uporabite to po tem, ko ste izčrpali /users/online, za prikaz sekcije “Člani”.
Kazalna paginacija po commenterName: strežnik prehaja delni {tenantId, urlId, commenterName} indeks od afterName naprej prek $gt, brez stroška $skip.

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
urlId	string	Da
afterName	string	Ne
afterUserId	string	Ne

Odgovor

Vrne: GetOfflineUsersResponse

Primer

getOfflineUsers Primer

Copy

async function fetchOfflineUsers(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "thread_9876";
    const afterName: string = "Jane Smith";
    const afterUserId: string = "user_7f9b3c";
    const offlineUsers: GetOfflineUsersResponse = await getOfflineUsers(
        tenantId,
        urlId,
        afterName,
        afterUserId
    );
    console.log(offlineUsers);
}

Pridobi uporabnike, ki so online

Trenutno povezani gledalci strani: ljudje, katerih seje WebSocket so trenutno naročene na stran.
Vrne anonCount + totalCount (število naročnikov v celotni sobi, vključno z anonimnimi gledalci, ki jih ne poimenujemo).

Parametri

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Odziv

Vrne: GetOnlineUsersResponse

Primer

Primer getOnlineUsers

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // Z neobveznimi parametri za stránkovanje
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // Brez neobveznih parametrov za stránkovanje
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

Pridobi stran po URL ID-ju

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: GetPageByURLIdAPIResponse

Primer

getPageByURLId Primer

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_9876";
  const response: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
  const page: APIPage | undefined = response.page;
})();

Pridobi strani

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Response

Vrne: GetPagesAPIResponse

Example

Primer getPages

Copy

const tenantId: string = "tenant_12345";
(async () => {
  const response: GetPagesAPIResponse = await getPages(tenantId);
  const firstPage: APIPage | undefined = response.pages?.[0];
  console.log(firstPage?.title);
})();

Pridobi javne strani

List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires enableFChat to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.

Parameters

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

Response

Vrne: GetPagesPublicResponse

Example

getPagesPublic Primer

Copy

async function fetchPages() {
  const tenantId: string = "tenant_12345";
  const cursor: string = "nextPageToken";
  const limit: number = 20;
  const q: string = "blog";
  const sortBy: PagesSortBy = "createdAt";
  const hasComments: boolean = true;
  const response: GetPagesPublicResponse = await getPagesPublic(
    tenantId,
    cursor,
    limit,
    q,
    sortBy,
    hasComments
  );
  console.log(response);
}

Pridobi informacije o uporabnikih

Masovni podatki o uporabniku za najemnika. Glede na userIds vrne prikazne informacije iz User / SSOUser.
Uporablja vtičnik za komentarje za obogatitev uporabnikov, ki se so pravkar pojavili prek dogodka prisotnosti.
Ni konteksta strani: zasebnost se izvaja enotno (zasebni profili so maskirani).

Parameters

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
ids	string	Yes

Response

Vrne: GetUsersInfoResponse

Primer

Primer getUsersInfo

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Optional fields in the response may be undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

Delno posodobi stran

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Da
updateAPIPageData	UpdateAPIPageData	Da

Odgovor

Vrne: PatchPageAPIResponse

Primer

patchPage Primer

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string lahko izpustimo
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

Izbriši čakajoči webhook dogodek

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeletePendingWebhookEventResponse

Primer

deletePendingWebhookEvent Primer

Copy

async function runDemo() {
  const tenantId: string = 'c3f5e9d2-1a2b-4c3d-9e7f-1234567890ab';
  const eventId: string = 'event_987654321';
  const response: DeletePendingWebhookEventResponse = await deletePendingWebhookEvent(tenantId, eventId);
  console.log(response);
}
runDemo();

Pridobi število čakajočih webhook dogodkov

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Odgovor

Vrne: GetPendingWebhookEventCountResponse1

Primer

getPendingWebhookEventCount Primer

Copy

(async () => {
  const tenantId: string = "tenant_001";
  const responseAll: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(
    tenantId,
    "comment_456",
    "ext_789",
    "comment.updated",
    "webhook",
    "mydomain.com",
    3
  );
  const responseMinimal: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(tenantId);
  console.log(responseAll, responseMinimal);
})();

Pridobi čakajoče webhook dogodke

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

Odgovor

Vrne: GetPendingWebhookEventsResponse1

Primer

Primer getPendingWebhookEvents

Copy

async function fetchPendingEvents(): Promise<void> {
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const commentId: string = "cmt-987654321";
    const externalId: string = "ext-abc-123";
    const eventType: string = "comment_created";
    const type: string = "outbound";
    const domain: string = "myblog.com";
    const attemptCountGT: number = 3;
    const skip: number = 0;
    const pending: GetPendingWebhookEventsResponse1 = await getPendingWebhookEvents(
        tenantId,
        commentId,
        externalId,
        eventType,
        type,
        domain,
        attemptCountGT,
        skip
    );
    console.log(pending);
}
fetchPendingEvents();

Ustvari konfiguracijo vprašanja

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

Odgovor

Vrne: CreateQuestionConfigResponse1

Primer

createQuestionConfig Primer

Copy

const tenantId: string = "tenant_12345";
const customOption: QuestionConfigCustomOptionsInner = {
  label: "Option A",
  value: "a",
};
const createQuestionConfigBody: CreateQuestionConfigBody = {
  questionText: "What is your favorite color?",
  isActive: true,
  // neobvezna polja je mogoče izpustiti
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

Izbriši konfiguracijo vprašanja

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeleteQuestionConfigResponse

Primer

deleteQuestionConfig Primer

Copy

async function runDeletion(): Promise<void> {
  const tenantId: string = "tenant_8f5a2c9d";
  const configId: string = "questionConfig_4b7e1f";
  const deleteResult: DeleteQuestionConfigResponse = await deleteQuestionConfig(tenantId, configId);
  console.log(deleteResult);
}
void runDeletion();

Pridobi konfiguracijo vprašanja

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetQuestionConfigResponse1

Primer

Primer getQuestionConfig

Copy

const tenantId: string = "acme-corp-tenant-42";
const questionId: string = "question-7f9b3e";
const response: GetQuestionConfigResponse1 = await getQuestionConfig(tenantId, questionId);

Pridobi konfiguracije vprašanj

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetQuestionConfigsResponse1

Primer

getQuestionConfigs Primer

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // Klic brez izbirnega parametra 'skip'
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // Klic z izbirnim parametrom 'skip'
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

Posodobi konfiguracijo vprašanja

Parametri

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

Odgovor

Vrne: UpdateQuestionConfigResponse

Primer

updateQuestionConfig Primer

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // prikazani izbirni polji
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

Ustvari rezultat vprašanja

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
createQuestionResultBody	CreateQuestionResultBody	Da

Odgovor

Vrne: CreateQuestionResultResponse1

Primer

createQuestionResult Primer

Copy

const tenantId: string = "acme-corp-tenant";
const metaItem: MetaItem = {
  key: "campaign",
  value: "spring-launch"
};
const questionResultBody: CreateQuestionResultBody = {
  questionId: "question-42",
  answer: "Positive",
  metadata: [metaItem]
  // izbirna polja, kot so opombe, so izpuščena
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

Izbriši rezultat vprašanja

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeleteQuestionResultResponse

Primer

deleteQuestionResult Primer

Copy

async function runDeletion(): Promise<void> {
    const tenantId: string = "tenant-001";
    const resultId: string = "c9f2a5b3-7e6d-4c9a-8b1f-2d3e4f5a6b7c";
    const result: DeleteQuestionResultResponse = await deleteQuestionResult(tenantId, resultId);
    console.log(result);
}
runDeletion();

Pridobi rezultat vprašanja

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetQuestionResultResponse1

Primer

getQuestionResult Primer

Copy

async function fetchQuestionResult(): Promise<void> {
    const tenantId: string = "acme-corp-001";
    const questionId: string = "question-7a9b8c";
    const result: GetQuestionResultResponse1 = await getQuestionResult(tenantId, questionId);
    const question: QuestionResult | undefined = result.questionResult;
    const firstMeta: MetaItem | undefined = result.meta?.[0];
    console.log(question?.id, firstMeta?.key);
}

Pridobi rezultate vprašanj

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Odgovor

Vrne: GetQuestionResultsResponse1

Primer

getQuestionResults Primer

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const urlId: string = "post-456";
  const userId: string = "user-789";
  const startDate: string = "2023-09-01T00:00:00Z";
  const questionId: string = "q-101";
  const questionIds: string = "q-102,q-103";
  const skip: number = 20;
  const results: GetQuestionResultsResponse1 = await getQuestionResults(
    tenantId,
    urlId,
    userId,
    startDate,
    questionId,
    questionIds,
    skip
  );
  console.log(results);
})();

Posodobi rezultat vprašanja

Parametri

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

Odgovor

Vrača: UpdateQuestionResultResponse

Primer

Primer updateQuestionResult

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // obvezna polja
        answer: "No",
        // neobvezna polja
        comment: "User clarified their response",
        // anotherOptionalField?: value,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

Agregiraj rezultate vprašanj

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Odgovor

Vrne: AggregateQuestionResultsResponse1

Primer

aggregateQuestionResults Primer

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const questionId: string = "feedback-rating";
  const questionIds: string[] = ["feedback-rating", "recommendation"];
  const urlId: string = "https://myblog.com/articles/42";
  const timeBucket: AggregateTimeBucket = "month";
  const startDate: Date = new Date("2023-01-01T00:00:00Z");
  const forceRecalculate: boolean = true;
  const result: AggregateQuestionResultsResponse1 = await aggregateQuestionResults(
    tenantId,
    questionId,
    questionIds,
    urlId,
    timeBucket,
    startDate,
    forceRecalculate
  );
  console.log(result);
})();

Masovna agregacija rezultatov vprašanj

Parameters

Ime	Tip	Obvezno
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Yes
forceRecalculate	boolean	No

Response

Vrne: BulkAggregateQuestionResultsResponse1

Example

bulkAggregateQuestionResults Primer

Copy

const tenantId: string = "acme-corp";
const request: BulkAggregateQuestionResultsRequest = {
  questionIds: ["product-satisfaction", "feature-usage"],
  startDate: "2024-01-01T00:00:00Z",
  endDate: "2024-01-31T23:59:59Z",
  timeBucket: "day"
};
const result: BulkAggregateQuestionResultsResponse1 = await bulkAggregateQuestionResults(
  tenantId,
  request,
  true
);

Združi komentarje z rezultati vprašanj

Parametri

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

Odziv

Vrne: CombineCommentsWithQuestionResultsResponse

Primer

combineCommentsWithQuestionResults Primer

Copy

const tenantId: string = "tenant_12345";
const questionIds: string[] = ["question_1", "question_2"];
const urlId: string = "article-9876";
const startDate: Date = new Date("2023-01-01T00:00:00Z");
const forceRecalculate: boolean = false;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResultsResponse = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

Dodaj SSO uporabnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPISSOUserData	CreateAPISSOUserData	Da

Odgovor

Returns: AddSSOUserAPIResponse

Primer

Primer addSSOUser

Copy

const tenantId: string = "tenant_12345";
const newUser: CreateAPISSOUserData = {
  userId: "sso_user_987",
  name: "Jane Doe",
  email: "jane.doe@example.com",
  // opcijsko polje
  avatarUrl: "https://example.com/avatars/jane.jpg",
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, newUser);

Izbriši SSO uporabnika

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

Odgovor

Vrne: DeleteSSOUserAPIResponse

Primer

deleteSSOUser Primer

Copy

const tenantId: string = "acme-corp-tenant";
const userId: string = "sso-user-42";
const deleteComments: boolean = true;
const commentDeleteMode: string = "hard";
const detailedResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId,
  deleteComments,
  commentDeleteMode
);
const simpleResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId
);

Pridobi SSO uporabnika po e-pošti

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
email	string	Yes

Odziv

Vrne: GetSSOUserByEmailAPIResponse

Primer

getSSOUserByEmail Primer

Copy

async function fetchSSOUser() {
  const tenantId: string = "tenant_12345";
  const email: string = "john.doe@example.com";
  const result: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
  const user: APISSOUser | undefined = result?.user;
}

Pridobi SSO uporabnika po ID-ju

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetSSOUserByIdAPIResponse

Primer

getSSOUserById Primer

Copy

async function fetchUser() {
  const tenantId: string = "tenant-987654321";
  const userId: string = "sso-user-abc123";
  const result: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, userId);
  const ssoUser: APISSOUser = result.user;
}

Pridobi SSO uporabnike

Parametri

Ime	Tip	Potrebno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetSSOUsersResponse

Primer

Primer getSSOUsers

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // Call without optional `skip`
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // Call with optional `skip`
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

Delno posodobi SSO uporabnika

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

Odgovor

Vrne: PatchSSOUserAPIResponse

Primer

patchSSOUser Primer

Copy

const tenantId: string = "c1f2a3b4-5678-90ab-cdef-1234567890ab";
const userId: string = "user-987654321";
const updateData: UpdateAPISSOUserData = {
  email: "jane.smith@enterprise.com",
  displayName: "Jane Smith",
  role: "editor"
};
const responseWithComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData,
  true
);
const responseWithoutComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData
);

Zamenjaj SSO uporabnika

Parametri

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

Odziv

Vrne: PutSSOUserAPIResponse

Primer

putSSOUser Primer

Copy

(async () => {
  const tenantId: string = "tenant_abc123";
  const userId: string = "user_456def";
  const updateData: UpdateAPISSOUserData = {
    email: "jane.doe@example.com",
    displayName: "Jane Doe",
    isActive: true,
  };
  const response: PutSSOUserAPIResponse = await putSSOUser(tenantId, userId, updateData, true);
})();

Ustvari naročnino

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

Odgovor

Vrne: CreateSubscriptionAPIResponse

Primer

Primer createSubscription

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const subscriptionData: CreateAPIUserSubscriptionData = {
        userId: "user-456",
        planId: "premium-monthly",
        startDate: new Date(),
        trialPeriodDays: 14 // neobvezno polje
    };
    const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, subscriptionData);
    console.log(result);
})();

Izbriši naročnino

Parametri

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

Odgovor

Vrne: DeleteSubscriptionAPIResponse

Primer

deleteSubscription Primer

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // Z neobveznim userId
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // Brez neobveznega userId
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

Pridobi naročnine

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
userId	string	No

Odgovor

Vrne: GetSubscriptionsAPIResponse

Primer

getSubscriptions Primer

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const userId: string = "user-789";
    const responseWithUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
    const responseWithoutUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
})();

Posodobi naročnino

Parametri

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

Odgovor

Vrne: UpdateSubscriptionAPIResponse

Primer

Primer updateSubscription

Copy

const tenantId: string = "tenant_12345";
const subscriptionId: string = "sub_98765";
const updateData: UpdateAPIUserSubscriptionData = {
  planId: "premium_plan",
  status: "active",
  renewalDate: "2024-12-31",
};
const userId: string = "user_abcde";
const response: UpdateSubscriptionAPIResponse = await updateSubscription(
  tenantId,
  subscriptionId,
  updateData,
  userId
);

Pridobi dnevne uporabe najemnika

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

Odgovor

Vrne: GetTenantDailyUsagesResponse1

Primer

Primer getTenantDailyUsages

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // Maj
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // Uporaba samo obveznih in enega izbirnega parametra
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

Ustvari paket najemnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantPackageBody	CreateTenantPackageBody	Da

Odgovor

Vrne: CreateTenantPackageResponse1

Primer

createTenantPackage Primer

Copy

(async () => {
  const tenantId: string = "tenant-9876";
  const body: CreateTenantPackageBody = {
    packageName: "Standard",
    quota: 5000,
    // neobvezno polje
    description: "Standard package for medium traffic",
  };
  const result: CreateTenantPackageResponse1 = await createTenantPackage(tenantId, body);
  console.log(result);
})();

Izbriši paket najemnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeleteTenantPackageResponse

Primer

deleteTenantPackage Primer

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // uporabi rezultat po potrebi
}
removeTenantPackage();

Pridobi paket najemnika

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetTenantPackageResponse1

Primer

Primer getTenantPackage

Copy

async function fetchTenantPackage(): Promise<void> {
    const tenantId: string = "acme-tenant-2024";
    const packageId: string = "premium-package-01";
    const response: GetTenantPackageResponse1 = await getTenantPackage(tenantId, packageId);
    // Neobvezna polja v odgovoru
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

Pridobi pakete najemnika

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odgovor

Vrne: GetTenantPackagesResponse1

Primer

getTenantPackages Primer

Copy

(async () => {
  const tenantId: string = 'tenant_67890';
  const skip: number = 30;
  const packagesWithSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId, skip);
  const packagesWithoutSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId);
  console.log(packagesWithSkip, packagesWithoutSkip);
})();

Zamenjaj paket najemnika

Parametri

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

Odgovor

Vrne: ReplaceTenantPackageResponse

Primer

replaceTenantPackage Primer

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // polja za prilagojeno konfiguracijo tukaj
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // neobvezna prilagojena konfiguracija
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

Posodobi paket najemnika

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	Yes
updateTenantPackageBody	UpdateTenantPackageBody	Yes

Odgovor

Vrne: UpdateTenantPackageResponse

Primer

Primer updateTenantPackage

Copy

const tenantId: string = "tenant-9876";
const packageId: string = "pkg-2023";
const customConfig: CustomConfigParameters = {
  enableSpamFilter: true,
  spamRatingThreshold: 4,
};
const updateBody: UpdateTenantPackageBody = {
  displayName: "Enterprise Pro",
  customConfig,
};
const response: UpdateTenantPackageResponse = await updateTenantPackage(
  tenantId,
  packageId,
  updateBody
);

Ustvari uporabnika najemnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	Yes

Odgovor

Vrne: CreateTenantUserResponse1

Primer

createTenantUser Primer

Copy

const tenantId: string = "a1b2c3d4-5678-90ab-cdef-1234567890ab";
const newUser: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "admin",
  // optionalni parametri
  phoneNumber: "+15551234567",
  isActive: true,
};
const result: CreateTenantUserResponse1 = await createTenantUser(tenantId, newUser);

Izbriši uporabnika najemnika

Parameters

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

Response

Vrne: DeleteTenantUserResponse

Primer

deleteTenantUser Primer

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // Izbriši uporabnika in vse njegove komentarje, z načinom trde brisanje
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // Izbriši uporabnika brez odstranjevanja komentarjev (privzeto vedenje)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

Pridobi uporabnika najemnika

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetTenantUserResponse1

Primer

Primer getTenantUser

Copy

async function fetchUser(): Promise<void> {
  const tenantId: string = "tenant-01a2b3c";
  const userId: string = "user-7890";
  const result: GetTenantUserResponse1 = await getTenantUser(tenantId, userId);
  console.log(result);
}

Pridobi uporabnike najemnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	number	Ne

Odziv

Vrne: GetTenantUsersResponse1

Primer

Primer getTenantUsers

Copy

(async () => {
  const tenantId: string = "tenant_9f7a2c";
  const skip: number = 25;
  const usersPage: GetTenantUsersResponse1 = await getTenantUsers(tenantId, skip);
  const allUsers: GetTenantUsersResponse1 = await getTenantUsers(tenantId);
})();

Zamenjaj uporabnika najemnika

Parametri

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

Odgovor

Vrne: ReplaceTenantUserResponse

Primer

replaceTenantUser Primer

Copy

async function updateUser() {
  const tenantId: string = "c3d1f2e4-5b6a-4c7d-9f2e-1234567890ab";
  const userId: string = "u-654321";
  const replaceBody: ReplaceTenantUserBody = {
    email: "newuser@example.com",
    username: "newusername"
  };
  const response: ReplaceTenantUserResponse = await replaceTenantUser(
    tenantId,
    userId,
    replaceBody,
    "true"
  );
  console.log(response);
}
updateUser();

Pošlji povezavo za prijavo

Parametri

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

Odgovor

Vrne: SendLoginLinkResponse

Primer

sendLoginLink Primer

Copy

async function demoSendLoginLink() {
  const tenantId: string = "acme-corp";
  const userId: string = "user-9876";
  const redirectURL: string = "https://app.acme-corp.com/auth/callback";
  const resultWithRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId, redirectURL);
  const resultWithoutRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId);
}

Posodobi uporabnika najemnika

Parametri

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

Odgovor

Vrne: UpdateTenantUserResponse

Primer

Primer updateTenantUser

Copy

let tenantId: string = "5f8f8c1a2e9b3c001c2a9b2d";
let userId: string = "user_98765";
let updateBody: UpdateTenantUserBody = {
  email: "jane.smith@example.com",
  role: "moderator",
  isActive: false,
};
let updateComments: string = "Deactivated user due to policy violation.";
let result: UpdateTenantUserResponse = await updateTenantUser(tenantId, userId, updateBody, updateComments);

Ustvari najemnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantBody	CreateTenantBody	Da

Odgovor

Vrne: CreateTenantResponse1

Primer

createTenant Primer

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // obvezna polja
    name: 'Acme International',
    // izbirna polja lahko po potrebi dodate, npr.:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

Izbriši najemnika

Parameters

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

Response

Vrne: DeleteTenantResponse

Example

deleteTenant Primer

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // Klic z neobveznim parametrom 'sure'
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // Klic brez neobveznega parametra 'sure'
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

Pridobi najemnika

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Returns: GetTenantResponse1

Primer

Primer getTenant

Copy

async function fetchTenant(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const id: string = "user_9876";
  const tenantInfo: GetTenantResponse1 = await getTenant(tenantId, id);
  console.log(tenantInfo);
}
fetchTenant();

Pridobi najemnike

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
meta	string	No
skip	number	No

Odgovor

Vrne: GetTenantsResponse1

Primer

getTenants Primer

Copy

(async () => {
  const tenantId: string = "tenant-9f8e7d6c";
  const resultOnlyId: GetTenantsResponse1 = await getTenants(tenantId);
  const resultWithMeta: GetTenantsResponse1 = await getTenants(tenantId, "full");
  const resultAllParams: GetTenantsResponse1 = await getTenants(tenantId, "full", 15);
  console.log(resultOnlyId, resultWithMeta, resultAllParams);
})();

Posodobi najemnika

Parametri

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

Odgovor

Vrne: UpdateTenantResponse

Primer

Primer updateTenant

Copy

const tenantId: string = "c8f9e3d2-4b6a-11ee-8c99-0242ac130003";
const id: string = "tenant-config-01";
const updateBody: UpdateTenantBody = {
  domain: "mytenant.fastcomments.io",
  branding: {
    logoUrl: "https://cdn.mytenant.com/assets/logo.png"
  },
  description: "Branding update for Q3"
};
const response: UpdateTenantResponse = await updateTenant(tenantId, id, updateBody);
console.log(response);

Spremeni stanje vozovnice

Parametri

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

Odgovor

Vrne: ChangeTicketStateResponse1

Primer

Primer changeTicketState

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // neobvezno polje v telesu
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

Ustvari vozovnico

Parameters

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

Response

Vrne: CreateTicketResponse1

Example

createTicket Primer

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string je neobvezen in je izpuščen
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// Primer uporabe neobveznega polja iz odgovora
// console.log(response.ticket?.id);

Pridobi vozovnico

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	Yes
userId	string	No

Odgovor

Vrne: GetTicketResponse1

Primer

Primer getTicket

Copy

const tenantId: string = "acme-inc";
const ticketId: string = "ticket-3421";
const userId: string = "alice.smith";
const ticketWithUser: GetTicketResponse1 = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicketResponse1 = await getTicket(tenantId, ticketId);

Pridobi vozovnice

Parameters

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

Odziv

Vrne: GetTicketsResponse1

Primer

Primer getTickets

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // npr., zaprt
  const skip: number = 10;
  const limit: number = 5;
  const ticketsFull: GetTicketsResponse1 = await getTickets(tenantId, userId, state, skip, limit);
  const ticketsPartial: GetTicketsResponse1 = await getTickets(tenantId);
}
loadTickets();

Pridobi prevode

Parametri

Ime	Tip	Obvezno
namespace	string	Yes
component	string	Yes
locale	string	No
useFullTranslationIds	boolean	No

Odgovor

Vrne: GetTranslationsResponse1

Primer

getTranslations Primer

Copy

(async () => {
  const namespace: string = 'blog';
  const component: string = 'comment-editor';
  const locale: string = 'fr-FR';
  const useFullTranslationIds: boolean = true;
  const basicTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component);
  const fullTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component, locale, useFullTranslationIds);
})();

Naloži sliko

Naloži in spremeni velikost slike

Parameters

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

Response

Vrne: UploadImageResponse

Primer

uploadImage Primer

Copy

const tenantId: string = "acme-tenant-01";
const imageBlob: Blob = new Blob([new Uint8Array([137,80,78,71])], { type: "image/png" });
const uploadResult1: UploadImageResponse = await uploadImage(tenantId, imageBlob);
const sizePreset: SizePreset = { presetName: "medium" };
const urlId: string = "article-9876";
const uploadResult2: UploadImageResponse = await uploadImage(tenantId, imageBlob, sizePreset, urlId);

Pridobi napredek značke uporabnika po ID-ju

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetUserBadgeProgressByIdResponse

Primer

getUserBadgeProgressById Primer

Copy

async function demo(): Promise<void> {
    const tenantId: string = "acme-corp";
    const userId: string = "user-42";
    const result: GetUserBadgeProgressByIdResponse = await getUserBadgeProgressById(tenantId, userId);
    const progress: UserBadgeProgress | undefined = result.progress;
    const earnedAt: Date | undefined = progress?.earnedAt;
    console.log(`Badge earned at: ${earnedAt?.toISOString() ?? "not earned yet"}`);
}
demo();

Pridobi napredek značke uporabnika po ID-ju uporabnika

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
userId	string	Da

Odgovor

Vrne: GetUserBadgeProgressByUserIdResponse

Primer

getUserBadgeProgressByUserId Primer

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "user-12345";
  const badgeProgress: GetUserBadgeProgressByUserIdResponse = await getUserBadgeProgressByUserId(tenantId, userId);
  console.log(badgeProgress);
})();

Pridobi seznam napredka značk uporabnikov

Parametri

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

Odziv

Vrne: GetUserBadgeProgressListResponse

Primer

getUserBadgeProgressList Primer

Copy

async function fetchBadgeProgress() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe@example.com";
  const limit: number = 10;
  const skip: number = 5;
  const fullList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(
    tenantId,
    userId,
    limit,
    skip
  );
  const simpleList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(tenantId);
}
fetchBadgeProgress();

Ustvari značko uporabnika

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createUserBadgeParams	CreateUserBadgeParams	Da

Odgovor

Vrne: CreateUserBadgeResponse

Primer

createUserBadge Primer

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // opis je neobvezen in je izpuščen tukaj
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

Izbriši značko uporabnika

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: DeleteUserBadgeResponse

Primer

Primer deleteUserBadge

Copy

async function exampleDeleteBadge(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6a";
  const badgeId: string = "badge_4e3d2c1b";
  const result: DeleteUserBadgeResponse = await deleteUserBadge(tenantId, badgeId);
  console.log(result);
}
exampleDeleteBadge();

Pridobi značko uporabnika

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Yes
id	string	Yes

Odgovor

Vrne: GetUserBadgeResponse

Primer

getUserBadge Primer

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-001";
  const badgeId: string = "badge-5f9d3a2b";
  const badgeResponse: GetUserBadgeResponse = await getUserBadge(tenantId, badgeId);
  // Varno dostopajte do neobveznih polj
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

Pridobi značke uporabnikov

Parametri

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

Odgovor

Vrne: GetUserBadgesResponse

Primer

Primer getUserBadges

Copy

async function example() {
  const tenantId: string = "tenant-01";
  const userId: string = "user-42";
  const badgeId: string = "badge-gold";
  const type: number = 1;
  const displayedOnComments: boolean = true;
  const limit: number = 10;
  const skip: number = 5;
  const fullResult: GetUserBadgesResponse = await getUserBadges(
    tenantId,
    userId,
    badgeId,
    type,
    displayedOnComments,
    limit,
    skip
  );
  const minimalResult: GetUserBadgesResponse = await getUserBadges(tenantId);
}
example();

Posodobi značko uporabnika

Parametri

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

Odgovor

Vrne: UpdateUserBadgeResponse

Primer

Primer updateUserBadge

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // primer neobveznega polja
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

Pridobi število uporabniških obvestil

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
sso	string	No

Odziv

Vrne: GetUserNotificationCountResponse1

Primer

Primer getUserNotificationCount

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // Klic z neobveznim SSO žetonom
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // Klic brez SSO žetona
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

Pridobi uporabniška obvestila

Parametri

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

Odgovor

Vrne: GetUserNotificationsResponse

Primer

getUserNotifications Primer

Copy

async function fetchUserNotifications() {
    const tenantId: string = "tenant_9f4b2c";
    const urlId: string = "post_1234";
    const pageSize: number = 25;
    const afterId: string = "notif_5678";
    const includeContext: boolean = true;
    const unreadOnly: boolean = false;
    const dmOnly: boolean = false;
    const includeTranslations: boolean = true;
    const notifications: GetUserNotificationsResponse = await getUserNotifications(
        tenantId,
        urlId,
        pageSize,
        afterId,
        includeContext,
        undefined,
        unreadOnly,
        dmOnly,
        undefined,
        includeTranslations,
        undefined,
        undefined
    );
    console.log(notifications);
}

Ponastavi število uporabniških obvestil

Parameters

Name	Type	Required	Description
tenantId	string	Da
sso	string	Ne

Response

Vrne: ResetUserNotificationCountResponse

Example

resetUserNotificationCount Primer

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // Klic z izbirnim parametrom sso
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // Klic brez izbirnega parametra sso
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

Ponastavi uporabniška obvestila

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Odgovor

Vrne: ResetUserNotificationsResponse1

Primer

Primer resetUserNotifications

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // primer UNIX časovnega žiga
  const unreadOnly: boolean = true;
  const dmOnly: boolean = false;
  const noDm: boolean = false;
  const sss: string = "sso-token-xyz";
  const result: ResetUserNotificationsResponse1 = await resetUserNotifications(
    tenantId,
    afterId,
    afterCreatedAt,
    unreadOnly,
    dmOnly,
    noDm,
    sso
  );
  console.log(result);
})();

Posodobi status naročnine uporabnika na komentarje

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

Parameters

Ime	Vrsta	Obvezno
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Response

Vrne: UpdateUserNotificationCommentSubscriptionStatusResponse

Primer

updateUserNotificationCommentSubscriptionStatus Primer

Copy

const tenantId: string = "tenant_12345";
const notificationId: string = "notif_9876";
const commentId: string = "comment_abc123";
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum =
  UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = "ssoTokenXYZ";
const responseWithSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId,
    sso
  );
const responseWithoutSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId
  );

Posodobi status naročnine uporabnika na stran

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

Parametri

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

Odziv

Vrne: UpdateUserNotificationPageSubscriptionStatusResponse

Primer

Primer updateUserNotificationPageSubscriptionStatus

Copy

(async () => {
  const tenantId: string = "tenant-2024";
  const urlId: string = "page-5678";
  const url: string = "https://example.com/articles/typescript-tips";
  const pageTitle: string = "Top TypeScript Tips";
  const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
    UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
  const sso: string = "sso-token-xyz";
  const resultWithSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed,
    sso
  );
  const resultWithoutSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed
  );
})();

Posodobi status uporabniškega obvestila

Parametri

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

Odgovor

Vrne: UpdateUserNotificationStatusResponse

Primer

updateUserNotificationStatus Primer

Copy

const tenantId: string = "acme-corp";
const notificationId: string = "notif-20231101-001";
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Dismissed;
const ssoToken: string = "sso-9f8e7d6c5b4a";
const result: UpdateUserNotificationStatusResponse = await updateUserNotificationStatus(
  tenantId,
  notificationId,
  newStatus,
  ssoToken
);

Pridobi statuse prisotnosti uporabnikov

Parametri

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

Odziv

Vrne: GetUserPresenceStatusesResponse1

Primer

getUserPresenceStatuses Primer

Copy

async function fetchUserPresences() {
  const tenantId: string = "tenant_9f8e2d";
  const urlIdWS: string = "blog.mycompany.com/thread/12345";
  const userIds: string = "alice,bob,carol";
  const result: GetUserPresenceStatusesResponse1 = await getUserPresenceStatuses(
    tenantId,
    urlIdWS,
    userIds
  );
  console.log(result);
}

Išči uporabnike

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

Odgovor

Vrne: SearchUsersResponse1

Primer

searchUsers Primer

Copy

async function demoSearch(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "article-9876";
    const usernameStartsWith: string = "john";
    const mentionGroupIds: string[] = ["groupA", "groupB"];
    const sso: string = "sso_abc123";
    const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Users;
    const response: SearchUsersResponse1 = await searchUsers(
        tenantId,
        urlId,
        usernameStartsWith,
        mentionGroupIds,
        sso,
        searchSection
    );
    console.log(response);
}
demoSearch();

Pridobi uporabnika

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Da

Odgovor

Vrne: GetUserResponse1

Primer

Primer getUser

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_98765";
  const result: GetUserResponse1 = await getUser(tenantId, userId);
})();

Ustvari glas

Parametri

Ime	Tip	Potrebno
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

Odgovor

Vrne: CreateVoteResponse

Primer

createVote Primer

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "comment_987654";
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Upvote;
const userId: string = "user_7f9a2b";
const voteResult: CreateVoteResponse = await createVote(
  tenantId,
  commentId,
  direction,
  userId
);

Izbriši glas

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
id	string	Da
editKey	string	Ne

Odgovor

Vrne: DeleteVoteResponse

Primer

deleteVote Primer

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-9876";
  const editKey: string = "edit-key-123";
  const resultWithEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId, editKey);
  const resultWithoutEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId);
})();

Pridobi glasove

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Vrne: GetVotesResponse1

Primer

Primer getVotes

Copy

async function fetchVotes(): Promise<void> {
  const tenantId: string = "acme-corp-01";
  const urlId: string = "article-2024-05-15";
  const response: GetVotesResponse1 = await getVotes(tenantId, urlId);
  // Primer dostopa do optionalnega polja v odgovoru
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

Pridobi glasove za uporabnika

Parametri

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

Odgovor

Vrne: GetVotesForUserResponse1

Primer

Primer getVotesForUser

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const urlId: string = "post-9f8b7c";
  const userId: string = "user-42";
  const anonUserId: string = "anon-123";
  const votesRequiredOnly: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId);
  const votesWithUserId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, userId);
  const votesWithAnonId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, undefined, anonUserId);
}
demo();

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

Referenca API-ja

Dokumentacija

Uporaba

Agregiranje

Revizijski dnevniki

Blokiraj iz komentarja

Preveri blokirane komentarje

Komentarji

Komentarji za uporabnika

Konfiguracije domen

E-poštne predloge

Dnevnik dogodkov

Objave vira

Označi komentar

GIF-i

Hashtagi

Moderacija

Moderatorji

Število obvestil

Obvestila

Reakcije strani

Strani

Čakajoči webhook dogodki

Konfiguracije vprašanj

Rezultati vprašanj

Agregacija rezultatov vprašanj

SSO uporabniki

Naročnine

Dnevna uporaba najemnika

Paketi najemnika

Uporabniki najemnika

Najemniki

Tiketi

Prevodi

Nalaganje slike

Napredek značk uporabnika

Značke uporabnikov

Uporabniška obvestila

Stanje prisotnosti uporabnika

Iskanje uporabnikov

Uporabniki

Glasovi

FastComments SDK za JavaScript/TypeScript

Repozitorij

Namestitev

Dokumentacija API-ja

Popolna referenca API: docs/api/README.md

Združljivost brskalnika in strežnika

Uporaba

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

Javni in zaščiteni API-ji

Primer: Uporaba Public API (varno v brskalniku)

Primer: Uporaba Default API (samo na strežniku)

Primer: Uporaba Moderation API

Integracija enotne prijave (SSO)

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

Pogosti primeri uporabe

Pridobivanje komentarjev za stran

Ustvarjanje komentarja

Glasovanje za komentar

Upravljanje uporabnikov (zahteva API ključ)

Dogodki v živo (posodobitve v realnem času)

Dogodki na ravni strani

Naročite se na uporabniške dogodke

Pridobivanje userIdWS

ID-ji za oddajanje

Ravnanje z napakami

Agregiraj

Parametri

Odgovor