FastComments JavaScript/TypeScript SDK

To oficjalne SDK JavaScript/TypeScript dla FastComments.

Oficjalne SDK JavaScript/TypeScript dla API FastComments

Repozytorium

Instalacja

npm install fastcomments-sdk

Dokumentacja API

Pełna dokumentacja API: docs/api/README.md

Zgodność przeglądarki i serwera

Ten SDK korzysta z podwójnych punktów wejścia aby zapewnić optymalną kompatybilność i zapobiec błędom czasu wykonywania:

fastcomments-sdk/browser - Wersja bezpieczna dla przeglądarki z natywnym fetch
fastcomments-sdk/server - Pełna wersja Node.js z obsługą SSO
fastcomments-sdk (domyślnie) - Tylko typy, bezpieczne do importowania w dowolnym miejscu

Użycie

To SDK zapewnia oddzielne punkty wejścia dla środowisk przeglądarki i serwera, aby zapewnić optymalną zgodność i bezpieczeństwo:

Użycie w przeglądarce (po stronie klienta)

Dla aplikacji w przeglądarce/front-end użyj eksportu bezpiecznego dla przeglądarki, który wyklucza zależności Node.js:

// Import bezpieczny dla przeglądarki (bez zależności Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Utwórz instancję SDK dla przeglądarki
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // opcjonalnie, domyślnie https://fastcomments.com
});

// Używaj publicznych API (brak potrzeby klucza API - bezpieczne w przeglądarkach)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Użycie po stronie serwera (Node.js)

Dla aplikacji serwerowych/back-end użyj pełnego SDK z funkcjami SSO i uwierzytelniania:

// Import po stronie serwera (zawiera SSO i zaprojektowany do pracy z NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Utwórz instancję SDK dla serwera
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Przechowuj to w tajemnicy na serwerze!
  basePath: 'https://fastcomments.com' // opcjonalnie, domyślnie https://fastcomments.com
});

// Używaj zabezpieczonych API z Twoim kluczem API
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Tylko import typów

Jeśli potrzebujesz tylko typów TypeScript (bez kodu uruchomieniowego), użyj domyślnego importu:

// Tylko typy (bez zależności w czasie wykonywania - bezpieczne wszędzie)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Korzystanie z poszczególnych klas API

Środowisko przeglądarki

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

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

const publicApi = new PublicApi(config);

Środowisko serwera

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

API publiczne vs zabezpieczone

SDK udostępnia trzy główne klasy API:

DefaultApi - Zabezpieczone endpointy, które wymagają klucza API do uwierzytelnienia. Używaj ich do operacji po stronie serwera.
PublicApi - Publiczne endpointy, do których można uzyskać dostęp bez klucza API. Można je wywoływać bezpośrednio z przeglądarek/urządzeń mobilnych itp.
HiddenApi - Wewnętrzne/adminowe endpointy do zaawansowanych zastosowań.

Example: Using Public API (browser-safe)

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

const publicApi = new PublicApi();

// Pobierz komentarze dla strony (nie wymaga klucza API)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Example: Using Default API (server-side only)

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

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

// Pobierz komentarze z pełnym dostępem administratora
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Integracja SSO (Single Sign-On)

FastComments obsługuje SSO w celu integracji z istniejącym systemem uwierzytelniania użytkowników. Funkcjonalność SSO jest dostępna tylko w eksporcie serwera ponieważ wymaga funkcji kryptograficznych Node.js.

Proste SSO (tylko po stronie serwera)

Proste SSO powinno być generowane po stronie serwera i wysyłane do klienta:

// Kod po stronie serwera (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Utwórz proste SSO przy użyciu wbudowanego pomocnika  
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();

// Wyślij ssoToken do kodu po stronie klienta
// Kod po stronie klienta może następnie użyć tego tokena z SDK przeglądarki

Bezpieczne SSO (po stronie serwera, zalecane)

Bezpieczne SSO powinno być zaimplementowane po stronie serwera i zapewnia lepsze bezpieczeństwo:

// Kod po stronie serwera (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Utwórz bezpieczne SSO przy użyciu wbudowanego pomocnika
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();

// Użyj z wywołaniami API na serwerze
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Lub wyślij ssoConfig do klienta do użycia w przeglądarce

Użycie SSO z przeglądarki (z tokenem wygenerowanym przez serwer)

// Kod po stronie klienta (przeglądarka)
import { PublicApi } from 'fastcomments-sdk/browser';

// Pobierz token SSO z endpointu swojego serwera
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

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

SSO z tworzeniem komentarza

// Po stronie serwera: utwórz SSO i komentarz
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)
});

Typowe przypadki użycia

Pobieranie komentarzy dla strony

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

Tworzenie komentarza

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

Głosowanie na komentarz

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 oznacza głos za, -1 oznacza głos przeciw
  }
});

Zarządzanie użytkownikami (wymaga klucza API)

// Wyszukiwanie użytkowników (wymaga DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Wydarzenia na żywo (aktualizacje w czasie rzeczywistym)

Subskrybuj zdarzenia na żywo, aby otrzymywać aktualizacje w czasie rzeczywistym dotyczące komentarzy, głosów i innych aktywności.

Zdarzenia na poziomie strony

Nasłuchuj zdarzeń na żywo dla konkretnej strony (komentarze, głosy itp.):

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

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

// Subskrybuj zdarzenia na żywo dla strony
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (pobierz to z odpowiedzi getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Zaktualizuj interfejs użytkownika o nowy komentarz
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Zaktualizuj licznik głosów w interfejsie użytkownika
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Zwróć true, jeśli zdarzenie zostało obsłużone
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Zamknij subskrypcję po zakończeniu
subscription.close();

Subskrybuj zdarzenia użytkownika

Nasłuchuj zdarzeń specyficznych dla użytkownika (powiadomienia, wzmianki itp.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Pobierz to z odpowiedzi getComments
};

// Subskrybuj osobisty kanał użytkownika
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Pokaż powiadomienie w interfejsie użytkownika
        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');
  }
);

// Zamknij po zakończeniu
userSubscription.close();

Uzyskiwanie userIdWS

Parametr userIdWS jest wymagany do zdarzeń na żywo i można go uzyskać z odpowiedzi API:

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

// Wyodrębnij userIdWS z odpowiedzi
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Teraz możesz subskrybować zdarzenia na żywo
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast IDs

Zobaczysz, że w niektórych wywołaniach API należy przekazać broadcastId. Gdy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, że możesz zignorować zdarzenie, jeśli planujesz optimistycznie zastosować zmiany po stronie klienta (co prawdopodobnie będziesz chciał zrobić, ponieważ zapewnia najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być wystarczająco unikalny, aby nie pojawił się dwa razy w sesji przeglądarki.

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() // Unikalny identyfikator dla tej operacji
  }
});

Obsługa błędów

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

aggregate

Agreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itd.).

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
aggregationRequest	AggregationRequest	Tak
parentTenantId	string	Nie
includeStats	boolean	Nie

Odpowiedź

Zwraca: AggregationResponse

getAuditLogs

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
limit	number	Nie
skip	number	Nie
order	SORTDIR	Nie
after	number	Nie
before	number	Nie

Odpowiedź

Zwraca: GetAuditLogs200Response

Przykład

Przykład getAuditLogs

Copy

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

blockFromCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
publicBlockFromCommentParams	PublicBlockFromCommentParams	Tak
sso	string	Nie

Odpowiedź

Zwraca: BlockFromCommentPublic200Response

Przykład

Przykład blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
publicBlockFromCommentParams	PublicBlockFromCommentParams	Tak
sso	string	Nie

Odpowiedź

Zwraca: UnBlockCommentPublic200Response

Przykład

Przykład unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentIds	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: CheckedCommentsForBlocked200Response

Przykład

Przykład checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
blockFromCommentParams	BlockFromCommentParams	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: BlockFromCommentPublic200Response

Przykład

Przykład blockUserFromComment

Copy

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

createCommentPublic

Parametry

Name	Type	Wymagane
tenantId	string	Tak
urlId	string	Tak
broadcastId	string	Tak
commentData	CommentData	Tak
sessionId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: CreateCommentPublic200Response

Przykład

Przykład createCommentPublic

Copy

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

deleteComment

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Tak
contextUserId	string	Nie
isLive	boolean	Nie

Odpowiedź

Zwraca: DeleteComment200Response

Przykład

Przykład deleteComment

Copy

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

deleteCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Tak
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: DeleteCommentPublic200Response

Przykład

Przykład deleteCommentPublic

Copy

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

deleteCommentVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
voteId	string	Tak
urlId	string	Tak
broadcastId	string	Tak
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: DeleteCommentVote200Response

Przykład

Przykład użycia deleteCommentVote

Copy

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

flagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: FlagComment200Response

Przykład

Przykład flagComment

Copy

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

getComment

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetComment200Response

Przykład

Przykład użycia getComment

Copy

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

getComments

Parametry

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

Odpowiedź

Zwraca: GetComments200Response

Przykład

Przykład getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // strona
  20, // limit
  0, // pomiń
  true, // jako drzewo
  1, // pomiń dzieci
  3, // limit dzieci
  4, // maks. głębokość drzewa
  'articles/2026/new-product-launch', // urlId
  'user_7890', // identyfikator użytkownika
  'anon_4f3b2', // identyfikator anonimowego użytkownika
  undefined, // identyfikator użytkownika kontekstu
  '#launch', // hashtag
  undefined // identyfikator rodzica
);

getCommentsPublic

req tenantId urlId

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
page	number	Nie
direction	SortDirections	Nie
sso	string	Nie
skip	number	Nie
skipChildren	number	Nie
limit	number	Nie
limitChildren	number	Nie
countChildren	boolean	Nie
fetchPageForCommentId	string	Nie
includeConfig	boolean	Nie
countAll	boolean	Nie
includei10n	boolean	Nie
locale	string	Nie
modules	string	Nie
isCrawler	boolean	Nie
includeNotificationCount	boolean	Nie
asTree	boolean	Nie
maxTreeDepth	number	Nie
useFullTranslationIds	boolean	Nie
parentId	string	Nie
searchText	string	Nie
hashTags	Array	Nie
userId	string	Nie
customConfigStr	string	Nie
afterCommentId	string	Nie
beforeCommentId	string	Nie

Odpowiedź

Zwraca: GetCommentsPublic200Response

Przykład

Przykład getCommentsPublic

Copy

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

getCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: GetCommentText200Response

Przykład

getCommentText Przykład

Copy

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

getCommentVoteUserNames

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
dir	number	Tak
sso	string	Nie

Odpowiedź

Zwraca: GetCommentVoteUserNames200Response

Przykład

Przykład getCommentVoteUserNames

Copy

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

lockComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: LockComment200Response

Przykład

Przykład lockComment

Copy

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

pinComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: PinComment200Response

Przykład

Przykład użycia pinComment

Copy

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

saveComment

Parametry

Name	Typ	Wymagane
tenantId	string	Tak
createCommentParams	CreateCommentParams	Tak
isLive	boolean	Nie
doSpamCheck	boolean	Nie
sendEmails	boolean	Nie
populateNotifications	boolean	Nie

Odpowiedź

Zwraca: SaveComment200Response

Przykład

Przykład saveComment

Copy

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

saveCommentsBulk

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createCommentParams	Array	Tak
isLive	boolean	Nie
doSpamCheck	boolean	Nie
sendEmails	boolean	Nie
populateNotifications	boolean	Nie

Odpowiedź

Zwraca: Array<SaveComment200Response

Przykład

Przykład saveCommentsBulk

Copy

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

setCommentText

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Tak
commentTextUpdateRequest	CommentTextUpdateRequest	Tak
editKey	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: SetCommentText200Response

Przykład

Przykład setCommentText

Copy

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

unBlockUserFromComment

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Tak
unBlockFromCommentParams	UnBlockFromCommentParams	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: UnBlockCommentPublic200Response

Przykład

Przykład unBlockUserFromComment

Copy

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

unFlagComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: FlagComment200Response

Przykład

Przykład unFlagComment

Copy

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

unLockComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: LockComment200Response

Przykład

Przykład unLockComment

Copy

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

unPinComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
broadcastId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: PinComment200Response

Przykład

Przykład unPinComment

Copy

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

updateComment

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updatableCommentParams	UpdatableCommentParams	Tak
contextUserId	string	Nie
doSpamCheck	boolean	Nie
isLive	boolean	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateComment

Copy

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

voteComment

Parametry

Name	Type	Wymagane
tenantId	string	Tak
commentId	string	Tak
urlId	string	Tak
broadcastId	string	Tak
voteBodyParams	VoteBodyParams	Tak
sessionId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: VoteComment200Response

Przykład

Przykład voteComment

Copy

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

addDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
addDomainConfigParams	AddDomainConfigParams	Tak

Odpowiedź

Zwraca: AddDomainConfig200Response

deleteDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
domain	string	Tak

Odpowiedź

Zwraca: DeleteDomainConfig200Response

getDomainConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
domain	string	Tak

Odpowiedź

Zwraca: GetDomainConfig200Response

getDomainConfigs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: GetDomainConfigs200Response

patchDomainConfig

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
domainToUpdate	string	Tak
patchDomainConfigParams	PatchDomainConfigParams	Tak

Odpowiedź

Zwraca: GetDomainConfig200Response

putDomainConfig

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
domainToUpdate	string	Tak
updateDomainConfigParams	UpdateDomainConfigParams	Tak

Odpowiedź

Zwraca: GetDomainConfig200Response

createEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createEmailTemplateBody	CreateEmailTemplateBody	Tak

Odpowiedź

Zwraca: CreateEmailTemplate200Response

Przykład

Przykład createEmailTemplate

Copy

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

deleteEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteEmailTemplate

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // przykład opcjonalnego parametru
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
errorId	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

deleteEmailTemplateRenderError Przykład

Copy

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

getEmailTemplate

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetEmailTemplate200Response

Przykład

Przykład getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: GetEmailTemplateDefinitions200Response

Przykład

Przykład getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetEmailTemplateRenderErrors200Response

Przykład

Przykład getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parameters

Name	Type	Required	Description
tenantId	string	Tak
skip	number	Nie

Response

Zwraca: GetEmailTemplates200Response

Przykład

Przykład getEmailTemplates

Copy

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

renderEmailTemplate

Parametry

Name	Type	Wymagane
tenantId	string	Tak
renderEmailTemplateBody	RenderEmailTemplateBody	Tak
locale	string	Nie

Odpowiedź

Zwraca: RenderEmailTemplate200Response

Przykład

Przykład renderEmailTemplate

Copy

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

updateEmailTemplate

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateEmailTemplateBody	UpdateEmailTemplateBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

Parametry

Name	Type	Required
tenantId	string	Tak
urlId	string	Tak
userIdWS	string	Tak
startTime	number	Tak
endTime	number	Tak

Odpowiedź

Zwraca: GetEventLog200Response

Przykład

Przykład getEventLog

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // opcjonalna wartość pochodząca z upstream
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

getGlobalEventLog

req tenantId urlId userIdWS

Parametry

Name	Type	Required
tenantId	string	Tak
urlId	string	Tak
userIdWS	string	Tak
startTime	number	Tak
endTime	number	Tak

Odpowiedź

Zwraca: GetEventLog200Response

Przykład

Przykład getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 dni temu
const endTimeOptional: number | undefined = undefined; // opcjonalny koniec zakresu czasowego
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createFeedPostParams	CreateFeedPostParams	Tak
broadcastId	string	Nie
isLive	boolean	Nie
doSpamCheck	boolean	Nie
skipDupCheck	boolean	Nie

Odpowiedź

Zwraca: CreateFeedPost200Response

Przykład

Przykład użycia createFeedPost

Copy

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

createFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
createFeedPostParams	CreateFeedPostParams	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: CreateFeedPostPublic200Response

Przykład

Przykład createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postId	string	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: DeleteFeedPostPublic200Response

Przykład

Przykład deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
afterId	string	Nie
limit	number	Nie
tags	Array	Nie

Odpowiedź

Zwraca: GetFeedPosts200Response

Przykład

Przykład użycia getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parametry

Name	Type	Required
tenantId	string	Tak
afterId	string	Nie
limit	number	Nie
tags	Array	Nie
sso	string	Nie
isCrawler	boolean	Nie
includeUserInfo	boolean	Nie

Odpowiedź

Zwraca: GetFeedPostsPublic200Response

Przykład

Przykład getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postIds	Array	Tak
sso	string	Nie

Odpowiedź

Zwraca: GetFeedPostsStats200Response

Przykład

Przykład getFeedPostsStats

Copy

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

getUserReactsPublic

Parametry

Name	Type	Required
tenantId	string	Tak
postIds	Array	Nie
sso	string	Nie

Odpowiedź

Zwraca: GetUserReactsPublic200Response

Przykład

Przykład getUserReactsPublic

Copy

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

reactFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postId	string	Tak
reactBodyParams	ReactBodyParams	Tak
isUndo	boolean	Nie
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: ReactFeedPostPublic200Response

Przykład

Przykład reactFeedPostPublic

Copy

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

updateFeedPost

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Tak
feedPost	FeedPost	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateFeedPost

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // opcjonalna tablica dołączona
  links: [link],          // opcjonalne linki dołączone
  isPublished: true       // opcjonalna flaga publikacji użyta tutaj
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
postId	string	Tak
updateFeedPostParams	UpdateFeedPostParams	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: CreateFeedPostPublic200Response

Przykład

Przykład updateFeedPostPublic

Copy

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

flagCommentPublic

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
isFlagged	boolean	Tak
sso	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład flagCommentPublic

Copy

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

addHashTag

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Odpowiedź

Zwraca: AddHashTag200Response

Przykład

Przykład addHashTag

Copy

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

addHashTagsBulk

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Nie
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nie

Odpowiedź

Zwraca: AddHashTagsBulk200Response

Przykład

Przykład addHashTagsBulk

Copy

// Utwórz identyfikator tenant (opcjonalny parametr)
const tenantId: string = "tenant_9f8c2b7a";
// Przygotuj pojedyncze wpisy tagów
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Ciało żądania tworzenia zbiorczego (opcjonalny parametr)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Wywołaj globalną funkcję asynchroniczną i przypisz wynik z określonym typem
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

deleteHashTag

Parametry

Nazwa	Typ	Wymagane
tag	string	Tak
tenantId	string	Nie
deleteHashTagRequest	DeleteHashTagRequest	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteHashTag

Copy

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

getHashTags

Parametry

Name	Type	Required	Description
tenantId	string	Tak
page	number	Nie

Odpowiedź

Zwraca: GetHashTags200Response

Przykład

Przykład getHashTags

Copy

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

patchHashTag

Parametry

Name	Type	Required
tag	string	Tak
tenantId	string	Nie
updateHashTagBody	UpdateHashTagBody	Nie

Odpowiedź

Zwraca: PatchHashTag200Response

Przykład

Przykład patchHashTag

Copy

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

createModerator

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createModeratorBody	CreateModeratorBody	Tak

Odpowiedź

Zwraca: CreateModerator200Response

Przykład

Przykład createModerator

Copy

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

deleteModerator

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
sendEmail	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteModerator

Copy

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

getModerator

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetModerator200Response

Przykład

Przykład getModerator

Copy

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

getModerators

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetModerators200Response

Przykład

Przykład getModerators

Copy

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

sendInvite

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
fromName	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład sendInvite

Copy

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

updateModerator

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateModeratorBody	UpdateModeratorBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateModerator

Copy

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

deleteNotificationCount

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteNotificationCount

Copy

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

getCachedNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetCachedNotificationCount200Response

Przykład

Przykład getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // opcjonalna flaga parametru (zademonstrowana)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

getNotificationCount

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
urlId	string	Nie
fromCommentId	string	Nie
viewed	boolean	Nie
type	string	Nie

Odpowiedź

Zwraca: GetNotificationCount200Response

Przykład

Przykład getNotificationCount

Copy

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

getNotifications

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
urlId	string	Nie
fromCommentId	string	Nie
viewed	boolean	Nie
type	string	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetNotifications200Response

Przykład

Przykład getNotifications

Copy

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

updateNotification

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateNotificationBody	UpdateNotificationBody	Tak
userId	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateNotification

Copy

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

addPage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPIPageData	CreateAPIPageData	Tak

Odpowiedź

Zwraca: AddPageAPIResponse

deletePage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: DeletePageAPIResponse

getPageByURLId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: GetPageByURLIdAPIResponse

getPages

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: GetPagesAPIResponse

patchPage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateAPIPageData	UpdateAPIPageData	Tak

Odpowiedź

Zwraca: PatchPageAPIResponse

deletePendingWebhookEvent

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deletePendingWebhookEvent

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // przykład opcjonalnego parametru (nie wymagany przez funkcję)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Nie
externalId	string	Nie
eventType	string	Nie
type	string	Nie
domain	string	Nie
attemptCountGT	number	Nie

Odpowiedź

Zwraca: GetPendingWebhookEventCount200Response

Przykład

Przykład getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Nie
externalId	string	Nie
eventType	string	Nie
type	string	Nie
domain	string	Nie
attemptCountGT	number	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetPendingWebhookEvents200Response

Przykład

Przykład getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionConfigBody	CreateQuestionConfigBody	Tak

Odpowiedź

Zwraca: CreateQuestionConfig200Response

Przykład

Przykład createQuestionConfig

Copy

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

deleteQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład użycia deleteQuestionConfig

Copy

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

getQuestionConfig

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetQuestionConfig200Response

Przykład

Przykład getQuestionConfig

Copy

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

getQuestionConfigs

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetQuestionConfigs200Response

Przykład

Przykład użycia getQuestionConfigs

Copy

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

updateQuestionConfig

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Tak
updateQuestionConfigBody	UpdateQuestionConfigBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateQuestionConfig

Copy

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

createQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionResultBody	CreateQuestionResultBody	Tak

Odpowiedź

Zwraca: CreateQuestionResult200Response

Przykład

Przykład createQuestionResult

Copy

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

deleteQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteQuestionResult

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // opcjonalny parametr demonstrujący alternatywny wybór celu
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

getQuestionResult

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetQuestionResult200Response

Przykład

Przykład getQuestionResult

Copy

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

getQuestionResults

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Nie
userId	string	Nie
startDate	string	Nie
questionId	string	Nie
questionIds	string	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetQuestionResults200Response

Przykład

Przykład getQuestionResults

Copy

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

updateQuestionResult

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateQuestionResultBody	UpdateQuestionResultBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateQuestionResult

Copy

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

aggregateQuestionResults

Parametry

Name	Typ	Wymagane
tenantId	string	Tak
questionId	string	Nie
questionIds	Array	Nie
urlId	string	Nie
timeBucket	AggregateTimeBucket	Nie
startDate	Date	Nie
forceRecalculate	boolean	Nie

Response

Zwraca: AggregateQuestionResults200Response

Przykład

Przykład aggregateQuestionResults

Copy

const tenantId: string = 'tenant_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // questionId pominięte, zamiast niego używane questionIds
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

bulkAggregateQuestionResults

Parametry

Name	Type	Wymagane
tenantId	string	Tak
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Tak
forceRecalculate	boolean	Nie

Odpowiedź

Zwraca: BulkAggregateQuestionResults200Response

Przykład

Przykład bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
questionId	string	Nie
questionIds	Array	Nie
urlId	string	Nie
startDate	Date	Nie
forceRecalculate	boolean	Nie
minValue	number	Nie
maxValue	number	Nie
limit	number	Nie

Odpowiedź

Zwraca: CombineCommentsWithQuestionResults200Response

Przykład

Przykład combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPISSOUserData	CreateAPISSOUserData	Tak

Odpowiedź

Zwraca: AddSSOUserAPIResponse

deleteSSOUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
deleteComments	boolean	Nie
commentDeleteMode	string	Nie

Odpowiedź

Zwraca: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
email	string	Tak

Odpowiedź

Zwraca: GetSSOUserByEmailAPIResponse

getSSOUserById

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetSSOUserByIdAPIResponse

getSSOUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetSSOUsers200Response

patchSSOUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateAPISSOUserData	UpdateAPISSOUserData	Tak
updateComments	boolean	Nie

Odpowiedź

Zwraca: PatchSSOUserAPIResponse

putSSOUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateAPISSOUserData	UpdateAPISSOUserData	Tak
updateComments	boolean	Nie

Odpowiedź

Zwraca: PutSSOUserAPIResponse

createSubscription

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Tak

Odpowiedź

Zwraca: CreateSubscriptionAPIResponse

Przykład

Przykład createSubscription

Copy

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

deleteSubscription

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: DeleteSubscriptionAPIResponse

getSubscriptions

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: GetSubscriptionsAPIResponse

Przykład

Przykład getSubscriptions

Copy

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

updateSubscription

Parametry

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

Odpowiedź

Zwraca: UpdateSubscriptionAPIResponse

Przykład

Przykład updateSubscription

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

getTenantDailyUsages

Parameters

Nazwa	Typ	Wymagane
tenantId	string	Tak
yearNumber	number	Nie
monthNumber	number	Nie
dayNumber	number	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetTenantDailyUsages200Response

Przykład

Przykład getTenantDailyUsages

Copy

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

createTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantPackageBody	CreateTenantPackageBody	Tak

Odpowiedź

Zwraca: CreateTenantPackage200Response

Przykład

Przykład createTenantPackage

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // opcjonalny parametr
  // pominięto pola opcjonalne, np. zaawansowane reguły moderacji, niestandardowy CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // wartość ilustrująca; używa struktury CustomConfigParameters
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteTenantPackage

Copy

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

getTenantPackage

Parametry

Name	Type	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Response

Zwraca: GetTenantPackage200Response

Przykład

Przykład getTenantPackage

Copy

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

getTenantPackages

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetTenantPackages200Response

Przykład

Przykład użycia getTenantPackages

Copy

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

replaceTenantPackage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
replaceTenantPackageBody	ReplaceTenantPackageBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład replaceTenantPackage

Copy

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

updateTenantPackage

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateTenantPackageBody	UpdateTenantPackageBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // pola opcjonalne pominięte celowo (np. description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantUserBody	CreateTenantUserBody	Tak

Odpowiedź

Zwraca: CreateTenantUser200Response

Przykład

Przykład createTenantUser

Copy

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

deleteTenantUser

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
deleteComments	string	Nie
commentDeleteMode	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteTenantUser

Copy

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

getTenantUser

Parametry

Name	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetTenantUser200Response

Przykład

Przykład użycia getTenantUser

Copy

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

getTenantUsers

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetTenantUsers200Response

Przykład

Przykład użycia getTenantUsers

Copy

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

replaceTenantUser

Parametry

Name	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
replaceTenantUserBody	ReplaceTenantUserBody	Tak
updateComments	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład replaceTenantUser

Copy

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

sendLoginLink

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Tak
redirectURL	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład sendLoginLink

Copy

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

updateTenantUser

Parametry

Name	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateTenantUserBody	UpdateTenantUserBody	Tak
updateComments	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład użycia updateTenantUser

Copy

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

createTenant

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantBody	CreateTenantBody	Tak

Odpowiedź

Zwraca: CreateTenant200Response

Przykład

Przykład createTenant

Copy

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

deleteTenant

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
sure	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteTenant

Copy

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

getTenant

Parametry

Name	Type	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetTenant200Response

Przykład

Przykład getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // opcjonalne nadpisanie, jeśli dostępne
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

getTenants

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
meta	string	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetTenants200Response

Przykład

Przykład getTenants

Copy

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

updateTenant

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateTenantBody	UpdateTenantBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // opcjonalne, pomiń, aby zachować bieżące informacje rozliczeniowe
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Tak
id	string	Tak
changeTicketStateBody	ChangeTicketStateBody	Tak

Odpowiedź

Zwraca: ChangeTicketState200Response

Przykład

Przykład changeTicketState

Copy

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

createTicket

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Tak
createTicketBody	CreateTicketBody	Tak

Odpowiedź

Zwraca: CreateTicket200Response

Przykład

Przykład createTicket

Copy

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

getTicket

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: GetTicket200Response

Przykład

Przykład getTicket

Copy

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

getTickets

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
state	number	Nie
skip	number	Nie
limit	number	Nie

Odpowiedź

Zwraca: GetTickets200Response

Przykład

Przykład getTickets

Copy

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

uploadImage

Prześlij i zmień rozmiar obrazu

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
file	Blob	Tak
sizePreset	SizePreset	Nie
urlId	string	Nie

Odpowiedź

Zwraca: UploadImageResponse

getUserBadgeProgressById

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetUserBadgeProgressById200Response

Przykład

Przykład getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Tak

Odpowiedź

Zwraca: GetUserBadgeProgressById200Response

Przykład

Przykład getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // opcjonalne źródło (może być undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

getUserBadgeProgressList

Parametry

Name	Type	Wymagane
tenantId	string	Tak
userId	string	Nie
limit	number	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetUserBadgeProgressList200Response

Przykład

Przykład użycia getUserBadgeProgressList

Copy

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

createUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createUserBadgeParams	CreateUserBadgeParams	Tak

Odpowiedź

Zwraca: CreateUserBadge200Response

Przykład

Przykład createUserBadge

Copy

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

deleteUserBadge

Parametry

Nazwa	Type	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: UpdateUserBadge200Response

Przykład

Przykład deleteUserBadge

Copy

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

getUserBadge

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetUserBadge200Response

Przykład

Przykład użycia getUserBadge

Copy

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

getUserBadges

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
userId	string	Nie
badgeId	string	Nie
type	number	Nie
displayedOnComments	boolean	Nie
limit	number	Nie
skip	number	Nie

Odpowiedź

Zwraca: GetUserBadges200Response

Przykład

Przykład getUserBadges

Copy

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

updateUserBadge

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
updateUserBadgeParams	UpdateUserBadgeParams	Tak

Odpowiedź

Zwraca: UpdateUserBadge200Response

Przykład

Przykład updateUserBadge

Copy

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

getUserNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: GetUserNotificationCount200Response

Przykład

Przykład getUserNotificationCount

Copy

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

getUserNotifications

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
pageSize	number	Nie
afterId	string	Nie
includeContext	boolean	Nie
afterCreatedAt	number	Nie
unreadOnly	boolean	Nie
dmOnly	boolean	Nie
noDm	boolean	Nie
includeTranslations	boolean	Nie
sso	string	Nie

Odpowiedź

Zwraca: GetUserNotifications200Response

Przykład

Przykład getUserNotifications

Copy

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

resetUserNotificationCount

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: ResetUserNotifications200Response

Przykład

Przykład resetUserNotificationCount

Copy

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

resetUserNotifications

Parametry

Name	Typ	Wymagane
tenantId	string	Tak
afterId	string	Nie
afterCreatedAt	number	Nie
unreadOnly	boolean	Nie
dmOnly	boolean	Nie
noDm	boolean	Nie
sso	string	Nie

Odpowiedź

Zwraca: ResetUserNotifications200Response

Przykład

Przykład resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Włącz lub wyłącz powiadomienia dla konkretnego komentarza.

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Odpowiedź

Zwraca: UpdateUserNotificationStatus200Response

Przykład

Przykład updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

Włącz lub wyłącz powiadomienia dla strony. Kiedy użytkownicy subskrybują stronę, tworzone są powiadomienia o nowych komentarzach głównych, a także

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
url	string	Tak
pageTitle	string	Tak
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Tak
sso	string	Nie

Odpowiedź

Zwraca: UpdateUserNotificationStatus200Response

Przykład

Przykład updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parametry

Name	Type	Required
tenantId	string	Tak
notificationId	string	Tak
newStatus	UpdateUserNotificationStatusNewStatusEnum	Tak
sso	string	Nie

Odpowiedź

Zwraca: UpdateUserNotificationStatus200Response

Przykład

Przykład updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parametry

Name	Type	Required
tenantId	string	Tak
urlIdWS	string	Tak
userIds	string	Tak

Odpowiedź

Zwraca: GetUserPresenceStatuses200Response

Przykład

getUserPresenceStatuses Przykład

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // opcjonalne źródło
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
usernameStartsWith	string	Nie
mentionGroupIds	Array	Nie
sso	string	Nie
searchSection	SearchUsersSearchSectionEnum	Nie

Odpowiedź

Zwraca: SearchUsers200Response

Przykład

Przykład searchUsers

Copy

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

getUser

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetUser200Response

Przykład

Przykład getUser

Copy

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

createVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
commentId	string	Tak
direction	CreateVoteDirectionEnum	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: VoteComment200Response

Przykład

Przykład createVote

Copy

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

deleteVote

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
editKey	string	Nie

Odpowiedź

Zwraca: DeleteCommentVote200Response

Przykład

Przykład deleteVote

Copy

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

getVotes

Parametry

Name	Type	Required	Description
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: GetVotes200Response

Przykład

Przykład getVotes

Copy

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

getVotesForUser

Parametry

Name	Type	Wymagane
tenantId	string	Tak
urlId	string	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: GetVotesForUser200Response

Przykład

Przykład użycia getVotesForUser

Copy

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

Potrzebujesz pomocy?

Jeżeli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK JavaScript/TypeScript, prosimy:

Współtworzenie

Wkłady są mile widziane! Odwiedź repozytorium na GitHubie po wytyczne dotyczące współpracy.

Język 🇵🇱 Polski

Pierwsze kroki

Referencja API

Dokumentacja

Użycie

Identyfikatory transmisji

Agregacja

Dzienniki audytu

Blokowanie komentarzy

Sprawdzanie zablokowanych komentarzy

Komentarze

Konfiguracje domen

Szablony e-mail

Dziennik zdarzeń

Posty

Zgłaszanie komentarza

Hashtagi

Moderatorzy

Liczba powiadomień

Powiadomienia

Strony

Oczekujące zdarzenia webhook

Konfiguracje pytań

Wyniki pytań

Agregacja wyników pytań

Użytkownicy SSO

Subskrypcje

Dzienne użycie tenantów

Pakiety tenantów

Użytkownicy tenantów

Tenanty

Zgłoszenia

Przesyłanie obrazu

Postęp odznak użytkownika

Odznaki użytkowników

Powiadomienia użytkownika

Status obecności użytkownika

Wyszukiwanie użytkowników

Użytkownicy

Głosy

FastComments JavaScript/TypeScript SDK

Repozytorium

Instalacja

Dokumentacja API

Pełna dokumentacja API: docs/api/README.md

Zgodność przeglądarki i serwera

Użycie

Użycie w przeglądarce (po stronie klienta)

Użycie po stronie serwera (Node.js)

Tylko import typów

Korzystanie z poszczególnych klas API

Środowisko przeglądarki

Środowisko serwera

API publiczne vs zabezpieczone

Example: Using Public API (browser-safe)

Example: Using Default API (server-side only)

Integracja SSO (Single Sign-On)

Proste SSO (tylko po stronie serwera)

Bezpieczne SSO (po stronie serwera, zalecane)

Użycie SSO z przeglądarki (z tokenem wygenerowanym przez serwer)

SSO z tworzeniem komentarza

Typowe przypadki użycia

Pobieranie komentarzy dla strony

Tworzenie komentarza

Głosowanie na komentarz

Zarządzanie użytkownikami (wymaga klucza API)

Wydarzenia na żywo (aktualizacje w czasie rzeczywistym)

Zdarzenia na poziomie strony

Subskrybuj zdarzenia użytkownika

Uzyskiwanie userIdWS

Broadcast IDs

Obsługa błędów

aggregate

Parametry

Odpowiedź

getAuditLogs

Parametry

Odpowiedź

Przykład

blockFromCommentPublic