FastComments SDK для JavaScript/TypeScript

Це офіційний SDK для JavaScript/TypeScript від FastComments.

Керуйте коментарями, користувачами, SSO та модерацією з Node.js або браузера.

Репозиторій

Встановлення

npm install fastcomments-sdk

Документація API

Повна документація API: docs/api/README.md

Сумісність браузера та сервера

Цей SDK використовує подвійні точки входу, щоб забезпечити оптимальну сумісність і запобігти помилкам під час виконання:

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

Використання

Цей SDK надає окремі точки входу для середовищ браузера та сервера, щоб забезпечити оптимальну сумісність і безпеку:

Використання в браузері (клієнтська сторона)

Для браузерних/фронтенд-застосунків використовуйте браузерний експорт без залежностей від Node.js:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Використання на сервері (Node.js)

Для серверних/бекенд-застосунків використовуйте повний SDK зі SSO та функціями аутентифікації:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Імпорт тільки типів

Якщо вам потрібні лише типи TypeScript (без виконуваного коду), використовуйте стандартний імпорт:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Використання окремих класів API

Середовище браузера

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

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

const publicApi = new PublicApi(config);

Середовище сервера

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

SDK надає наступні класи API:

DefaultApi - Захищені кінцеві точки, які вимагають вашого API-ключа для автентифікації. Використовуйте їх для серверних операцій.
PublicApi - Публічні кінцеві точки, до яких можна отримати доступ без API-ключа. Їх можна викликати безпосередньо з браузерів/мобільних пристроїв тощо.
ModerationApi - Кінцеві точки панелі модератора (модерація коментарів, блокування, бейджі, фактор довіри, пошук). Автентифікація через сесію модератора; передайте параметр запиту sso для модераторів, автентифікованих через SSO.
HiddenApi - Внутрішні/адміністративні кінцеві точки для розширених випадків використання.

Приклад: Використання Public API (browser-safe)

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 (server-side only)

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

Приклад: Використання Moderation API

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

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

// Виклики, автентифіковані модератором (cookie сесії, або передайте `sso` для модератора з SSO).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

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

Інтеграція SSO (єдиний вхід)

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

Просте SSO (тільки на сервері)

Прості SSO-токени мають генеруватися на сервері та передаватися клієнту:

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

// Створити просте SSO за допомогою вбудованого помічника  
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

Безпечне SSO (серверна сторона, рекомендовано)

Безпечне SSO слід реалізовувати на сервері — воно забезпечує кращий рівень безпеки:

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

// Створити безпечне SSO за допомогою вбудованого помічника
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 клієнту для використання в браузері

Використання SSO з браузера (з токеном, згенерованим на сервері)

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

// Отримати SSO токен з вашого серверного endpoint
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Використайте SSO токен, згенерований на сервері
});

SSO зі створенням коментаря

// На сервері: створити 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'
});

Живі події (оновлення в реальному часі)

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

Події на рівні сторінки

Слухайте події в реальному часі для конкретної сторінки (коментарі, голоси тощо):

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

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

// Підписатися на живі події для сторінки
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (отримайте це з відповіді getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Оновіть ваш інтерфейс користувача новим коментарем
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Оновіть підрахунок голосів у вашому інтерфейсі
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Поверніть 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 потрібен для живих подій і може бути отриманий з відповідей API:

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

// Витягніть userIdWS з відповіді
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Тепер ви можете підписатися на живі події
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Ідентифікатори трансляції

Ви побачите, що потрібно передавати broadcastId у деяких викликах API. Коли ви отримуватимете події, ви отримаєте назад цей ID, тож знатимете, що ігнорувати подію, якщо плануєте оптимістично застосовувати зміни на клієнті (а саме так, ймовірно, і варто робити, оскільки це забезпечує найкращий досвід). Передайте сюди UUID. ID повинен бути достатньо унікальним, щоб не повторюватися двічі в одній сесії браузера.

import { v4 as uuidv4 } from 'uuid';

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

Обробка помилок

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

aggregate

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

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

Відповідь

Повертає: AggregateResponse

Приклад

Приклад агрегування

Copy

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

getAuditLogs

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Відповідь

Повертає: GetAuditLogsResponse1

Приклад

Приклад getAuditLogs

Copy

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

blockFromCommentPublic

Параметри

Name	Type	Required
tenantId	string	Так
commentId	string	Так
publicBlockFromCommentParams	PublicBlockFromCommentParams	Так
sso	string	Ні

Відповідь

Повертає: BlockFromCommentPublicResponse

Приклад

blockFromCommentPublic Приклад

Copy

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

unBlockCommentPublic

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
commentId	string	Так
publicBlockFromCommentParams	PublicBlockFromCommentParams	Так
sso	string	Ні

Відповідь

Повертає: UnBlockCommentPublicResponse

Приклад

unBlockCommentPublic Приклад

Copy

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

checkedCommentsForBlocked

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
commentIds	string	Yes
sso	string	No

Відповідь

Повертає: CheckedCommentsForBlockedResponse

Приклад

checkedCommentsForBlocked Приклад

Copy

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

blockUserFromComment

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Так
blockFromCommentParams	BlockFromCommentParams	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: BlockUserFromCommentResponse

Приклад

blockUserFromComment Приклад

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // необов'язковий параметр
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

createCommentPublic

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
commentData	CommentData	Yes
sessionId	string	No
sso	string	No

Відповідь

Повертає: CreateCommentPublicResponse

Приклад

createCommentPublic Приклад

Copy

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

deleteComment

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	Yes
contextUserId	string	No
isLive	boolean	No

Відповідь

Повертає: DeleteCommentResponse

Приклад

Приклад deleteComment

Copy

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

deleteCommentPublic

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Відповідь

Повертає: DeleteCommentPublicResponse

Приклад

deleteCommentPublic Приклад

Copy

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

deleteCommentVote

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
voteId	string	Так
urlId	string	Так
broadcastId	string	Так
editKey	string	Ні
sso	string	Ні

Відповідь

Повертає: DeleteCommentVoteResponse

Приклад

deleteCommentVote Приклад

Copy

async function removeVote() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const voteId: string = "vote_abcde";
  const urlId: string = "url_56789";
  const broadcastId: string = "brd_001";
  const editKey: string = "edit_456";
  // sso є необов'язковим і опущено
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

flagComment

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: FlagCommentResponse1

Приклад

Приклад flagComment

Copy

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

getComment

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetCommentResponse

Приклад

Приклад getComment

Copy

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

getComments

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
page	number	Ні
limit	number	Ні
skip	number	Ні
asTree	boolean	Ні
skipChildren	number	Ні
limitChildren	number	Ні
maxTreeDepth	number	Ні
urlId	string	Ні
userId	string	Ні
anonUserId	string	Ні
contextUserId	string	Ні
hashTag	string	Ні
parentId	string	Ні
direction	SortDirections	Ні
fromDate	number	Ні
toDate	number	Ні

Відповідь

Повертає: GetCommentsResponse

Приклад

Приклад getComments

Copy

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

getCommentsPublic

req tenantId urlId

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
urlId	string	Yes
page	number	No
direction	SortDirections	No
sso	string	No
skip	number	No
skipChildren	number	No
limit	number	No
limitChildren	number	No
countChildren	boolean	No
fetchPageForCommentId	string	No
includeConfig	boolean	No
countAll	boolean	No
includei10n	boolean	No
locale	string	No
modules	string	No
isCrawler	boolean	No
includeNotificationCount	boolean	No
asTree	boolean	No
maxTreeDepth	number	No
useFullTranslationIds	boolean	No
parentId	string	No
searchText	string	No
hashTags	Array	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

Відповідь

Повертає: GetCommentsPublicResponse

Приклад

Приклад getCommentsPublic

Copy

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

getCommentText

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

Відповідь

Повертає: GetCommentTextResponse1

Приклад

Приклад getCommentText

Copy

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

getCommentVoteUserNames

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

Відповідь

Повертає: GetCommentVoteUserNamesResponse

Приклад

Приклад getCommentVoteUserNames

Copy

async function demoGetCommentVoteUserNames() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_5f2a1e3b";
  const dir: number = 1; // зростаючий
  const votesWithoutSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir
  );
  const ssoToken: string = "sso_abcdef123456";
  const votesWithSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir,
    ssoToken
  );
  console.log(votesWithoutSSO, votesWithSSO);
}

lockComment

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Відповідь

Повертає: LockCommentResponse

Приклад

lockComment Приклад

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // З необов’язковим токеном SSO
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // Без токену SSO
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

pinComment

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: PinCommentResponse

Приклад

pinComment Приклад

Copy

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

saveComment

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Відповідь

Повертає: SaveCommentResponse

Приклад

saveComment Приклад

Copy

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

saveCommentsBulk

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
createCommentParams	Array	Так
isLive	boolean	Ні
doSpamCheck	boolean	Ні
sendEmails	boolean	Ні
populateNotifications	boolean	Ні

Відповідь

Повертає: Array<SaveCommentsBulkResponse

Приклад

Приклад saveCommentsBulk

Copy

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

setCommentText

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
commentTextUpdateRequest	CommentTextUpdateRequest	Yes
editKey	string	No
sso	string	No

Відповідь

Повертає: SetCommentTextResponse1

Приклад

Приклад setCommentText

Copy

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

unBlockUserFromComment

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Так
unBlockFromCommentParams	UnBlockFromCommentParams	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: UnBlockUserFromCommentResponse

Приклад

unBlockUserFromComment Приклад

Copy

async function demoUnblock() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt_9f8b7a6d";
  const params: UnBlockFromCommentParams = {
    reason: "User resolved the issue",
    notifyUser: true
  };
  const userId: string = "usr_12345";
  const result: UnBlockUserFromCommentResponse = await unBlockUserFromComment(
    tenantId,
    commentId,
    params,
    userId
    // anonUserId пропущено
  );
  console.log(result);
}
demoUnblock();

unFlagComment

Parameters

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Відповідь

Повертає: UnFlagCommentResponse

Приклад

unFlagComment Приклад

Copy

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

unLockComment

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: UnLockCommentResponse

Приклад

unLockComment Приклад

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const broadcastId: string = "brd_001";
const ssoToken: string | undefined = "sso_token_abc";
async function run() {
  const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
  console.log(unlocked);
  // Виклик без необов'язкового параметра sso
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

unPinComment

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: UnPinCommentResponse

Приклад

unPinComment Приклад

Copy

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

updateComment

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
id	string	Yes
updatableCommentParams	UpdatableCommentParams	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Відповідь

Повертає: UpdateCommentResponse

Приклад

Приклад updateComment

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // приклад полів; фактична структура залежить від визначення API
  // наприклад, body: "Edited comment content",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

voteComment

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
voteBodyParams	VoteBodyParams	Yes
sessionId	string	No
sso	string	No

Відповідь

Повертає: VoteCommentResponse

Приклад

Приклад voteComment

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_9f8e7d6c";
const urlId: string = "url_123456";
const broadcastId: string = "bcast_2024_01";
const voteBodyParams: VoteBodyParams = {
  vote: "up",               // наприклад, "up" | "down"
  weight: 1,                // необов’язкове зважування голосу
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

getCommentsForUser

Параметри

Назва	Тип	Обов'язково
userId	string	No
direction	SortDirections	No
repliesToUserId	string	No
page	number	No
includei10n	boolean	No
locale	string	No
isCrawler	boolean	No

Відповідь

Повертає: GetCommentsForUserResponse1

Приклад

Приклад getCommentsForUser

Copy

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

addDomainConfig

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
addDomainConfigParams	AddDomainConfigParams	Так

Відповідь

Повертає: AddDomainConfigResponse

Приклад

addDomainConfig Приклад

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // опис є необов’язковим і пропущений тут
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

deleteDomainConfig

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Yes
domain	string	Yes

Відповідь

Повертає: DeleteDomainConfigResponse

Приклад

deleteDomainConfig Приклад

Copy

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

getDomainConfig

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Yes
domain	string	Yes

Відповідь

Повертає: GetDomainConfigResponse

Приклад

getDomainConfig Приклад

Copy

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

getDomainConfigs

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так

Відповідь

Повертає: GetDomainConfigsResponse

Приклад

Приклад getDomainConfigs

Copy

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

patchDomainConfig

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
domainToUpdate	string	Yes
patchDomainConfigParams	PatchDomainConfigParams	Yes

Відповідь

Повертає: PatchDomainConfigResponse

Приклад

patchDomainConfig Приклад

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // продемонстровано необов'язковий параметр
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

putDomainConfig

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
domainToUpdate	string	Yes
updateDomainConfigParams	UpdateDomainConfigParams	Yes

Відповідь

Повертає: PutDomainConfigResponse

Приклад

putDomainConfig Приклад

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // опційне поле опущено, наприклад, maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

createEmailTemplate

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
createEmailTemplateBody	CreateEmailTemplateBody	Так

Відповідь

Повертає: CreateEmailTemplateResponse1

Приклад

Приклад createEmailTemplate

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // опціональні поля, такі як textContent, isActive, опущені для демонстрації необов’язкових параметрів
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

deleteEmailTemplate

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: DeleteEmailTemplateResponse

Приклад

Приклад deleteEmailTemplate

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // Приклад доступу до необов'язкової властивості з відповіді
  const statusCode: number | undefined = response.status?.code;
}();

deleteEmailTemplateRenderError

Parameters

Назва	Тип	Обов'язковий
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

Response

Повертає: DeleteEmailTemplateRenderErrorResponse

Example

Приклад deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetEmailTemplateResponse1

Приклад

getEmailTemplate Приклад

Copy

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

getEmailTemplateDefinitions

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так

Відповідь

Повертає: GetEmailTemplateDefinitionsResponse1

Приклад

getEmailTemplateDefinitions Приклад

Copy

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

getEmailTemplateRenderErrors

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	Yes
skip	number	No

Відповідь

Повертає: GetEmailTemplateRenderErrorsResponse1

Приклад

getEmailTemplateRenderErrors Приклад

Copy

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

getEmailTemplates

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Yes
skip	number	No

Відповідь

Повертає: GetEmailTemplatesResponse1

Приклад

Приклад getEmailTemplates

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Виклик без необов'язкового 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Виклик з необов'язковим параметром 'skip'
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

renderEmailTemplate

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	Yes
locale	string	No

Відповідь

Повертає: RenderEmailTemplateResponse1

Приклад

renderEmailTemplate Приклад

Copy

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

updateEmailTemplate

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
updateEmailTemplateBody	UpdateEmailTemplateBody	Так

Відповідь

Повертає: UpdateEmailTemplateResponse

Приклад

Приклад updateEmailTemplate

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "Comment reply notification",
    htmlContent: "<p>Someone replied to your comment.</p>",
    plainTextContent: "Someone replied to your comment.",
    // приклад необов’язкового поля
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

getEventLog

запит tenantId urlId userIdWS

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
urlId	string	Так
userIdWS	string	Так
startTime	number	Так
endTime	number	Ні

Відповідь

Повертає: GetEventLogResponse1

Приклад

Приклад getEventLog

Copy

(async () => {
    const tenantId: string = "tenant_9876";
    const urlId: string = "page_54321";
    const userIdWS: string = "ws_user_1122";
    const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // один тиждень тому
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

getGlobalEventLog

req tenantId urlId userIdWS

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
urlId	string	Так
userIdWS	string	Так
startTime	number	Так
endTime	number	Ні

Відповідь

Повертає: GetGlobalEventLogResponse

Приклад

Приклад getGlobalEventLog

Copy

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

createFeedPost

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
createFeedPostParams	CreateFeedPostParams	Так
broadcastId	string	Ні
isLive	boolean	Ні
doSpamCheck	boolean	Ні
skipDupCheck	boolean	Ні

Відповідь

Повертає: CreateFeedPostResponse1

Приклад

createFeedPost Приклад

Copy

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

createFeedPostPublic

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Відповідь

Повертає: CreateFeedPostPublicResponse

Приклад

createFeedPostPublic Приклад

Copy

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

deleteFeedPostPublic

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

Відповідь

Повертає: DeleteFeedPostPublicResponse

Приклад

Приклад deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No

Відповідь

Повертає: GetFeedPostsResponse1

Приклад

getFeedPosts Приклад

Copy

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

getFeedPostsPublic

req tenantId afterId

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
afterId	string	Ні
limit	number	Ні
tags	Array	Ні
sso	string	Ні
isCrawler	boolean	Ні
includeUserInfo	boolean	Ні

Відповідь

Повертає: GetFeedPostsPublicResponse

Приклад

getFeedPostsPublic Приклад

Copy

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

getFeedPostsStats

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
postIds	Array	Так
sso	string	Ні

Відповідь

Повертає: GetFeedPostsStatsResponse

Приклад

getFeedPostsStats Приклад

Copy

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

getUserReactsPublic

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
postIds	Array	Ні
sso	string	Ні

Відповідь

Повертає: GetUserReactsPublicResponse

Приклад

getUserReactsPublic Приклад

Copy

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

reactFeedPostPublic

Параметри

Назва	Тип	Обовʼязково
tenantId	string	Так
postId	string	Так
reactBodyParams	ReactBodyParams	Так
isUndo	boolean	Ні
broadcastId	string	Ні
sso	string	Ні

Відповідь

Повертає: ReactFeedPostPublicResponse

Приклад

reactFeedPostPublic Приклад

Copy

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

updateFeedPost

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
id	string	Yes
feedPost	FeedPost	Yes

Відповідь

Повертає: UpdateFeedPostResponse

Приклад

Приклад updateFeedPost

Copy

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

updateFeedPostPublic

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
postId	string	Yes
updateFeedPostParams	UpdateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Відповідь

Повертає: UpdateFeedPostPublicResponse

Приклад

updateFeedPostPublic Приклад

Copy

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

flagCommentPublic

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
isFlagged	boolean	Yes
sso	string	No

Відповідь

Повертає: FlagCommentPublicResponse

Приклад

Приклад flagCommentPublic

Copy

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

getGifLarge

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
largeInternalURLSanitized	string	Так

Відповідь

Повертає: GetGifLargeResponse

Приклад

Приклад getGifLarge

Copy

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

getGifsSearch

Параметри

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

Відповідь

Повертає: GetGifsSearchResponse

Приклад

Приклад getGifsSearch

Copy

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

getGifsTrending

Параметри

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

Відповідь

Повертає: GetGifsTrendingResponse

Приклад

Приклад getGifsTrending

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const locale: string = "en-US";
  const rating: string = "PG-13";
  const page: number = 1;
  const trendingAll: GetGifsTrendingResponse = await getGifsTrending(tenantId, locale, rating, page);
  console.log(trendingAll);
  // Використовуючи лише необхідний параметр
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

addHashTag

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Ні
createHashTagBody	CreateHashTagBody	Ні

Відповідь

Повертає: AddHashTagResponse

Приклад

addHashTag Приклад

Copy

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

addHashTagsBulk

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Відповідь

Повертає: AddHashTagsBulkResponse

Приклад

addHashTagsBulk Приклад

Copy

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

deleteHashTag

Параметри

Назва	Тип	Обов’язковий
tag	string	Yes
tenantId	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Відповідь

Повертає: DeleteHashTagResponse

Приклад

deleteHashTag Приклад

Copy

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

getHashTags

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
page	number	Ні

Відповідь

Повертає: GetHashTagsResponse1

Приклад

getHashTags Приклад

Copy

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

patchHashTag

Параметри

Назва	Тип	Обов'язково
tag	string	Так
tenantId	string	Ні
updateHashTagBody	UpdateHashTagBody	Ні

Відповідь

Повертає: PatchHashTagResponse

Приклад

patchHashTag Приклад

Copy

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

deleteModerationVote

Параметри

Назва	Тип	Обов’язково
commentId	string	Так
voteId	string	Так
broadcastId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: DeleteModerationVoteResponse

Приклад

deleteModerationVote Приклад

Copy

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

getApiComments

Parameters

Name	Type	Required
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Response

Повертає: GetApiCommentsResponse

Example

Приклад getApiComments

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // сторінка
    25,                    // кількість
    "feedback",           // текстовий пошук
    "192.168.1.100",      // за IP з коментаря
    "approved",           // фільтри
    "hasReplies",         // фільтри пошуку
    "dateDesc",           // сортування
    false,                // демо
    "tenant-abc123",      // ідентифікатор орендаря
    "sso-token-xyz"       // sso
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

getApiExportStatus

Параметри

Назва	Тип	Обов’язково
batchJobId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetApiExportStatusResponse

Приклад

Приклад getApiExportStatus

Copy

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

getApiIds

Параметри

Назва	Тип	Обов’язково
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetApiIdsResponse

Приклад

Приклад getApiIds

Copy

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

getBanUsersFromComment

Параметри

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

Відповідь

Повертає: GetBanUsersFromCommentResponse

Приклад

getBanUsersFromComment Приклад

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // Виклик з усіма параметрами
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // Виклик лише з необхідним параметром
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

getCommentBanStatus

Параметри

Назва	Тип	Обов’язково
commentId	string	Yes
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetCommentBanStatusResponse1

Приклад

Приклад getCommentBanStatus

Copy

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

getCommentChildren

Параметри

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

Відповідь

Повертає: GetCommentChildrenResponse

Приклад

Приклад getCommentChildren

Copy

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

getCount

Параметри

Назва	Тип	Обов'язково
textSearch	string	Ні
byIPFromComment	string	Ні
filter	string	Ні
searchFilters	string	Ні
demo	boolean	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetCountResponse

Приклад

Приклад getCount

Copy

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

getCounts

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetCountsResponse

Приклад

Приклад getCounts

Copy

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

getLogs

Параметри

Назва	Тип	Обов’язковий
commentId	string	Так
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetLogsResponse

Приклад

Приклад getLogs

Copy

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

getManualBadges

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetManualBadgesResponse

Приклад

Приклад getManualBadges

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // Виклик з обома необов'язковими параметрами
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // Виклик лише з tenantId
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

getManualBadgesForUser

Параметри

Назва	Тип	Обов’язковий
badgesUserId	string	No
commentId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetManualBadgesForUserResponse

Приклад

Приклад getManualBadgesForUser

Copy

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

getModerationComment

Параметри

Назва	Тип	Обов'язковий
commentId	string	Yes
includeEmail	boolean	No
includeIP	boolean	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetModerationCommentResponse

Приклад

Приклад getModerationComment

Copy

async function fetchCommentDetails() {
  // Повний набір параметрів
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // Мінімальний виклик, що використовує лише обов'язковий аргумент
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // Використовуйте результати за потребою...
}

getModerationCommentText

Параметри

Назва	Тип	Обов'язково
commentId	string	Yes
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetModerationCommentTextResponse

Приклад

Приклад getModerationCommentText

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // Виклик з лише обов'язковим параметром
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // Виклик з необов'язковими параметрами
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

getPreBanSummary

Параметри

Назва	Тип	Обов'язково
commentId	string	Так
includeByUserIdAndEmail	boolean	ні
includeByIP	boolean	ні
includeByEmailDomain	boolean	ні
tenantId	string	ні
sso	string	ні

Відповідь

Повертає: GetPreBanSummaryResponse

Приклад

Приклад getPreBanSummary

Copy

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

getSearchCommentsSummary

Параметри

Назва	Тип	Обовʼязково
value	string	Ні
filters	string	Ні
searchFilters	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetSearchCommentsSummaryResponse

Приклад

getSearchCommentsSummary Приклад

Copy

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

getSearchPages

Параметри

Назва	Тип	Обовʼязково
value	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetSearchPagesResponse

Приклад

getSearchPages Приклад

Copy

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

getSearchSites

Параметри

Назва	Тип	Обов’язковий
value	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetSearchSitesResponse

Приклад

Приклад getSearchSites

Copy

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

getSearchSuggest

Параметри

Назва	Тип	Обов'язковий
textSearch	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetSearchSuggestResponse

Приклад

getSearchSuggest Приклад

Copy

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

getSearchUsers

Параметри

Назва	Тип	Обов'язковий
value	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Returns: GetSearchUsersResponse

Приклад

getSearchUsers Приклад

Copy

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

getTrustFactor

Параметри

Ім'я	Тип	Обов'язково
userId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: GetTrustFactorResponse

Приклад

Приклад getTrustFactor

Copy

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

getUserBanPreference

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetUserBanPreferenceResponse

Приклад

Приклад getUserBanPreference

Copy

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

getUserInternalProfile

Параметри

Назва	Тип	Обов’язковий
commentId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: GetUserInternalProfileResponse1

Приклад

getUserInternalProfile Приклад

Copy

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

postAdjustCommentVotes

Параметри

Name	Type	Required
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostAdjustCommentVotesResponse

Приклад

postAdjustCommentVotes Приклад

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // додаткові поля, які потрібні згідно AdjustCommentVotesParams
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

postApiExport

Параметри

Назва	Тип	Обов'язково
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostApiExportResponse

Приклад

postApiExport Приклад

Copy

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

postBanUserFromComment

Parameters

Назва	Тип	Обов'язково
commentId	string	Так
banEmail	boolean	Ні
banEmailDomain	boolean	Ні
banIP	boolean	Ні
deleteAllUsersComments	boolean	Ні
bannedUntil	string	Ні
isShadowBan	boolean	Ні
updateId	string	Ні
banReason	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PostBanUserFromCommentResponse

Приклад

postBanUserFromComment Приклад

Copy

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

postBanUserUndo

Параметри

Ім'я	Тип	Обов'язково
banUserUndoParams	BanUserUndoParams	Так
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PostBanUserUndoResponse

Приклад

Приклад postBanUserUndo

Copy

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

postBulkPreBanSummary

Параметри

Назва	Тип	Обов'язковий
bulkPreBanParams	BulkPreBanParams	Так
includeByUserIdAndEmail	boolean	Ні
includeByIP	boolean	Ні
includeByEmailDomain	boolean	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PostBulkPreBanSummaryResponse

Приклад

postBulkPreBanSummary Приклад

Copy

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

postCommentsByIds

Параметри

Name	Type	Required
commentsByIdsParams	CommentsByIdsParams	Yes
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostCommentsByIdsResponse

Приклад

postCommentsByIds Приклад

Copy

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

postFlagComment

Параметри

Назва	Тип	Обовʼязково
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostFlagCommentResponse

Приклад

postFlagComment Приклад

Copy

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

postRemoveComment

Параметри

Назва	Тип	Обов'язково
commentId	string	Так
broadcastId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PostRemoveCommentResponse

Приклад

postRemoveComment Приклад

Copy

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

postRestoreDeletedComment

Параметри

Назва	Тип	Обов'язково
commentId	string	Так
broadcastId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PostRestoreDeletedCommentResponse

Приклад

postRestoreDeletedComment Приклад

Copy

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

postSetCommentApprovalStatus

Параметри

Назва	Тип	Обов’язково
commentId	string	Yes
approved	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostSetCommentApprovalStatusResponse

Приклад

Приклад postSetCommentApprovalStatus

Copy

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

postSetCommentReviewStatus

Параметри

Назва	Тип	Обов'язковий
commentId	string	Yes
reviewed	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostSetCommentReviewStatusResponse

Приклад

postSetCommentReviewStatus Приклад

Copy

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

postSetCommentSpamStatus

Параметри

Name	Type	Required
commentId	string	Так
spam	boolean	Ні
permNotSpam	boolean	Ні
broadcastId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PostSetCommentSpamStatusResponse

Приклад

postSetCommentSpamStatus Приклад

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // Тільки обов'язковий параметр
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // Всі необов'язкові параметри вказані
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

postSetCommentText

Параметри

Назва	Тип	Обов'язково
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: PostSetCommentTextResponse

Приклад

postSetCommentText Приклад

Copy

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

postUnFlagComment

Parameters

Назва	Тип	Обов’язково
commentId	string	Так
broadcastId	string	Ні
tenantId	string	Ні
sso	string	Ні

Response

Повертає: PostUnFlagCommentResponse

Example

postUnFlagComment Приклад

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId (необов’язковий)
    "tenant_abc",         // tenantId (необов’язковий)
    "sso_user_token_789"  // sso (необов’язковий)
  );
};

postVote

Параметри

Ім'я	Тип	Обов'язково
commentId	string	Yes
direction	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Відповідь

Returns: PostVoteResponse

Приклад

приклад postVote

Copy

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

putAwardBadge

Параметри

Ім'я	Тип	Обов'язковий
badgeId	string	Так
userId	string	Ні
commentId	string	Ні
broadcastId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PutAwardBadgeResponse

Приклад

Приклад putAwardBadge

Copy

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

putCloseThread

Параметри

Назва	Тип	Обов’язковий
urlId	string	Так
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PutCloseThreadResponse

Приклад

putCloseThread Приклад

Copy

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

putRemoveBadge

Parameters

Name	Type	Required
badgeId	string	Yes
userId	string	No
commentId	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Response

Returns: PutRemoveBadgeResponse

Example

putRemoveBadge Приклад

Copy

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

putReopenThread

Параметри

Name	Type	Required
urlId	string	Так
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: PutReopenThreadResponse

Приклад

putReopenThread Приклад

Copy

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

setTrustFactor

Параметри

Назва	Тип	Обов'язковий
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

Відповідь

Повертає: SetTrustFactorResponse

Приклад

setTrustFactor Приклад

Copy

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

createModerator

Parameters

Name	Type	Required	Description
tenantId	string	Так
createModeratorBody	CreateModeratorBody	Так

Response

Повертає: CreateModeratorResponse1

Example

Приклад createModerator

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // необов’язкові поля, такі як description, опущені
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

deleteModerator

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
sendEmail	string	Ні

Відповідь

Повертає: DeleteModeratorResponse

Приклад

deleteModerator Приклад

Copy

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

getModerator

Parameters

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetModeratorResponse1

Приклад

Приклад getModerator

Copy

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

getModerators

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Yes
skip	number	No

Відповідь

Повертає: GetModeratorsResponse1

Приклад

Приклад getModerators

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // необов'язковий зсув пагінації
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // Приклад без пагінації:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

sendInvite

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Так
fromName	string	Так

Відповідь

Повертає: SendInviteResponse

Приклад

sendInvite Приклад

Copy

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

updateModerator

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateModeratorBody	UpdateModeratorBody	Так

Відповідь

Повертає: UpdateModeratorResponse

Приклад

Приклад updateModerator

Copy

async function demoUpdateModerator(): Promise<void> {
    const tenantId: string = "tenant_42abc";
    const moderatorId: string = "moderator_8f9e";
    const updateBody: UpdateModeratorBody = {
        isActive: true,
        role: "admin",
        // необов'язкове поле
        notes: "Promoted to senior moderator"
    };
    const result: UpdateModeratorResponse = await updateModerator(tenantId, moderatorId, updateBody);
    console.log(result);
}
demoUpdateModerator();

deleteNotificationCount

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: DeleteNotificationCountResponse

Приклад

deleteNotificationCount Приклад

Copy

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

getCachedNotificationCount

Параметри

Name	Type	Required	Description
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetCachedNotificationCountResponse1

Приклад

getCachedNotificationCount Приклад

Copy

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

getNotificationCount

Параметри

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

Відповідь

Повертає: GetNotificationCountResponse1

Приклад

getNotificationCount Приклад

Copy

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

getNotifications

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
userId	string	Ні
urlId	string	Ні
fromCommentId	string	Ні
viewed	boolean	Ні
type	string	Ні
skip	number	Ні

Відповідь

Повертає: GetNotificationsResponse1

Приклад

Приклад getNotifications

Copy

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

updateNotification

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
id	string	Так
updateNotificationBody	UpdateNotificationBody	Так
userId	string	Ні

Відповідь

Повертає: UpdateNotificationResponse

Приклад

Приклад updateNotification

Copy

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

createV1PageReact

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlId	string	Так
title	string	Ні

Відповідь

Повертає: CreateV1PageReactResponse

Приклад

createV1PageReact Приклад

Copy

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

createV2PageReact

Параметри

Name	Type	Required
tenantId	string	Так
urlId	string	Так
id	string	Так
title	string	Ні

Відповідь

Повертає: CreateV2PageReactResponse

Приклад

createV2PageReact Приклад

Copy

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

deleteV1PageReact

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
urlId	string	Так

Відповідь

Повертає: DeleteV1PageReactResponse

Приклад

deleteV1PageReact Приклад

Copy

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

deleteV2PageReact

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Відповідь

Повертає: DeleteV2PageReactResponse

Приклад

deleteV2PageReact Приклад

Copy

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

getV1PageLikes

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Yes
urlId	string	Yes

Відповідь

Повертає: GetV1PageLikesResponse

Приклад

getV1PageLikes Приклад

Copy

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

getV2PageReacts

Параметри

Name	Type	Required	Description
tenantId	string	Так
urlId	string	Так

Відповідь

Повертає: GetV2PageReactsResponse

Приклад

getV2PageReacts Приклад

Copy

async function demoGetPageReacts(): Promise<void> {
    const tenantId: string = "acme-corp-tenant";
    const urlId: string = "article-2024-06-01";
    const reacts: GetV2PageReactsResponse = await getV2PageReacts(tenantId, urlId);
    // приклад доступу до необов’язкової властивості
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

getV2PageReactUsers

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Відповідь

Повертає: GetV2PageReactUsersResponse1

Приклад

getV2PageReactUsers Приклад

Copy

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

addPage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

Response

Повертає: AddPageAPIResponse

Приклад

addPage Приклад

Copy

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

deletePage

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: DeletePageAPIResponse

Приклад

deletePage Приклад

Copy

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

getOfflineUsers

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Відповідь

Повертає: GetOfflineUsersResponse

Приклад

Приклад getOfflineUsers

Copy

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

getOnlineUsers

Currently‑online viewers of a page: people whose websocket session is subscribed to the page right now.
Повертає anonCount + totalCount (room‑wide subscribers, including anon viewers we don't enumerate).

Parameters

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

Response

Returns: GetOnlineUsersResponse

Example

Приклад getOnlineUsers

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // З необов’язковими параметрами пагінації
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // Без необов’язкових параметрів пагінації
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

getPageByURLId

Параметри

Ім'я	Тип	Обов'язково	Опис
tenantId	string	Так
urlId	string	Так

Відповідь

Повертає: GetPageByURLIdAPIResponse

Приклад

Приклад getPageByURLId

Copy

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

getPages

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так

Відповідь

Повертає: GetPagesAPIResponse

Приклад

Приклад getPages

Copy

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

getPagesPublic

Список сторінок для орендаря. Використовується клієнтом FChat для настільних комп’ютерів для заповнення списку кімнат. Потрібно, щоб enableFChat було встановлено в true у розвʼязаній кастомній конфігурації для кожної сторінки. Сторінки, які вимагають SSO, фільтруються згідно з груповим доступом запитуючого користувача.

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

Відповідь

Повертає: GetPagesPublicResponse

Приклад

getPagesPublic Приклад

Copy

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

getUsersInfo

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

Назва	Тип	Обов’язково	Опис
tenantId	string	Yes
ids	string	Yes

Response

Returns: GetUsersInfoResponse

Example

Приклад getUsersInfo

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Optional fields in the response may be undefined
// Додаткові поля у відповіді можуть бути undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

patchPage

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
id	string	Yes
updateAPIPageData	UpdateAPIPageData	Yes

Відповідь

Повертає: PatchPageAPIResponse

Приклад

patchPage Приклад

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string можна пропустити
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

deletePendingWebhookEvent

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: DeletePendingWebhookEventResponse

Приклад

deletePendingWebhookEvent Приклад

Copy

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

getPendingWebhookEventCount

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Відповідь

Повертає: GetPendingWebhookEventCountResponse1

Приклад

Приклад getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Ні
externalId	string	Ні
eventType	string	Ні
type	string	Ні
domain	string	Ні
attemptCountGT	number	Ні
skip	number	Ні

Відповідь

Повертає: GetPendingWebhookEventsResponse1

Приклад

getPendingWebhookEvents Приклад

Copy

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

createQuestionConfig

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

Відповідь

Повертає: CreateQuestionConfigResponse1

Приклад

createQuestionConfig Приклад

Copy

const tenantId: string = "tenant_12345";
const customOption: QuestionConfigCustomOptionsInner = {
  label: "Option A",
  value: "a",
};
const createQuestionConfigBody: CreateQuestionConfigBody = {
  questionText: "What is your favorite color?",
  isActive: true,
  // необов’язкові поля можна пропустити
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

deleteQuestionConfig

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: DeleteQuestionConfigResponse

Приклад

deleteQuestionConfig Приклад

Copy

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

getQuestionConfig

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetQuestionConfigResponse1

Приклад

Приклад getQuestionConfig

Copy

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

getQuestionConfigs

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetQuestionConfigsResponse1

Приклад

Приклад getQuestionConfigs

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // Виклик без необов’язкового параметра 'skip'
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // Виклик з необов’язковим параметром 'skip'
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

updateQuestionConfig

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateQuestionConfigBody	UpdateQuestionConfigBody	Так

Відповідь

Повертає: UpdateQuestionConfigResponse

Приклад

updateQuestionConfig Приклад

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // продемонстровані необов'язкові поля
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

createQuestionResult

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createQuestionResultBody	CreateQuestionResultBody	Так

Відповідь

Повертає: CreateQuestionResultResponse1

Приклад

createQuestionResult Приклад

Copy

const tenantId: string = "acme-corp-tenant";
const metaItem: MetaItem = {
  key: "campaign",
  value: "spring-launch"
};
const questionResultBody: CreateQuestionResultBody = {
  questionId: "question-42",
  answer: "Positive",
  metadata: [metaItem]
  // optional fields such as notes are omitted
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

deleteQuestionResult

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Returns: DeleteQuestionResultResponse

Приклад

deleteQuestionResult Приклад

Copy

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

getQuestionResult

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetQuestionResultResponse1

Приклад

getQuestionResult Приклад

Copy

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

getQuestionResults

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlId	string	Ні
userId	string	Ні
startDate	string	Ні
questionId	string	Ні
questionIds	string	Ні
skip	number	Ні

Відповідь

Повертає: GetQuestionResultsResponse1

Приклад

getQuestionResults Приклад

Copy

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

updateQuestionResult

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

Відповідь

Повертає: UpdateQuestionResultResponse

Приклад

updateQuestionResult Приклад

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // обов'язкові поля
        answer: "No",
        // необов'язкові поля
        comment: "User clarified their response",
        // anotherOptionalField?: value,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

aggregateQuestionResults

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Відповідь

Повертає: AggregateQuestionResultsResponse1

Приклад

aggregateQuestionResults Приклад

Copy

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

bulkAggregateQuestionResults

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Yes
forceRecalculate	boolean	No

Відповідь

Повертає: BulkAggregateQuestionResultsResponse1

Приклад

bulkAggregateQuestionResults Приклад

Copy

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

combineCommentsWithQuestionResults

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

Відповідь

Повертає: CombineCommentsWithQuestionResultsResponse

Приклад

Приклад combineCommentsWithQuestionResults

Copy

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

addSSOUser

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	Yes

Відповідь

Повертає: AddSSOUserAPIResponse

Приклад

Приклад addSSOUser

Copy

const tenantId: string = "tenant_12345";
const newUser: CreateAPISSOUserData = {
  userId: "sso_user_987",
  name: "Jane Doe",
  email: "jane.doe@example.com",
  // необов’язкове поле
  avatarUrl: "https://example.com/avatars/jane.jpg",
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, newUser);

deleteSSOUser

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

Відповідь

Повертає: DeleteSSOUserAPIResponse

Приклад

Приклад deleteSSOUser

Copy

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

getSSOUserByEmail

Параметри

Name	Type	Required	Description
tenantId	string	Yes
email	string	Yes

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

Приклад

Приклад getSSOUserByEmail

Copy

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

getSSOUserById

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: GetSSOUserByIdAPIResponse

Приклад

getSSOUserById Приклад

Copy

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

getSSOUsers

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetSSOUsersResponse

Приклад

Приклад getSSOUsers

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // Виклик без необов’язкового `skip`
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // Виклик з необов’язковим `skip`
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

patchSSOUser

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

Відповідь

Повертає: PatchSSOUserAPIResponse

Приклад

patchSSOUser Приклад

Copy

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

putSSOUser

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
updateAPISSOUserData	UpdateAPISSOUserData	Так
updateComments	boolean	Ні

Відповідь

Повертає: PutSSOUserAPIResponse

Приклад

putSSOUser Приклад

Copy

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

createSubscription

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Так

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

createSubscription Приклад

Copy

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

deleteSubscription

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
id	string	Так
userId	string	Ні

Відповідь

Повертає: DeleteSubscriptionAPIResponse

Приклад

Приклад deleteSubscription

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // З необов'язковим userId
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // Без необов'язкового userId
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

getSubscriptions

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Yes
userId	string	No

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад getSubscriptions

Copy

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

updateSubscription

Параметри

Назва	Тип	Обовʼязково
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

Відповідь

Повертає: UpdateSubscriptionAPIResponse

Приклад

updateSubscription Приклад

Copy

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

getTenantDailyUsages

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
yearNumber	number	Ні
monthNumber	number	Ні
dayNumber	number	Ні
skip	number	Ні

Відповідь

Повертає: GetTenantDailyUsagesResponse1

Приклад

getTenantDailyUsages Приклад

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // Травень
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // Використовуючи лише обов'язковий та один необов'язковий параметр
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

createTenantPackage

Parameters

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createTenantPackageBody	CreateTenantPackageBody	Так

Response

Повертає: CreateTenantPackageResponse1

Приклад

createTenantPackage Приклад

Copy

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

deleteTenantPackage

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: DeleteTenantPackageResponse

Приклад

Приклад deleteTenantPackage

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // використовуйте результат за потребою
}
removeTenantPackage();

getTenantPackage

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetTenantPackageResponse1

Приклад

getTenantPackage Приклад

Copy

async function fetchTenantPackage(): Promise<void> {
    const tenantId: string = "acme-tenant-2024";
    const packageId: string = "premium-package-01";
    const response: GetTenantPackageResponse1 = await getTenantPackage(tenantId, packageId);
    // Додаткові поля у відповіді
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

getTenantPackages

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
skip	number	No

Відповідь

Повертає: GetTenantPackagesResponse1

Приклад

getTenantPackages Приклад

Copy

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

replaceTenantPackage

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Так
replaceTenantPackageBody	ReplaceTenantPackageBody	Так

Відповідь

Повертає: ReplaceTenantPackageResponse

Приклад

replaceTenantPackage Приклад

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // поля користувацької конфігурації тут
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // необов'язкова користувацька конфігурація
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

updateTenantPackage

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
id	string	Yes
updateTenantPackageBody	UpdateTenantPackageBody	Yes

Відповідь

Повертає: UpdateTenantPackageResponse

Приклад

updateTenantPackage Приклад

Copy

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

createTenantUser

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
createTenantUserBody	CreateTenantUserBody	Так

Відповідь

Повертає: CreateTenantUserResponse1

Приклад

Приклад createTenantUser

Copy

const tenantId: string = "a1b2c3d4-5678-90ab-cdef-1234567890ab";
const newUser: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "admin",
  // необов’язкові параметри
  phoneNumber: "+15551234567",
  isActive: true,
};
const result: CreateTenantUserResponse1 = await createTenantUser(tenantId, newUser);

deleteTenantUser

Parameters

Name	Type	Required
tenantId	string	Так
id	string	Так
deleteComments	string	Ні
commentDeleteMode	string	Ні

Response

Повертає: DeleteTenantUserResponse

Example

deleteTenantUser Приклад

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // Видалити користувача та всі його коментарі, використовуючи режим жорсткого видалення
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // Видалити користувача без видалення коментарів (поведінка за замовчуванням)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

getTenantUser

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: GetTenantUserResponse1

Приклад

Приклад getTenantUser

Copy

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

getTenantUsers

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
skip	number	No

Відповідь

Повертає: GetTenantUsersResponse1

Приклад

getTenantUsers Приклад

Copy

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

replaceTenantUser

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
replaceTenantUserBody	ReplaceTenantUserBody	Так
updateComments	string	Ні

Відповідь

Повертає: ReplaceTenantUserResponse

Приклад

replaceTenantUser Приклад

Copy

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

sendLoginLink

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
id	string	Так
redirectURL	string	Ні

Відповідь

Повертає: SendLoginLinkResponse

Приклад

sendLoginLink Приклад

Copy

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

updateTenantUser

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
id	string	Yes
updateTenantUserBody	UpdateTenantUserBody	Yes
updateComments	string	No

Відповідь

Повертає: UpdateTenantUserResponse

Приклад

Приклад updateTenantUser

Copy

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

createTenant

Параметри

Name	Type	Required	Description
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

Відповідь

Повертає: CreateTenantResponse1

Приклад

createTenant Приклад

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // обов’язкові поля
    name: 'Acme International',
    // необов’язкові поля можна додати за потреби, напр.:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

deleteTenant

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
id	string	Yes
sure	string	No

Відповідь

Повертає: DeleteTenantResponse

Приклад

Приклад deleteTenant

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // Виклик з необов’язковим параметром 'sure'
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // Виклик без необов’язкового параметра 'sure'
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

getTenant

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: GetTenantResponse1

Приклад

Приклад getTenant

Copy

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

getTenants

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
meta	string	No
skip	number	No

Відповідь

Повертає: GetTenantsResponse1

Приклад

Приклад getTenants

Copy

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

updateTenant

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
updateTenantBody	UpdateTenantBody	Так

Відповідь

Повертає: UpdateTenantResponse

Приклад

updateTenant Приклад

Copy

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

changeTicketState

Параметри

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

Відповідь

Повертає: ChangeTicketStateResponse1

Приклад

changeTicketState Приклад

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // необов’язкове поле в тілі
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

createTicket

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

Відповідь

Повертає: CreateTicketResponse1

Приклад

createTicket Приклад

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string is optional and omitted  // опис?: string є необов'язковим і пропущений
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// Example of using an optional field from the response  // Приклад використання необов'язкового поля з відповіді
// console.log(response.ticket?.id);

getTicket

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
userId	string	Ні

Відповідь

Повертає: GetTicketResponse1

Приклад

Приклад getTicket

Copy

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

getTickets

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
userId	string	Ні
state	number	Ні
skip	number	Ні
limit	number	Ні

Відповідь

Повертає: GetTicketsResponse1

Приклад

Приклад getTickets

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // наприк., закритий
  const skip: number = 10;
  const limit: number = 5;
  const ticketsFull: GetTicketsResponse1 = await getTickets(tenantId, userId, state, skip, limit);
  const ticketsPartial: GetTicketsResponse1 = await getTickets(tenantId);
}
loadTickets();

getTranslations

Параметри

Name	Type	Required
namespace	string	Yes
component	string	Yes
locale	string	No
useFullTranslationIds	boolean	No

Відповідь

Повертає: GetTranslationsResponse1

Приклад

Приклад getTranslations

Copy

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

uploadImage

Завантаження та зміна розміру зображення

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

Відповідь

Повертає: UploadImageResponse

Приклад

Приклад uploadImage

Copy

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

getUserBadgeProgressById

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetUserBadgeProgressByIdResponse

Приклад

getUserBadgeProgressById Приклад

Copy

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

getUserBadgeProgressByUserId

Parameters

Name	Type	Required	Description
tenantId	string	Так
userId	string	Так

Response

Повертає: GetUserBadgeProgressByUserIdResponse

Приклад

Приклад getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
userId	string	Ні
limit	number	Ні
skip	number	Ні

Відповідь

Повертає: GetUserBadgeProgressListResponse

Приклад

getUserBadgeProgressList Приклад

Copy

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

createUserBadge

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Відповідь

Returns: CreateUserBadgeResponse

Приклад

Приклад createUserBadge

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // опис є необов’язковим і пропущений тут
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

deleteUserBadge

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: DeleteUserBadgeResponse

Приклад

Приклад deleteUserBadge

Copy

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

getUserBadge

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetUserBadgeResponse

Приклад

getUserBadge Приклад

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-001";
  const badgeId: string = "badge-5f9d3a2b";
  const badgeResponse: GetUserBadgeResponse = await getUserBadge(tenantId, badgeId);
  // Безпечний доступ до необов’язкових полів
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

getUserBadges

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
userId	string	Ні
badgeId	string	Ні
type	number	Ні
displayedOnComments	boolean	Ні
limit	number	Ні
skip	number	Ні

Відповідь

Повертає: GetUserBadgesResponse

Приклад

Приклад getUserBadges

Copy

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

updateUserBadge

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

Відповідь

Повертає: UpdateUserBadgeResponse

Приклад

updateUserBadge Приклад

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // приклад необов’язкового поля
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

getUserNotificationCount

Параметри

Назва	Тип	Обов’язково	Опис
tenantId	string	Так
sso	string	Ні

Відповідь

Повертає: GetUserNotificationCountResponse1

Приклад

Приклад getUserNotificationCount

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // Виклик з необов’язковим токеном SSO
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // Виклик без токена SSO
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

getUserNotifications

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
urlId	string	Ні
pageSize	number	Ні
afterId	string	Ні
includeContext	boolean	Ні
afterCreatedAt	number	Ні
unreadOnly	boolean	Ні
dmOnly	boolean	Ні
noDm	boolean	Ні
includeTranslations	boolean	Ні
includeTenantNotifications	boolean	Ні
sso	string	Ні

Відповідь

Повертає: GetUserNotificationsResponse

Приклад

Приклад getUserNotifications

Copy

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

resetUserNotificationCount

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Yes
sso	string	No

Відповідь

Повертає: ResetUserNotificationCountResponse

Приклад

resetUserNotificationCount Приклад

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // Виклик з необов'язковим параметром sso
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // Виклик без необов'язкового параметру sso
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

resetUserNotifications

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Відповідь

Повертає: ResetUserNotificationsResponse1

Приклад

resetUserNotifications Приклад

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // приклад UNIX timestamp
  const unreadOnly: boolean = true;
  const dmOnly: boolean = false;
  const noDm: boolean = false;
  const sso: string = "sso-token-xyz";
  const result: ResetUserNotificationsResponse1 = await resetUserNotifications(
    tenantId,
    afterId,
    afterCreatedAt,
    unreadOnly,
    dmOnly,
    noDm,
    sso
  );
  console.log(result);
})();

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Response

Returns: UpdateUserNotificationCommentSubscriptionStatusResponse

Приклад

updateUserNotificationCommentSubscriptionStatus Приклад

Copy

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

updateUserNotificationPageSubscriptionStatus

Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

Відповідь

Повертає: UpdateUserNotificationPageSubscriptionStatusResponse

Приклад

updateUserNotificationPageSubscriptionStatus Приклад

Copy

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

updateUserNotificationStatus

Parameters

Назва	Тип	Обов'язковий
tenantId	string	Yes
notificationId	string	Yes
newStatus	UpdateUserNotificationStatusNewStatusEnum	Yes
sso	string	No

Response

Повертає: UpdateUserNotificationStatusResponse

Приклад

Приклад updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

Відповідь

Повертає: GetUserPresenceStatusesResponse1

Приклад

getUserPresenceStatuses Приклад

Copy

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

searchUsers

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
urlId	string	Так
usernameStartsWith	string	Ні
mentionGroupIds	Array	Ні
sso	string	Ні
searchSection	SearchUsersSearchSectionEnum	Ні

Відповідь

Повертає: SearchUsersResponse1

Приклад

searchUsers Приклад

Copy

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

getUser

Параметри

Ім'я	Тип	Обов'язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetUserResponse1

Приклад

getUser Приклад

Copy

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

createVote

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

Відповідь

Повертає: CreateVoteResponse

Приклад

Приклад createVote

Copy

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

deleteVote

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	Yes
editKey	string	No

Відповідь

Повертає: DeleteVoteResponse

Приклад

Приклад deleteVote

Copy

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

getVotes

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Так
urlId	string	Так

Відповідь

Повертає: GetVotesResponse1

Приклад

Приклад getVotes

Copy

async function fetchVotes(): Promise<void> {
  const tenantId: string = "acme-corp-01";
  const urlId: string = "article-2024-05-15";
  const response: GetVotesResponse1 = await getVotes(tenantId, urlId);
  // Приклад отримання необов’язкового поля у відповіді
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

getVotesForUser

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

Відповідь

Повертає: GetVotesForUserResponse1

Приклад

Приклад getVotesForUser

Copy

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

Потрібна допомога?

Якщо ви стикнулися з будь-якими проблемами або маєте питання щодо JavaScript/TypeScript SDK, будь ласка:

Внесок

Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для отримання інструкцій щодо внесків.

Мова 🇺🇦 Українська

Початок роботи

Довідник API

Документація

Використання

Агрегація

Журнали аудиту

Блокування з коментаря

Перевірка заблокованих коментарів

Коментарі

Коментарі користувача

Налаштування домену

Шаблони електронних листів

Журнал подій

Пости стрічки

Позначення коментаря

GIF

Хештеги

Модерація

Модератори

Кількість сповіщень

Сповіщення

Реакції сторінки

Сторінки

Очікувані події вебхука

Налаштування питань

Результати питань

Агрегація результатів питань

Користувачі SSO

Підписки

Щоденне використання клієнта

Пакети клієнта

Користувачі клієнта

Клієнти

Тикети

Переклади

Завантажити зображення

Прогрес значків користувача

Значки користувача

Сповіщення користувача

Статуси присутності користувача

Пошук користувачів

Користувачі

Голосування

FastComments SDK для JavaScript/TypeScript

Репозиторій

Встановлення

Документація API

Повна документація API: docs/api/README.md

Сумісність браузера та сервера

Використання

Використання в браузері (клієнтська сторона)

Використання на сервері (Node.js)

Імпорт тільки типів

Використання окремих класів API

Середовище браузера

Середовище сервера

Публічні та захищені API

Приклад: Використання Public API (browser-safe)

Приклад: Використання Default API (server-side only)

Приклад: Використання Moderation API

Інтеграція SSO (єдиний вхід)

Просте SSO (тільки на сервері)

Безпечне SSO (серверна сторона, рекомендовано)

Використання SSO з браузера (з токеном, згенерованим на сервері)

SSO зі створенням коментаря

Поширені випадки використання

Отримання коментарів для сторінки

Створення коментаря

Голосування за коментар

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

Живі події (оновлення в реальному часі)

Події на рівні сторінки

Підписка на події користувача

Отримання userIdWS

Ідентифікатори трансляції

Обробка помилок

aggregate

Параметри

Відповідь