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

Kompatybilność 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);
}

ID transmisji

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

Agreguj

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

Pobierz dzienniki audytu

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

Zablokuj z komentarza (publiczne)

Parametry

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

Odpowiedź

Zwraca: BlockFromCommentPublic200Response

Odblokuj komentarz (publiczne)

Parametry

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

Odpowiedź

Zwraca: UnBlockCommentPublic200Response

Sprawdź zablokowane komentarze

Parametry

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

Odpowiedź

Zwraca: CheckedCommentsForBlocked200Response

Zablokuj użytkownika z komentarza

Parametry

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

Odpowiedź

Zwraca: BlockFromCommentPublic200Response

Utwórz komentarz (publiczny)

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
broadcastId	string	Tak
commentData	CommentData	Tak
sessionId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: CreateCommentPublic200Response

Usuń komentarz

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
contextUserId	string	Nie
isLive	boolean	Nie

Odpowiedź

Zwraca: DeleteComment200Response

Usuń komentarz (publiczny)

Parametry

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

Odpowiedź

Zwraca: DeleteCommentPublic200Response

Usuń głos przy komentarzu

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

Zgłoś komentarz

Parametry

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

Odpowiedź

Zwraca: FlagComment200Response

Pobierz komentarz

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetComment200Response

Pobierz komentarze

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
page	number	Nie
limit	number	Nie
skip	number	Nie
asTree	boolean	Nie
skipChildren	number	Nie
limitChildren	number	Nie
maxTreeDepth	number	Nie
urlId	string	Nie
userId	string	Nie
anonUserId	string	Nie
contextUserId	string	Nie
hashTag	string	Nie
parentId	string	Nie
direction	SortDirections	Nie

Odpowiedź

Zwraca: GetComments200Response

Pobierz komentarze (publiczne)

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

Pobierz tekst komentarza

Parametry

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

Odpowiedź

Zwraca: GetCommentText200Response

Pobierz nazwy użytkowników głosujących przy komentarzu

Parametry

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

Odpowiedź

Zwraca: GetCommentVoteUserNames200Response

Zablokuj komentarz

Parametry

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

Odpowiedź

Zwraca: LockComment200Response

Przypnij komentarz

Parametry

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

Odpowiedź

Zwraca: PinComment200Response

Zapisz komentarz

Parametry

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

Odpowiedź

Zwraca: SaveComment200Response

Zapisz komentarze hurtowo

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

Ustaw tekst komentarza

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

Odblokuj użytkownika z komentarza

Parametry

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

Odpowiedź

Zwraca: UnBlockCommentPublic200Response

Cofnij zgłoszenie komentarza

Parametry

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

Odpowiedź

Zwraca: FlagComment200Response

Odblokuj komentarz

Parametry

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

Odpowiedź

Zwraca: LockComment200Response

Odepnij komentarz

Parametry

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

Odpowiedź

Zwraca: PinComment200Response

Zaktualizuj komentarz

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Tak
body	PickAPICommentUpdatableCommentFields	Tak
contextUserId	string	Nie
doSpamCheck	boolean	Nie
isLive	boolean	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Oddaj głos na komentarz

Parametry

Nazwa	Typ	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

Dodaj konfigurację domeny

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
addDomainConfigParams	AddDomainConfigParams	Tak

Odpowiedź

Zwraca: AddDomainConfig200Response

Usuń konfigurację domeny

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
domain	string	Tak

Odpowiedź

Zwraca: DeleteDomainConfig200Response

Pobierz konfigurację domeny

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
domain	string	Tak

Odpowiedź

Zwraca: GetDomainConfig200Response

Pobierz konfiguracje domeny

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: GetDomainConfigs200Response

Częściowo zaktualizuj konfigurację domeny

Parametry

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

Odpowiedź

Zwraca: GetDomainConfig200Response

Zastąp konfigurację domeny

Parametry

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

Odpowiedź

Zwraca: GetDomainConfig200Response

Utwórz szablon e-mail

Parametry

Name	Type	Required	Description
tenantId	string	Tak
createEmailTemplateBody	CreateEmailTemplateBody	Tak

Odpowiedź

Zwraca: CreateEmailTemplate200Response

Przykład

Przykład createEmailTemplate

Copy

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

Usuń szablon e-mail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteEmailTemplate

Copy

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

Usuń błąd renderowania szablonu e-mail

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_8f3b2a9c";
const id: string = "template_4a1c9f7e";
const errorId: string = "err_20260112_abc123";
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

Pobierz szablon e-mail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetEmailTemplate200Response

Przykład

Przykład getEmailTemplate

Copy

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

Pobierz definicje szablonów e-mail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: GetEmailTemplateDefinitions200Response

Przykład

Przykład getEmailTemplateDefinitions

Copy

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

Pobierz błędy renderowania szablonów e-mail

Parametry

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

Odpowiedź

Zwraca: GetEmailTemplateRenderErrors200Response

Przykład

Przykład getEmailTemplateRenderErrors

Copy

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

Pobierz szablony e-mail

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetEmailTemplates200Response

Przykład

Przykład getEmailTemplates

Copy

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

Renderuj szablon e-mail

Parametry

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

Odpowiedź

Zwraca: RenderEmailTemplate200Response

Przykład

Przykład renderEmailTemplate

Copy

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

Aktualizuj szablon e-mail

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Tak
updateEmailTemplateBody	UpdateEmailTemplateBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateEmailTemplate

Copy

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

Pobierz dziennik zdarzeń

req tenantId urlId userIdWS

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
userIdWS	string	Tak
startTime	number	Tak
endTime	number	Tak

Odpowiedź

Zwraca: GetEventLog200Response

Pobierz globalny dziennik zdarzeń

req tenantId urlId userIdWS

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlId	string	Tak
userIdWS	string	Tak
startTime	number	Tak
endTime	number	Tak

Odpowiedź

Zwraca: GetEventLog200Response

Utwórz wpis w kanale

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

Utwórz wpis w kanale (publiczny)

Parametry

Name	Type	Wymagane
tenantId	string	Tak
createFeedPostParams	CreateFeedPostParams	Tak
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: CreateFeedPostPublic200Response

Usuń wpis w kanale (publiczny)

Parametry

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

Odpowiedź

Zwraca: DeleteFeedPostPublic200Response

Pobierz wpisy w kanale

req tenantId afterId

Parametry

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

Odpowiedź

Zwraca: GetFeedPosts200Response

Pobierz wpisy w kanale (publiczne)

req tenantId afterId

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
afterId	string	Nie
limit	number	Nie
tags	Array	Nie
sso	string	Nie
isCrawler	boolean	Nie
includeUserInfo	boolean	Nie

Odpowiedź

Zwraca: GetFeedPostsPublic200Response

Pobierz statystyki wpisów w kanale

Parametry

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

Odpowiedź

Zwraca: GetFeedPostsStats200Response

Pobierz reakcje użytkownika (publiczne)

Parametry

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

Odpowiedź

Zwraca: GetUserReactsPublic200Response

Zareaguj na wpis w kanale (publiczne)

Parametry

Name	Type	Required
tenantId	string	Tak
postId	string	Tak
reactBodyParams	ReactBodyParams	Tak
isUndo	boolean	Nie
broadcastId	string	Nie
sso	string	Nie

Odpowiedź

Zwraca: ReactFeedPostPublic200Response

Aktualizuj wpis w kanale

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
id	string	Tak
feedPost	FeedPost	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Aktualizuj wpis w kanale (publiczny)

Parametry

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

Odpowiedź

Zwraca: CreateFeedPostPublic200Response

Zgłoś komentarz (publiczne)

Parametry

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

Odpowiedź

Zwraca: FlagCommentPublic200Response

Dodaj hashtag

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Nie
createHashTagBody	CreateHashTagBody	Nie

Odpowiedź

Zwraca: AddHashTag200Response

Przykład

Przykład addHashTag

Copy

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

Dodaj hashtagi hurtowo

Parametry

Name	Type	Required	Description
tenantId	string	Nie
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nie

Odpowiedź

Zwraca: AddHashTagsBulk200Response

Przykład

Przykład addHashTagsBulk

Copy

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

Usuń hashtag

Parametry

Name	Type	Required
tag	string	Tak
tenantId	string	Nie
deleteHashTagRequest	DeleteHashTagRequest	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład użycia deleteHashTag

Copy

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

Pobierz hashtagi

Parametry

Name	Type	Required	Description
tenantId	string	Tak
page	number	Nie

Odpowiedź

Zwraca: GetHashTags200Response

Przykład

Przykład getHashTags

Copy

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

Częściowo zaktualizuj hashtag

Parametry

Nazwa	Typ	Wymagane
tag	string	Tak
tenantId	string	Nie
updateHashTagBody	UpdateHashTagBody	Nie

Odpowiedź

Zwraca: PatchHashTag200Response

Przykład

Przykład patchHashTag

Copy

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

Utwórz moderatora

Parametry

Name	Type	Wymagane	Opis
tenantId	string	Tak
createModeratorBody	CreateModeratorBody	Tak

Odpowiedź

Zwraca: CreateModerator200Response

Przykład

Przykład createModerator

Copy

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

Usuń moderatora

Parametry

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

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteModerator

Copy

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

Pobierz moderatora

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetModerator200Response

Przykład

Przykład getModerator

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // optional source (could be undefined)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

Pobierz moderatorów

Parametry

Name	Type	Required	Description
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetModerators200Response

Przykład

Przykład użycia getModerators

Copy

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

Wyślij zaproszenie

Parametry

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

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład użycia sendInvite

Copy

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

Zaktualizuj moderatora

Parametry

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

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateModerator

Copy

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

Usuń licznik powiadomień

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteNotificationCount

Copy

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

Pobierz pamiętany licznik powiadomień

Parametry

Nazwa	Type	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetCachedNotificationCount200Response

Przykład

getCachedNotificationCount Przykład

Copy

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

Pobierz liczbę powiadomień

Parametry

Name	Type	Required
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 użycia getNotificationCount

Copy

const tenantId: string = 'tenant_8a9b7c';
const userId: string = 'user_42b3c';
const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';
const fromCommentId: string | undefined = undefined;
const viewed: boolean = false;
const type: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

Pobierz powiadomienia

Parametry

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

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

Zaktualizuj powiadomienie

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

Dodaj stronę

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPIPageData	CreateAPIPageData	Tak

Odpowiedź

Zwraca: AddPageAPIResponse

Usuń stronę

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: DeletePageAPIResponse

Pobierz stronę po URLId

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: GetPageByURLIdAPIResponse

Pobierz strony

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak

Odpowiedź

Zwraca: GetPagesAPIResponse

Częściowo zaktualizuj stronę

Parametry

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

Odpowiedź

Zwraca: PatchPageAPIResponse

Usuń oczekujące zdarzenie webhook

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deletePendingWebhookEvent

Copy

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

Pobierz licznik oczekujących zdarzeń webhook

Parametry

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

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

Pobierz oczekujące zdarzenia webhook

Parametry

Name	Type	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_78b2f1";
const commentId: string = "cmt_0042";
const eventType: string = "comment.created";
const domain: string = "blog.example.com";
const attemptCountGT: number = 1;
const skip: number = 0;
const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined, // externalId
  eventType,
  undefined, // type
  domain,
  attemptCountGT,
  skip
);

Utwórz konfigurację pytania

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionConfigBody	CreateQuestionConfigBody	Tak

Odpowiedź

Zwraca: CreateQuestionConfig200Response

Przykład

Przykład createQuestionConfig

Copy

const tenantId: string = "tenant_live_7f8b3c2a";
const customOptions: QuestionConfigCustomOptionsInner[] = [
  { value: "under18", label: "Under 18" },
  { value: "18-24", label: "18-24" },
  { value: "25-34", label: "25-34", defaultSelected: true }
];
const createQuestionConfigBody: CreateQuestionConfigBody = {
  key: "age_range",
  label: "What is your age range?",
  required: false, // opcjonalne: pokazuje pominięcie vs uwzględnienie pól opcjonalnych
  renderingType: QuestionRenderingType.Dropdown,
  options: customOptions,
  whenSave: QuestionWhenSave.Always
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

Usuń konfigurację pytania

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteQuestionConfig

Copy

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

Pobierz konfigurację pytania

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetQuestionConfig200Response

Przykład

Przykład getQuestionConfig

Copy

const tenantId: string = 'acme-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata jest opcjonalny; implementacja pominięta dla zwięzłości
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

Pobierz konfiguracje pytań

Parametry

Name	Type	Required	Description
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetQuestionConfigs200Response

Przykład

Przykład getQuestionConfigs

Copy

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

Zaktualizuj konfigurację pytania

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateQuestionConfig

Copy

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

Utwórz wynik pytania

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createQuestionResultBody	CreateQuestionResultBody	Tak

Odpowiedź

Zwraca: CreateQuestionResult200Response

Przykład

Przykład createQuestionResult

Copy

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

Usuń wynik pytania

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

deleteQuestionResult Przykład

Copy

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

Pobierz wynik pytania

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetQuestionResult200Response

Przykład

Przykład getQuestionResult

Copy

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

Pobierz wyniki pytań

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_42';
const urlId: string = 'news/2025/fastcomments-release';
const userId: string = 'user_8b7f3c';
const startDate: string = '2025-01-01T00:00:00Z';
const questionIds: string = 'q123,q124';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

Zaktualizuj wynik pytania

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_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // parametr opcjonalny
};
const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Agreguj wyniki pytań

Parametry

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

Odpowiedź

Zwraca: AggregateQuestionResults200Response

Hurtowo agreguj wyniki pytań

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Tak
forceRecalculate	boolean	Nie

Odpowiedź

Zwraca: BulkAggregateQuestionResults200Response

Połącz komentarze z wynikami pytań

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

Dodaj użytkownika SSO

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPISSOUserData	CreateAPISSOUserData	Tak

Odpowiedź

Zwraca: AddSSOUserAPIResponse

Usuń użytkownika SSO

Parametry

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

Odpowiedź

Zwraca: DeleteSSOUserAPIResponse

Pobierz użytkownika SSO po e-mailu

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
email	string	Tak

Odpowiedź

Zwraca: GetSSOUserByEmailAPIResponse

Pobierz użytkownika SSO po ID

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetSSOUserByIdAPIResponse

Pobierz użytkowników SSO

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetSSOUsers200Response

Częściowo zaktualizuj użytkownika SSO

Parametry

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

Odpowiedź

Zwraca: PatchSSOUserAPIResponse

Zastąp użytkownika SSO

Parametry

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

Odpowiedź

Zwraca: PutSSOUserAPIResponse

Utwórz subskrypcję

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Tak

Odpowiedź

Zwraca: CreateSubscriptionAPIResponse

Usuń subskrypcję

Parametry

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

Odpowiedź

Zwraca: DeleteSubscriptionAPIResponse

Pobierz subskrypcje

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Nie

Odpowiedź

Zwraca: GetSubscriptionsAPIResponse

Pobierz dzienne użycie najemcy

Parametry

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

Utwórz pakiet najemcy

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantPackageBody	CreateTenantPackageBody	Tak

Odpowiedź

Zwraca: CreateTenantPackage200Response

Przykład

Przykład createTenantPackage

Copy

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

Usuń pakiet najemcy

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteTenantPackage

Copy

const tenantId: string = 'fc-tenant-8a9c2b';
const packageId: string = 'pkg-47f3c9';
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

Pobierz pakiet najemcy

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetTenantPackage200Response

Przykład

Przykład getTenantPackage

Copy

const tenantId: string = 'tenant_westus_01';
const packageId: string = 'pkg_premium_annual_2026';
interface FetchOptions { includeArchived?: boolean }
const options: FetchOptions = { includeArchived: false };
const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

Pobierz pakiety najemcy

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
skip	number	Nie

Odpowiedź

Zwraca: GetTenantPackages200Response

Przykład

Przykład getTenantPackages

Copy

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

Zastąp pakiet najemcy

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Tak
replaceTenantPackageBody	ReplaceTenantPackageBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład replaceTenantPackage

Copy

const tenantId: string = 'tenant-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // Pola opcjonalne, takie jak "notes" lub "trialExpiry", zostały tutaj celowo pominięte
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

Zaktualizuj pakiet najemcy

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

Utwórz użytkownika najemcy

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantUserBody	CreateTenantUserBody	Tak

Odpowiedź

Zwraca: CreateTenantUser200Response

Przykład

Przykład createTenantUser

Copy

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

Usuń użytkownika najemcy

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 = 'tenant_8f3b2a9c';
const id: string = 'user_4e5f6a7b';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'hard';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

Pobierz użytkownika najemcy

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetTenantUser200Response

Przykład

Przykład getTenantUser

Copy

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

Pobierz użytkowników najemcy

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_8f3b2c1a';
const skip: number = 50;
const firstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
const nextPage: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

Zastąp użytkownika najemcy

Parametry

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

Wyślij link logowania

Parametry

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

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład sendLoginLink

Copy

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

Zaktualizuj użytkownika najemcy

Parametry

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

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateTenantUser

Copy

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

Utwórz najemcę

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createTenantBody	CreateTenantBody	Tak

Odpowiedź

Zwraca: CreateTenant200Response

Przykład

Przykład createTenant

Copy

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

Usuń najemcę

Parametry

Name	Type	Wymagane
tenantId	string	Tak
id	string	Tak
sure	string	Nie

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład deleteTenant

Copy

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

Pobierz najemcę

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetTenant200Response

Przykład

Przykład getTenant

Copy

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

Pobierz najemców

Parametry

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

Odpowiedź

Zwraca: GetTenants200Response

Przykład

Przykład getTenants

Copy

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

Zaktualizuj najemcę

Parametry

Name	Type	Required
tenantId	string	Tak
id	string	Tak
updateTenantBody	UpdateTenantBody	Tak

Odpowiedź

Zwraca: FlagCommentPublic200Response

Przykład

Przykład updateTenant

Copy

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

Prześlij obraz

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

Pobierz postęp odznaki użytkownika po ID

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetUserBadgeProgressById200Response

Pobierz postęp odznaki użytkownika po ID użytkownika

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
userId	string	Tak

Odpowiedź

Zwraca: GetUserBadgeProgressById200Response

Pobierz listę postępów odznak użytkownika

Parametry

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

Odpowiedź

Zwraca: GetUserBadgeProgressList200Response

Utwórz odznakę użytkownika

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
createUserBadgeParams	CreateUserBadgeParams	Tak

Odpowiedź

Zwraca: CreateUserBadge200Response

Usuń odznakę użytkownika

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: UpdateUserBadge200Response

Pobierz odznakę użytkownika

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetUserBadge200Response

Pobierz odznaki użytkownika

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

Zaktualizuj odznakę użytkownika

Parametry

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

Odpowiedź

Zwraca: UpdateUserBadge200Response

Pobierz licznik powiadomień użytkownika

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: GetUserNotificationCount200Response

Pobierz powiadomienia użytkownika

Parametry

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

Zresetuj licznik powiadomień użytkownika

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: ResetUserNotifications200Response

Zresetuj powiadomienia użytkownika

Parametry

Nazwa	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

Zaktualizuj status subskrypcji komentarzy powiadomień użytkownika

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

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
notificationId	string	Tak
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Tak
commentId	string	Tak
sso	string	Nie

Odpowiedź

Zwraca: UpdateUserNotificationStatus200Response

Zaktualizuj status subskrypcji strony powiadomień użytkownika

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

Parametry

Name	Type	Required
tenantId	string	Tak
urlId	string	Tak
url	string	Tak
pageTitle	string	Tak
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Tak
sso	string	Nie

Odpowiedź

Zwraca: UpdateUserNotificationStatus200Response

Zaktualizuj status powiadomienia użytkownika

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
notificationId	string	Tak
newStatus	UpdateUserNotificationStatusNewStatusEnum	Tak
sso	string	Nie

Odpowiedź

Zwraca: UpdateUserNotificationStatus200Response

Pobierz statusy obecności użytkowników

Parametry

Nazwa	Typ	Wymagane
tenantId	string	Tak
urlIdWS	string	Tak
userIds	string	Tak

Odpowiedź

Zwraca: GetUserPresenceStatuses200Response

Wyszukaj użytkowników

Parametry

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

Odpowiedź

Zwraca: SearchUsers200Response

Pobierz użytkownika

Parametry

Name	Type	Required	Description
tenantId	string	Tak
id	string	Tak

Odpowiedź

Zwraca: GetUser200Response

Przykład

getUser Przykład

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // może być niezdefiniowane w niektórych przepływach (opcjonalne)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

Utwórz głos

Parametry

Name	Type	Required
tenantId	string	Tak
commentId	string	Tak
direction	CreateVoteDirectionEnum	Tak
userId	string	Nie
anonUserId	string	Nie

Odpowiedź

Zwraca: VoteComment200Response

Przykład

Przykład createVote

Copy

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

Usuń głos

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_7f3b21c9';
const id: string = 'vote_4a2d9f1b';
const editKey: string = 'edit_92b7c6a1';
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);

Pobierz głosy

Parametry

Nazwa	Typ	Wymagane	Opis
tenantId	string	Tak
urlId	string	Tak

Odpowiedź

Zwraca: GetVotes200Response

Przykład

Przykład użycia getVotes

Copy

const tenantId: string = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// Jeśli istniałby opcjonalny parametr, np. includeHidden, można by go użyć w ten sposób:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

Pobierz głosy dla użytkownika

Parametry

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

Odpowiedź

Zwraca: GetVotesForUser200Response

Przykład

Przykład getVotesForUser

Copy

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

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

Agregacja

Dzienniki audytu

Blokowanie z komentarza

Sprawdzanie zablokowanych komentarzy

Komentarze

Konfiguracje domeny

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 najemcy

Pakiety najemcy

Użytkownicy najemcy

Najemcy

Przesyłanie obrazu

Postęp odznaki użytkownika

Odznaki użytkownika

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

Kompatybilność 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

ID transmisji

Obsługa błędów

Agreguj

Parametry

Odpowiedź

Pobierz dzienniki audytu

Parametry

Odpowiedź

Zablokuj z komentarza (publiczne)

Parametry

Odpowiedź

Odblokuj komentarz (publiczne)