FastComments JavaScript/TypeScript SDK

npm install fastcomments-sdk

Полная справка по API: docs/api/README.md

Этот SDK использует двойные точки входа, чтобы обеспечить оптимальную совместимость и предотвратить ошибки выполнения:

• fastcomments-sdk/browser - Безопасная для браузера версия с нативным fetch
• fastcomments-sdk/server - Полная версия для Node.js с поддержкой SSO
• fastcomments-sdk (по умолчанию) - Только типы, безопасно импортировать в любом месте

SDK предоставляет три основных класса API:

• DefaultApi - Защищённые конечные точки, для которых требуется ваш API-ключ для аутентификации. Используйте их для операций на стороне сервера.
• PublicApi - Публичные конечные точки, к которым можно получить доступ без API-ключа. Их можно вызывать напрямую из браузеров/мобильных устройств и т.д.
• HiddenApi - Внутренние/административные конечные точки для продвинутых сценариев использования.

Пример: Использование Public API (безопасно для браузера)

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

const publicApi = new PublicApi();

// Получить комментарии для страницы (API-ключ не требуется)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Пример: Использование Default API (только на стороне сервера)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Держите это в секрете!
});
const defaultApi = new DefaultApi(config);

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

FastComments поддерживает SSO для интеграции с вашей существующей системой аутентификации пользователей. Функциональность SSO доступна только в серверном экспорте, так как требует возможностей crypto в Node.js.

Simple SSO (Server-Side Only)

Простой SSO должен генерироваться на стороне сервера и отправляться клиенту:

// Серверный код (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

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

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

const ssoToken = sso.createToken();

// Отправьте ssoToken на клиент
// Код на стороне клиента затем может использовать этот токен с браузерным SDK

Secure SSO (Server-Side, Recommended)

Защищённый SSO должен реализовываться на стороне сервера и обеспечивает лучшую безопасность:

// Серверный код (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

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

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

const ssoConfig = sso.prepareToSend();

// Используйте при вызовах API на сервере
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Или отправьте ssoConfig клиенту для использования в браузере

Using SSO from Browser (with Server-Generated Token)

// Клиентский код (браузер)
import { PublicApi } from 'fastcomments-sdk/browser';

// Получите SSO токен с вашего серверного эндпоинта
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 with Comment Creation

// На стороне сервера: создать SSO и комментарий
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)
});

Получение комментариев для страницы

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

Создание комментария

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

Голосование за комментарий

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 для голосования «за», -1 для голосования «против»
  }
});

Управление пользователями (требуется API-ключ)

// Поиск пользователей (требуется DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Подпишитесь на live-события, чтобы получать обновления в реальном времени о комментариях, голосах и других действиях.

События на уровне страницы

Отслеживайте live-события на конкретной странице (комментарии, голоса и т.д.):

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

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

// Подписаться на live-события для страницы
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (получить из ответа getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Обновите интерфейс, добавив новый комментарий
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Обновите счетчики голосов в интерфейсе
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Вернуть true, если событие обработано
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

Подписка на пользовательские события

Отслеживайте события, связанные с пользователем (уведомления, упоминания и т.д.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Получите это из ответа getComments
};

// Подписаться на личную ленту пользователя
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Показать уведомление в интерфейсе
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }

    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Закрыть по завершении
userSubscription.close();

Получение userIdWS

Параметр userIdWS требуется для live-событий и может быть получен из ответов API:

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

// Извлечь userIdWS из ответа
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Теперь можно подписаться на live-события
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Вы увидите, что в некоторых вызовах API требуется передавать broadcastId. Когда вы получаете события, вы получите этот ID обратно, так что сможете игнорировать событие, если планируете оптимистично применять изменения на клиенте (и, вероятно, вам захочется так сделать, поскольку это обеспечивает лучший опыт). Передайте здесь UUID. Этот ID должен быть достаточно уникальным, чтобы не повториться дважды в рамках одной сессии браузера.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // Уникальный ID для этой операции
  }
});

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

Агрегирует документы, группируя их (если указан groupBy) и применяя несколько операций. Поддерживаются различные операции (например, sum, countDistinct, avg и т.д.).

Параметры

Ответ

Возвращает: AggregationResponse

Параметры

Ответ

Возвращает: GetAuditLogs200Response

Параметры

Ответ

Возвращает: BlockFromCommentPublic200Response

Параметры

Ответ

Возвращает: UnBlockCommentPublic200Response

Параметры

Ответ

Возвращает: CheckedCommentsForBlocked200Response

Параметры

Ответ

Возвращает: BlockFromCommentPublic200Response

Параметры

Ответ

Возвращает: CreateCommentPublic200Response

Параметры

Ответ

Возвращает: DeleteComment200Response

Параметры

Ответ

Возвращает: DeleteCommentPublic200Response

Параметры

Ответ

Возвращает: DeleteCommentVote200Response

Параметры

Ответ

Возвращает: FlagComment200Response

Параметры

Ответ

Возвращает: GetComment200Response

Параметры

Ответ

Возвращает: GetComments200Response

req tenantId urlId

Параметры

Ответ

Возвращает: GetCommentsPublic200Response

Параметры

Ответ

Возвращает: GetCommentText200Response

Параметры

Ответ

Возвращает: GetCommentVoteUserNames200Response

Параметры

Ответ

Возвращает: LockComment200Response

Параметры

Ответ

Возвращает: PinComment200Response

Параметры

Ответ

Возвращает: SaveComment200Response

Параметры

Ответ

Возвращает: Array<SaveComment200Response

Параметры

Ответ

Возвращает: SetCommentText200Response

Параметры

Ответ

Возвращает: UnBlockCommentPublic200Response

Параметры

Ответ

Возвращает: FlagComment200Response

Параметры

Ответ

Возвращает: LockComment200Response

Параметры

Ответ

Возвращает: PinComment200Response

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Параметры

Ответ

Возвращает: VoteComment200Response

Параметры

Ответ

Возвращает: AddDomainConfig200Response

Параметры

Ответ

Возвращает: DeleteDomainConfig200Response

Параметры

Ответ

Возвращает: GetDomainConfig200Response

Параметры

Ответ

Возвращает: GetDomainConfigs200Response

Параметры

Ответ

Возвращает: GetDomainConfig200Response

Параметры

Ответ

Возвращает: GetDomainConfig200Response

Параметры

Ответ

Возвращает: CreateEmailTemplate200Response

Пример

Пример createEmailTemplate

Copy

1

2const tenantId: string = "tenant_7a9f2b3d";

3

4const createEmailTemplateBody: CreateEmailTemplateBody = {

5 name: "Comment Notification",

6 subject: "New comment on your article: ",

7 htmlBody: "<p> left a comment:</p><blockquote></blockquote>",

8 enabled: true,

9 defaultLocale: "en-US",

10 metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // необязательные дополнительные данные

11};

12

13const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

14

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteEmailTemplate

Copy

1

2const tenantId: string = "tenant_4b2f6a-4b2f6a2d";

3const templateId: string = "email_template_9f8b7c3e";

4const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

5const status: APIStatus | undefined = result?.status

6

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteEmailTemplateRenderError

Copy

1

2const tenantId: string = "tenant_8f3b2a9c";

3const id: string = "template_4a1c9f7e";

4const errorId: string = "err_20260112_abc123";

5const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

6

Параметры

Ответ

Возвращает: GetEmailTemplate200Response

Пример

Пример getEmailTemplate

Copy

1

2(async () => {

3 const tenantId: string = 'acme-enterprises-123';

4 const id: string = 'welcome-email-template-v2';

5 const locale: string | undefined = 'en-US'; // пример необязательного параметра

6 const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);

7 console.log(template, locale);

8})();

9

Parameters

Response

Возвращает: GetEmailTemplateDefinitions200Response

Example

Пример getEmailTemplateDefinitions

Copy

1

2const tenantId: string = 'acme-enterprises-78f2';

3const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

4

Параметры

Ответ

Возвращает: GetEmailTemplateRenderErrors200Response

Пример

Пример getEmailTemplateRenderErrors

Copy

1

2const tenantId: string = "tenant_7b3f2a9c";

3const id: string = "tmpl_4f1b2c9e";

4const skip: number = 25;

5const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

6

Параметры

Ответ

Возвращает: GetEmailTemplates200Response

Пример

Пример getEmailTemplates

Copy

1

2const tenantId: string = 'tenant_8f4d2b7c';

3const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);

4const skip: number = 20;

5const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

6

Параметры

Ответ

Возвращает: RenderEmailTemplate200Response

Пример

Пример renderEmailTemplate

Copy

1

2const tenantId: string = 'acme-corp-7f3';

3const renderEmailTemplateBody: RenderEmailTemplateBody = {

4 templateId: 'new-comment-notification',

5 recipientEmail: 'jane.doe@acme.com',

6 variables: {

7 commenterName: 'Samir Patel',

8 commentText: 'I found this article really helpful — thanks for sharing!',

9 threadUrl: 'https://acme.com/blog/123#comments'

10 },

11 includeUnsubscribeLink: true

12};

13const locale: string = 'en-US';

14const response: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

15

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример updateEmailTemplate

Copy

1

2const tenantId: string = 'acme-corp-tenant-01';

3const id: string = 'email_tpl_42b7a9';

4const updateEmailTemplateBody: UpdateEmailTemplateBody = {

5 name: 'Comment Flag Notification',

6 subject: 'A comment was flagged on acme.com',

7 html: '<p>A comment by was flagged. Review at </p>',

8 replyTo: 'noreply@acme.com', // необязательное поле (пример)

9 enabled: true,

10 customConfig: { priority: 'high' } // необязательные пользовательские параметры

11};

12const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

13

req tenantId urlId userIdWS

Параметры

Ответ

Возвращает: GetEventLog200Response

req tenantId urlId userIdWS

Параметры

Ответ

Возвращает: GetEventLog200Response

Параметры

Ответ

Возвращает: CreateFeedPost200Response

Параметры

Ответ

Возвращает: CreateFeedPostPublic200Response

Параметры

Ответ

Возвращает: DeleteFeedPostPublic200Response

req tenantId afterId

Параметры

Ответ

Возвращает: GetFeedPosts200Response

req tenantId afterId

Параметры

Ответ

Возвращает: GetFeedPostsPublic200Response

Параметры

Ответ

Возвращает: GetFeedPostsStats200Response

Параметры

Ответ

Возвращает: GetUserReactsPublic200Response

Параметры

Ответ

Возвращает: ReactFeedPostPublic200Response

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Параметры

Ответ

Возвращает: CreateFeedPostPublic200Response

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Параметры

Ответ

Возвращает: AddHashTag200Response

Пример

Пример addHashTag

Copy

1

2const tenantId: string = 'tenant_7b2f6c2b';

3const createBody: CreateHashTagBody = {

4 tag: 'feature-request',

5 label: 'Feature Request',

6 description: 'Requests for new functionality in the web client',

7 isActive: true,

8 visibility: 'public',

9 allowedDomains: ['example.com', 'internal.example.com']

10};

11const result: AddHashTag200Response = await addHashTag(tenantId, createBody);

12const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {

13 tag: 'bug',

14 label: 'Bug',

15 description: 'Use for reproducible bugs reported by users',

16 isActive: true,

17 visibility: 'public'

18});

19

Параметры

Ответ

Возвращает: AddHashTagsBulk200Response

Пример

Пример addHashTagsBulk

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_3f2b9a';

4 const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {

5 tags: [

6 { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },

7 { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }

8 ]

9 };

10 const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

11 const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

12 console.log(result, resultWithNoTenant);

13})();

14

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteHashTag

Copy

1

2const tag: string = 'breaking-news';

3const tenantId: string = 'tenant_42';

4const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;

5const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);

6

Параметры

Ответ

Возвращает: GetHashTags200Response

Пример

Пример getHashTags

Copy

1

2(async () => {

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

4 const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);

5 const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);

6 console.log(tagsPage1, tagsPage2);

7})();

8

Параметры

Ответ

Возвращает: PatchHashTag200Response

Пример

Пример patchHashTag

Copy

1

2const tag: string = 'release-2026';

3const tenantId: string = 'tenant_42';

4const updateHashTagBody: UpdateHashTagBody = {

5 displayName: 'Release 2026',

6 description: 'Discussions and notes for the 2026 product release',

7 isActive: true

8};

9const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

10

Параметры

Ответ

Возвращает: CreateModerator200Response

Пример

Пример createModerator

Copy

1

2const tenantId: string = "tenant_prod_us-east_01";

3const createModeratorBody: CreateModeratorBody = {

4 email: "maria.lopez+mod@fastcompany.com",

5 username: "mlopez_mod",

6 displayName: "Maria Lopez",

7 roles: ["content_moderator"],

8 notifyOnReports: true,

9 metadata: { region: "us-east", team: "community" }

10};

11const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

12

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteModerator

Copy

1

2const tenantId: string = 'acme-tenant-987';

3const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';

4const sendEmail: string = 'true';

5const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

6

Параметры

Ответ

Возвращает: GetModerator200Response

Пример

Пример getModerator

Copy

1

2const tenantId: string = "tenant_eu_4f8d2b9e";

3const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // необязательный источник (может быть undefined)

4const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

5

Параметры

Ответ

Возвращает: GetModerators200Response

Пример

Пример getModerators

Copy

1

2const tenantId: string = "tenant_corp_7f9b2a";

3const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);

4const skip: number = 50;

5const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

6

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример sendInvite

Copy

1

2const tenantId: string = 'acme-tenant-004';

3const id: string = 'comment_9b7f3a2c';

4const fromName: string = 'María Hernández';

5const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

6

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример updateModerator

Copy

1

2const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';

3const id: string = 'mod_92a7c4';

4const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };

5const updateModeratorBodyWithOptional: UpdateModeratorBody = {

6 displayName: 'Sophia Patel',

7 email: 'sophia.patel@newsroom.example',

8 permissions: ['remove_comments', 'ban_user'],

9 notifyOnFlag: true // показан необязательный параметр

10};

11const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);

12

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteNotificationCount

Copy

1

2const tenantId: string = 'tenant_7f3a1b2c4d9e';

3const notificationId: string = 'notif_8c9d0a1b2f3e4b7';

4const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);

5

Параметры

Ответ

Возвращает: GetCachedNotificationCount200Response

Пример

Пример getCachedNotificationCount

Copy

1

2const tenantId: string = 'acme-tenant-01';

3const baseNotificationId: string = 'notif-000123';

4const idSuffix: string | undefined = undefined; // пример необязательного параметра

5const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;

6const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);

7console.log(result);

8

Параметры

Ответ

Возвращает: GetNotificationCount200Response

Пример

Пример getNotificationCount

Copy

1

2const tenantId: string = 'tenant_8a9b7c';

3const userId: string = 'user_42b3c';

4const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';

5const fromCommentId: string | undefined = undefined;

6const viewed: boolean = false;

7const type: string = 'mention';

8const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

9

Параметры

Ответ

Возвращает: GetNotifications200Response

Пример

Пример getNotifications

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_8f3b1a2c';

4 const userId: string = 'user_42';

5 const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';

6 const fromCommentId: string = 'cmt_9a7b';

7 const viewed: boolean = false;

8 const type: string = 'mention';

9 const skip: number = 0;

10 const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

11 console.log(response);

12})();

13

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример updateNotification

Copy

1

2const tenantId: string = "tenant_86a7b3";

3const id: string = "notif_20260112_01";

4const userId: string = "moderator_42";

5const updateNotificationBody: UpdateNotificationBody = {

6 name: "Flagged comment alert",

7 enabled: true,

8 channels: ["email"],

9 recipients: ["mod-team@news-site.com"],

10 threshold: 1

11};

12

13(async () => {

14 const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

15 console.log(result);

16})();

17

Параметры

Ответ

Возвращает: AddPageAPIResponse

Параметры

Ответ

Возвращает: DeletePageAPIResponse

Параметры

Ответ

Возвращает: GetPageByURLIdAPIResponse

Параметры

Ответ

Возвращает: GetPagesAPIResponse

Параметры

Ответ

Возвращает: PatchPageAPIResponse

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deletePendingWebhookEvent

Copy

1

2const tenantId: string = 'tenant_7f4e2b';

3const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';

4const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);

5console.log(result);

6

Параметры

Ответ

Возвращает: GetPendingWebhookEventCount200Response

Пример

Пример использования getPendingWebhookEventCount

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_9c3b2b';

4 const commentId: string = 'cmt_f4a1b2';

5 const externalId: string = 'ext-789';

6 const eventType: string = 'comment.created';

7 const type: string = 'delivery';

8 const domain: string = 'app.example.com';

9 const attemptCountGT: number = 2;

10

11 const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(

12 tenantId,

13 commentId,

14 externalId,

15 eventType,

16 type,

17 domain,

18 attemptCountGT

19 );

20

21 console.log(result);

22})();

23

Параметры

Ответ

Возвращает: GetPendingWebhookEvents200Response

Пример

Пример getPendingWebhookEvents

Copy

1

2const tenantId: string = "tenant_78b2f1";

3const commentId: string = "cmt_0042";

4const eventType: string = "comment.created";

5const domain: string = "blog.example.com";

6const attemptCountGT: number = 1;

7const skip: number = 0;

8

9const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(

10 tenantId,

11 commentId,

12 undefined, // externalId (внешний идентификатор)

13 eventType,

14 undefined, // type (тип)

15 domain,

16 attemptCountGT,

17 skip

18);

19

Параметры

Ответ

Возвращает: CreateQuestionConfig200Response

Пример

Пример createQuestionConfig

Copy

1

2const tenantId: string = "tenant_live_7f8b3c2a";

3const customOptions: QuestionConfigCustomOptionsInner[] = [

4 { value: "under18", label: "Under 18" },

5 { value: "18-24", label: "18-24" },

6 { value: "25-34", label: "25-34", defaultSelected: true }

7];

8const createQuestionConfigBody: CreateQuestionConfigBody = {

9 key: "age_range",

10 label: "What is your age range?",

11 required: false, // необязательно: демонстрация пропуска по сравнению с включением необязательных полей

12 renderingType: QuestionRenderingType.Dropdown,

13 options: customOptions,

14 whenSave: QuestionWhenSave.Always

15};

16const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

17

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteQuestionConfig

Copy

1

2async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {

3 if (!id) return null;

4 const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

5 return result;

6}

7const tenantId: string = 'tenant_acme_001';

8const optionalConfigId: string | undefined = 'qcfg_20260112_01';

9(async (): Promise<void> => {

10 const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);

11 void deleted;

12})();

13

Параметры

Ответ

Возвращает: GetQuestionConfig200Response

Пример

Пример getQuestionConfig

Copy

1

2const tenantId: string = 'acme-corp-47';

3const questionId: string = 'q-2026-01-12-01';

4const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);

5function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {

6 // includeMetadata необязателен; реализация опущена ради краткости

7 return undefined;

8}

9const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);

10const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

11

Параметры

Ответ

Возвращает: GetQuestionConfigs200Response

Пример

Пример getQuestionConfigs

Copy

1

2const tenantId: string = 'tenant-42a7b9';

3const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);

4const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);

5

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример updateQuestionConfig

Copy

1

2const tenantId: string = 'tenant-82b3a';

3const id: string = 'qst-20260112';

4const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;

5const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

6

Параметры

Ответ

Возвращает: CreateQuestionResult200Response

Пример

Пример createQuestionResult

Copy

1

2const tenantId: string = "fc_tenant_7a3c_us-east-1";

3const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };

4const createQuestionResultBody: CreateQuestionResultBody = {

5 questionId: "q_42",

6 commenterId: "user_1984",

7 answer: "yes",

8 score: 4,

9 meta: [metaItem] // пример необязательных метаданных

10} as CreateQuestionResultBody;

11const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

12

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteQuestionResult

Copy

1

2const tenantId: string = 'acme-tenant-01';

3const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';

4const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);

5console.log(deletedResult);

6

Параметры

Ответ

Возвращает: GetQuestionResult200Response

Пример

Пример getQuestionResult

Copy

1

2const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";

3const questionId: string = "question_72f1b9c3a4";

4const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);

5console.log(result);

6

Параметры

Ответ

Возвращает: GetQuestionResults200Response

Пример

Пример getQuestionResults

Copy

1

2const tenantId: string = 'tenant_42';

3const urlId: string = 'news/2025/fastcomments-release';

4const userId: string = 'user_8b7f3c';

5const startDate: string = '2025-01-01T00:00:00Z';

6const questionIds: string = 'q123,q124';

7const skip: number = 20;

8const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

9

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример updateQuestionResult

Copy

1

2const tenantId: string = 'tenant_84f2b9';

3const id: string = 'question_3a7c1d';

4const updateQuestionResultBody: UpdateQuestionResultBody = {

5 result: { verdict: 'helpful', confidence: 0.92 },

6 reviewer: { id: 'mod_102', name: 'Aisha Rahman' },

7 notifyUser: true // необязательный параметр включён

8};

9const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

10

Параметры

Ответ

Возвращает: AggregateQuestionResults200Response

Параметры

Ответ

Возвращает: BulkAggregateQuestionResults200Response

Параметры

Ответ

Возвращает: CombineCommentsWithQuestionResults200Response

Параметры

Ответ

Возвращает: AddSSOUserAPIResponse

Параметры

Ответ

Возвращает: DeleteSSOUserAPIResponse

Параметры

Ответ

Возвращает: GetSSOUserByEmailAPIResponse

Параметры

Ответ

Возвращает: GetSSOUserByIdAPIResponse

Параметры

Ответ

Возвращает: GetSSOUsers200Response

Параметры

Ответ

Возвращает: PatchSSOUserAPIResponse

Параметры

Ответ

Возвращает: PutSSOUserAPIResponse

Параметры

Ответ

Возвращает: CreateSubscriptionAPIResponse

Параметры

Ответ

Возвращает: DeleteSubscriptionAPIResponse

Параметры

Ответ

Возвращает: GetSubscriptionsAPIResponse

Параметры

Ответ

Возвращает: GetTenantDailyUsages200Response

Пример

Пример getTenantDailyUsages

Copy

1

2const tenantId: string = "tenant_89f3c2-prod";

3const yearNumber: number = 2026;

4const monthNumber: number = 1;

5const skip: number = 0;

6const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

7

Параметры

Ответ

Возвращает: CreateTenantPackage200Response

Пример

Пример createTenantPackage

Copy

1

2const tenantId: string = "tenant_7f3b1a9c";

3const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };

4const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };

5const createTenantPackageBody: CreateTenantPackageBody = {

6 packageName: "Premium Plus",

7 tenantPackage,

8 customConfig,

9 notes: "Enable advanced moderation and image uploads" // необязательный параметр (демонстрация)

10};

11const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

12

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример deleteTenantPackage

Copy

1

2const tenantId: string = 'fc-tenant-8a9c2b';

3const packageId: string = 'pkg-47f3c9';

4const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

5

Parameters

Response

Возвращает: GetTenantPackage200Response

Example

Пример getTenantPackage

Copy

1

2const tenantId: string = 'tenant_westus_01';

3const packageId: string = 'pkg_premium_annual_2026';

4interface FetchOptions { includeArchived?: boolean }

5const options: FetchOptions = { includeArchived: false };

6const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

7

Параметры

Ответ

Возвращает: GetTenantPackages200Response

Пример

Пример getTenantPackages

Copy

1

2const tenantId: string = 'tenant_4f3a9c2d';

3const skip: number = 25;

4const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);

5const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

6

Параметры

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример replaceTenantPackage

Copy

1

2const tenantId: string = 'tenant-9b72f2';

3const packageId: string = 'pkg-prod-v2';

4const replaceTenantPackageBody: ReplaceTenantPackageBody = {

5 name: 'Premium Moderation Bundle',

6 enabled: true,

7 maxModerators: 4,

8 // необязательные поля, такие как "notes" или "trialExpiry", намеренно опущены здесь

9} as ReplaceTenantPackageBody;

10const result: FlagCommentPublic200Response = await replaceTenantPackage(

11 tenantId,

12 packageId,

13 replaceTenantPackageBody

14);

15