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:

// Импорт, безопасный для браузера (без зависимостей Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // необязательно, по умолчанию https://fastcomments.com
});

// Использовать публичные API (API-ключ не нужен - безопасно для браузера)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Использование на сервере (Node.js)

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

// Импорт для сервера (включает SSO и предназначен для работы с NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Храните это в секрете на сервере!
  basePath: 'https://fastcomments.com' // необязательно, по умолчанию https://fastcomments.com
});

// Использовать защищённые API с вашим API-ключом
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Только импорт типов

Если вам нужны только типы TypeScript (без кода выполнения), используйте импорт по умолчанию:

// Только типы (нет зависимостей на этапе выполнения - безопасно везде)
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 - Конечные точки панели модератора (модерация комментариев, баны, бейджи, trust factor, поиск). Аутентифицируются сессией модератора; передайте параметр запроса sso для модераторов с SSO-аутентификацией.
HiddenApi - Внутренние/админские конечные точки для продвинутых сценариев использования.

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

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

Example: Using Moderation API

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

const sdk = createFastCommentsSDK({ /* basePath и т.д. */ });

// Вызовы, аутентифицированные как модератор (куки сессии или передайте `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 доступна только в серверном экспорте, поскольку она требует возможностей crypto в Node.js.

Простой 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-токен с вашего серверного эндпоинта
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'
});

События в реальном времени

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

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

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

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

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

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (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', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Show notification in your UI
        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');
  }
);

// Close when done
userSubscription.close();

Получение userIdWS

The userIdWS parameter is required for live events and can be obtained from API responses:

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

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Идентификаторы трансляций

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

import { v4 as uuidv4 } from 'uuid';

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

Обработка ошибок

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

Агрегация

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

Параметры

Имя	Тип	Обязательно
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
);

Получить журналы аудита

Параметри

Назва	Тип	Обов’язковий
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);
})();

Заблокировать по публичному комментарию

Параметри

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

Відповідь

Returns: 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();

Разблокировать публичный комментарий

Параметры

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

Ответ

Возвращает: 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
);

Проверить заблокированные комментарии

Параметри

Назва	Тип	Обов’язково
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);
})();

Заблокировать пользователя по комментарию

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
blockFromCommentParams	BlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

Ответ

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

Создать публичный комментарий

Параметри

Назва	Тип	Обов’язково
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);
})();

Удалить комментарий

Параметры

Имя	Тип	Обязательно
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);
})();

Удалить публичный комментарий

Параметри

Назва	Тип	Обов'язково
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
  );
})();

Удалить голос за комментарий

Параметри

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

Відповідь

Повертає: 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();

Пометить комментарий

Параметри

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

Відповідь

Повертає: 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);
})();

Получить комментарий

Параметры

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Ответ

Возвращает: 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);
})();

Получить комментарии

Параметры

Name	Type	Required
tenantId	string	Yes
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No
fromDate	number	No
toDate	number	No

Ответ

Возвращает: 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; // одна неделя назад
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

Получить публичные комментарии

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

Получить текст комментария

Параметри

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

Відповідь

Повертає: 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();

Получить имена пользователей, голосовавших за комментарий

Параметры

Имя	Тип	Обязательно
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);
}

Закрыть комментарий

Параметри

Назва	Тип	Обов’язковий
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);
})();

Закрепить комментарий

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Ответ

Возвращает: 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);
})();

Сохранить комментарий

Параметри

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

Відповідь

Повертає: 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();

Массовое сохранение комментариев

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Ответ

Returns: 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 (using default) → заповнити сповіщення (за замовчуванням)
);

Установить текст комментария

Параметри

Назва	Тип	Обов’язковий
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);
})();

Разблокировать пользователя по комментарию

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

Ответ

Возвращает: 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 omitted
  );
  console.log(result);
}
demoUnblock();

Снять пометку с комментария

Параметры

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

Ответ

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

Разблокировать комментарий

Параметри

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

Відповідь

Повертає: 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();

Открепить комментарий

Параметры

Name	Type	Required
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)
})()

Обновить комментарий

Параметри

Назва	Тип	Обов’язково
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
);

Проголосовать за комментарий

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
commentId	string	Да
urlId	string	Да
broadcastId	string	Да
voteBodyParams	VoteBodyParams	Да
sessionId	string	Нет
sso	string	Нет

Ответ

Возвращает: 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
);

Получить комментарии пользователя

Параметры

Имя	Тип	Обязательно
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);
}

Добавить конфигурацию домена

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

Ответ

Returns: 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);
})();

Удалить конфигурацию домена

Параметри

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

Відповідь

Повертає: 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();

Получить конфигурацию домена

Параметры

Name	Type	Required	Description
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();

Получить конфигурации доменов

Параметры

Имя	Тип	Обязательно	Описание
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);
}

Частичное обновление конфигурации домена

Параметры

Имя	Тип	Обязательно
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();

Заменить конфигурацию домена

Параметры

Name	Type	Required
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();

Создать шаблон письма

Параметри

Name	Type	Required	Description
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	Yes

Відповідь

Повертає: 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);

Удалить шаблон письма

Параметри

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

Відповідь

Повертає: 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;
}();

Удалить ошибку рендеринга шаблона письма

Параметри

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

Відповідь

Повертає: DeleteEmailTemplateRenderErrorResponse

Приклад

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

Получить шаблон письма

Параметри

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: 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;
}

Получить определения шаблонов писем

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да

Ответ

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

Пример

getEmailTemplateDefinitions Пример

Copy

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

Получить ошибки рендеринга шаблонов писем

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
skip	number	No

Response

Returns: GetEmailTemplateRenderErrorsResponse1

Example

Приклад 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
);

Получить шаблоны писем

Параметри

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

Відповідь

Повертає: GetEmailTemplatesResponse1

Приклад

getEmailTemplates Приклад

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // Call without optional 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // Call with optional 'skip' parameter
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

Отрендерить шаблон письма

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
renderEmailTemplateBody	RenderEmailTemplateBody	Да
locale	string	Нет

Ответ

Возвращает: 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);
})();

Обновить шаблон письма

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
updateEmailTemplateBody	UpdateEmailTemplateBody	Yes

Ответ

Возвращает: 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);
})();

Получить журнал событий

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

Получить глобальный журнал событий

запрос
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);
})();

Создать пост в ленте

Parameters

Назва	Тип	Обов’язково
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Response

Повертає: CreateFeedPostResponse1

Example

Пример 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();

Создать публичный пост в ленте

Параметри

Назва	Тип	Обов'язково
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
  );
}

Удалить публичный пост в ленте

Параметри

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

Відповідь

Повертає: 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);
})();

Получить посты ленты

запит tenantId afterId

Parameters

Назва	Тип	Обов’язковий
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);
})();

Получить публичные посты ленты

req tenantId afterId

Параметри

Name	Type	Required
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();

Получить статистику постов ленты

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
postIds	Array	Yes
sso	string	No

Ответ

Возвращает: 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();

Получить реакции пользователя (публично)

Параметри

Назва	Тип	Обов'язково
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();

Прокомментировать/поставить реакцию на пост (публично)

Parameters

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

Відповідь

Повертає: 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);
})();

Обновить пост ленты

Параметры

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

Обновить публичный пост ленты

Параметри

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

Відповідь

Повертає: 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
  );
}

Пометить публичный комментарий

Параметры

Name	Type	Required
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();

Получить большое GIF

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
largeInternalURLSanitized	string	Yes

Ответ

Возвращает: 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);
})();

Поиск GIF

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
search	string	Да
locale	string	Нет
rating	string	Нет
page	number	Нет

Ответ

Возвращает: 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();

Трендовые GIF

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

Ответ

Returns: 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);
  // Using only the required parameter
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

Добавить хэштег

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Ответ

Возвращает: 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);

Массово добавить хэштеги

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Нет
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Нет

Ответ

Возвращает: 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);
}();

Удалить хэштег

Параметры

Имя	Тип	Обязательно
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);
})();

Получить хэштеги

Параметри

Назва	Тип	Обов'язково	Опис
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);
})();

Частичное обновление хэштега

Параметри

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

Відповідь

Повертає: 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
);

Удалить голос модерации

Параметры

Имя	Тип	Обязательно
commentId	string	Yes
voteId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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
);

Получить комментарии через API

Параметры

Имя	Тип	Обязательно
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

Ответ

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

Пример

Пример 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);
}

Получить статус экспорта API

Параметри

Назва	Тип	Обов'язково
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);
}

Получить идентификаторы API

Параметри

Назва	Тип	Обов'язково
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,
});

Получить заблокированных пользователей по комментарию

Параметри

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

Відповідь

Повертає: 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();

Получить статус бана комментария

Параметры

Имя	Тип	Обязательно
commentId	string	Да
tenantId	string	Нет
sso	string	Нет

Ответ

Возвращает: 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');
}

Получить дочерние комментарии

Параметры

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

Получить количество

Параметри

Назва	Тип	Обовʼязковий
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();

Получить подсчёты

Параметри

Назва	Тип	Обов’язковий	Опис
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();

Получить логи

Параметри

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

Відповідь

Повертає: 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);
}

Получить ручные значки

Parameters

Name	Type	Required	Description
tenantId	string	No
sso	string	No

Response

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

Example

Пример 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();

Получить ручные значки для пользователя

Параметри

Name	Type	Required
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);
})();

Получить комментарий для модерации

Параметры

Имя	Тип	Обязательно
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");
  // Используйте результаты по мере необходимости...
}

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

Параметри

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

Відповідь

Повертає: 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);
}

Получить сводку перед баном

Параметры

Имя	Тип	Обязательно
commentId	string	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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
);

Получить сводку поиска комментариев

Параметри

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

Відповідь

Повертає: 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();

Получить страницы поиска

Параметри

Назва	Тип	Обов'язковий
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);
})();

Получить сайты поиска

Параметри

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

Відповідь

Повертає: 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)
}

Получить подсказки поиска

Параметри

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

Відповідь

Повертає: 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();

Получить пользователей поиска

Параметры

Имя	Тип	Обязательно
value	string	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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);
}

Получить фактор доверия

Параметры

Имя	Тип	Обязательно
userId	string	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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();

Получить предпочтение бана пользователя

Параметри

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

Відповідь

Повертає: 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();

Получить внутренний профиль пользователя

Параметри

Name	Type	Required
commentId	string	Ні
tenantId	string	Ні
sso	string	Ні

Відповідь

Повертає: 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"
  });
})();

Скорректировать голоса за комментарии

Параметры

Имя	Тип	Обязательно
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
);

Запросить экспорт через API

Параметры

Имя	Тип	Обязательно
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)
})()

Забанить пользователя по комментарию

Параметры

Имя	Тип	Обязательно
commentId	string	Yes
banEmail	boolean	No
banEmailDomain	boolean	No
banIP	boolean	No
deleteAllUsersComments	boolean	No
bannedUntil	string	No
isShadowBan	boolean	No
updateId	string	No
banReason	string	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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();

Отменить бан пользователя

Параметры

Имя	Тип	Обязательно
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();

Массовая сводка перед баном

Параметры

Имя	Тип	Обязательно
bulkPreBanParams	BulkPreBanParams	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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();

Получить комментарии по идентификаторам

Параметри

Назва	Тип	Обов’язковий
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
);

Пометить комментарий (модерация)

Параметры

Имя	Тип	Обязательно
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
);

Удалить комментарий (модерация)

Параметры

Имя	Тип	Обязательно
commentId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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_XYZ12345";
  const result2: PostRemoveCommentResponse = await postRemoveComment(commentId, broadcastId, tenantId, sso);
  console.log(result1, result2);
}

Восстановить удалённый комментарий

Параметри

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

Відповідь

Повертає: 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();

Установить статус одобрения комментария

Параметри

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

Відповідь

Повертає: 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();

Установить статус проверки комментария

Параметры

Имя	Тип	Обязательно
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);
}

Установить статус спама комментария

Параметри

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

Відповідь

Повертає: PostSetCommentSpamStatusResponse

Приклад

postSetCommentSpamStatus Приклад

Copy

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

Установить текст комментария (модерация)

Параметри

Назва	Тип	Обов'язково
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);
})();

Снять пометку с комментария (модерация)

Параметры

Имя	Тип	Обязательно
commentId	string	Да
broadcastId	string	Нет
tenantId	string	Нет
sso	string	Нет

Ответ

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

Пример

postUnFlagComment пример

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId (опционально)
    "tenant_abc",         // tenantId (опционально)
    "sso_user_token_789"  // sso (опционально)
  );
};

Отдать голос

Параметры

Имя	Тип	Обязательно
commentId	string	Yes
direction	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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');

Выдать значок

Параметри

Назва	Тип	Обов’язковий
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)
})()

Закрыть тему

Параметри

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

Відповідь

Returns: 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();

Удалить значок

Параметры

Имя	Тип	Обязательно
badgeId	string	Да
userId	string	Нет
commentId	string	Нет
broadcastId	string	Нет
tenantId	string	Нет
sso	string	Нет

Ответ

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

Пример

Пример 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
);

Переоткрыть тему

Параметры

Имя	Тип	Обязательно
urlId	string	Yes
tenantId	string	No
sso	string	No

Ответ

Возвращает: 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);
}

Установить фактор доверия

Параметри

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

Відповідь

Повертає: 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);
})();

Создать модератора

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
createModeratorBody	CreateModeratorBody	Да

Ответ

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

Пример

Пример 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();

Удалить модератора

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
sendEmail	string	No

Ответ

Возвращает: 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);
}

Получить модератора

Параметри

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

Відповідь

Повертає: 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);
})();

Получить модераторов

Параметри

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

Відповідь

Повертає: 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);
}

Отправить приглашение

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
fromName	string	Yes

Ответ

Возвращает: 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);

Обновить модератора

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Yes
id	string	Yes
updateModeratorBody	UpdateModeratorBody	Yes

Відповідь

Повертає: 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();

Удалить счётчик уведомлений

Параметри

Name	Type	Required	Description
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();

Получить кешированный счётчик уведомлений

Параметри

Назва	Тип	Обов'язково	Опис
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);

Получить количество уведомлений

Параметры

Имя	Тип	Обязательно
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();

Получить уведомления

Параметри

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

Відповідь

Returns: 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();

Обновить уведомление

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

Відповідь

Повертає: 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
);

Создать реакцию на странице v1

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
title	string	No

Відповідь

Повертає: 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);

Создать реакцию на странице v2

Параметри

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

Відповідь

Повертає: 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);
})();

Удалить реакцию на странице v1

Параметри

Назва	Тип	Обов’язково	Опис
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);

Удалить реакцию на странице v2

Параметры

Имя	Тип	Обязательно
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);

Получить лайки страницы v1

Параметри

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

Відповідь

Повертає: 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);
}

Получить реакции страницы v2

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
urlId	string	Yes

Ответ

Возвращает: 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();

Получить пользователей, поставивших реакцию на странице v2

Параметри

Назва	Тип	Обов’язково
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();

Добавить страницу

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
createAPIPageData	CreateAPIPageData	Да

Ответ

Возвращает: 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);

Удалить страницу

Параметры

Name	Type	Required	Description
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();

Получить офлайн-пользователей

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.

Parameters

Имя	Тип	Обязательно
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Response

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

Example

Пример 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);
}

Получить онлайн-пользователей

Поточні онлайн глядачі сторінки: люди, чиї сеанси WebSocket підписані на сторінку саме зараз.
Повертає anonCount + totalCount (підписники по всій кімнаті, включаючи анонімних глядачів, яких ми не перелічуємо).

Параметри

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

Відповідь

Повертає: GetOnlineUsersResponse

Приклад

Приклад 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);
}

Получить страницу по URL/ID

Параметры

Имя	Тип	Обязательно	Описание
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;
})();

Получить страницы

Параметры

Имя	Тип	Обязательно	Описание
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);
})();

Получить страницы публично

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

Список страниц для арендатора. Используется настольным клиентом FChat для заполнения списка комнат.
Требует, чтобы enableFChat был установлен в true в разрешённой пользовательской конфигурации для каждой страницы.
Страницы, требующие SSO, фильтруются по групповому доступу запрашивающего пользователя.

Parameters

Имя	Тип	Обязательно
tenantId	string	Так
cursor	string	Ні
limit	number	Ні
q	string	Ні
sortBy	PagesSortBy	Ні
hasComments	boolean	Ні

Response

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

Example

Пример 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);
}

Получить информацию о пользователях

Массовая информация о пользователях для арендатора. По заданным userIds возвращается отображаемая информация из User / SSOUser.
Используется виджетом комментариев для обогащения пользователей, которые только что появились через событие присутствия.
Без контекста страницы: конфиденциальность применяется одинаково (приватные профили маскируются).

Parameters

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
ids	string	Yes

Response

Возвращает: 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
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

Частичное обновление страницы

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
id	string	Да
updateAPIPageData	UpdateAPIPageData	Да

Ответ

Возвращает: 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);
})();

Удалить ожидающее событие вебхука

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
id	string	Yes

Ответ

Возвращает: 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();

Получить количество ожидающих событий вебхука

Параметры

Имя	Тип	Обязательно
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);
})();

Получить ожидающие события вебхука

Параметри

Назва	Тип	Обов’язково
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();

Создать конфигурацию вопроса

Параметры

Name	Type	Required	Description
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
);

Удалить конфигурацию вопроса

Параметри

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

Відповідь

Повертає: 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();

Получить конфигурацию вопроса

Параметри

Назва	Тип	Обов’язково	Опис
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);

Получить конфигурации вопросов

Параметры

Имя	Тип	Обязательно	Описание
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);
}

Обновить конфигурацию вопроса

Parameters

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

Response

Returns: UpdateQuestionConfigResponse

Example

Пример 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
);

Создать результат вопроса

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

Ответ

Возвращает: 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]
  // опциональные поля, такие как заметки, опущены
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

Удалить результат вопроса

Параметри

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

Відповідь

Повертає: 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();

Получить результат вопроса

Параметры

Имя	Тип	Обязательно	Описание
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);
}

Получить результаты вопросов

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Відповідь

Returns: 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);
})();

Обновить результат вопроса

Параметри

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

Відповідь

Повертає: 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();

Агрегировать результаты вопросов

Параметры

Имя	Тип	Обязательно
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);
})();

Массовая агрегация результатов вопросов

Параметри

Назва	Тип	Обов’язково
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
);

Объединить комментарии с результатами вопросов

Параметри

Name	Type	Required
tenantId	string	Так
questionId	string	Ні
questionIds	Array	Ні
urlId	string	Ні
startDate	Date	Ні
forceRecalculate	boolean	Ні
minValue	number	Ні
maxValue	number	Ні
limit	number	Ні

Відповідь

Повертає: 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
);

Добавить пользователя SSO

Parameters

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	Yes

Response

Возвращает: 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);

Удалить пользователя SSO

Параметри

Назва	Тип	Обов'язковий
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
);

Получить пользователя SSO по email

Параметры

Имя	Тип	Обязательно	Описание
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;
}

Получить пользователя SSO по ID

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetSSOUserByIdAPIResponse

Example

Пример 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;
}

Получить пользователей SSO

Параметри

Ім’я	Тип	Обов’язково	Опис
tenantId	string	Yes
skip	number	No

Відповідь

Повертає: 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();

Частичное обновление пользователя SSO

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
id	string	Да
updateAPISSOUserData	UpdateAPISSOUserData	Да
updateComments	boolean	Нет

Ответ

Возвращает: 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
);

Заменить пользователя SSO

Параметры

Имя	Тип	Обязательно
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);
})();

Создать подписку

Параметри

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

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

Приклад createSubscription

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const subscriptionData: CreateAPIUserSubscriptionData = {
        userId: "user-456",
        planId: "premium-monthly",
        startDate: new Date(),
        trialPeriodDays: 14 // необов'язкове поле
    };
    const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, subscriptionData);
    console.log(result);
})();

Удалить подписку

Параметри

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

Відповідь

Повертає: 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);
})();

Получить подписки

Параметры

Name	Type	Required	Description
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);
})();

Обновить подписку

Параметры

Имя	Тип	Обязательно
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
);

Получить ежедневное использование тенанта

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

Ответ

Возвращает: 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();

Создать пакет тенанта

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
createTenantPackageBody	CreateTenantPackageBody	Да

Ответ

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

Пример

createTenantPackage Пример

Copy

(async () => {
  const tenantId: string = "tenant-9876";
  const body: CreateTenantPackageBody = {
    packageName: "Standard",
    quota: 5000,
    // необязательное поле
    description: "Standard package for medium traffic",
  };
  const result: CreateTenantPackageResponse1 = await createTenantPackage(tenantId, body);
  console.log(result);
})();

Удалить пакет тенанта

Параметри

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

Відповідь

Повертає: 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();

Получить пакет тенанта

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
id	string	Yes

Ответ

Возвращает: 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;
}

Получить пакеты тенанта

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
skip	number	Нет

Ответ

Возвращает: 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);
})();

Заменить пакет тенанта

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
replaceTenantPackageBody	ReplaceTenantPackageBody	Yes

Ответ

Возвращает: 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);
})();

Обновить пакет тенанта

Параметры

Имя	Тип	Обязательно
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
);

Создать пользователя тенанта

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	Yes

Ответ

Возвращает: 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);

Удалить пользователя тенанта

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
deleteComments	string	No
commentDeleteMode	string	No

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

Получить пользователя тенанта

Параметры

Имя	Тип	Обязательно	Описание
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);
}

Получить пользователей тенанта

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
skip	number	Нет

Ответ

Возвращает: 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);
})();

Заменить пользователя тенанта

Parameters

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

Response

Повертає: ReplaceTenantUserResponse

Example

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

Отправить ссылку для входа

Параметри

Ім’я	Тип	Обов’язково
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);
}

Обновить пользователя тенанта

Параметри

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

Відповідь

Повертає: 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);

Создать тенанта

Параметры

Имя	Тип	Обязательно	Описание
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);
}

Удалить тенанта

Parameters

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

Response

Returns: DeleteTenantResponse

Example

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

Получить тенанта

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
id	string	Да

Ответ

Возвращает: 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();

Получить тенантов

Параметры

Имя	Тип	Обязательно
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);
})();

Обновить тенанта

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
updateTenantBody	UpdateTenantBody	Yes

Ответ

Возвращает: 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);

Изменить состояние тикета

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
userId	string	Да
id	string	Да
changeTicketStateBody	ChangeTicketStateBody	Да

Ответ

Возвращает: 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
);

Создать тикет

Параметри

Назва	Тип	Обов’язково
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 є необов’язковим і опущено
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// Приклад використання необов’язкового поля у відповіді
// console.log(response.ticket?.id);

Получить тикет

Параметри

Назва	Тип	Обов’язковий
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);

Получить тикеты

Параметры

Name	Type	Required
tenantId	string	Yes
userId	string	No
state	number	No
skip	number	No
limit	number	No

Ответ

Возвращает: 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();

Получить переводы

Параметры

Имя	Тип	Обязательно
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);
})();

Загрузить изображение

Upload and resize an image

Parameters

Name	Type	Required
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

Response

Returns: UploadImageResponse

Example

Пример 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);

Получить прогресс значка пользователя по ID

Параметри

Назва	Тип	Обов'язковий	Опис
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();

Получить прогресс значка пользователя по ID пользователя

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
userId	string	Да

Ответ

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

Пример

Пример getUserBadgeProgressByUserId

Copy

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

Получить список прогресса значков пользователя

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
userId	string	No
limit	number	No
skip	number	No

Ответ

Возвращает: 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();

Создать значок пользователя

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Ответ

Возвращает: 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);

Удалить значок пользователя

Параметри

Назва	Тип	Обов’язковий	Опис
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();

Получить значок пользователя

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
id	string	Yes

Ответ

Возвращает: 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);
  // Access optional fields safely
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

Получить значки пользователя

Параметри

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

Відповідь

Повертає: 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();

Обновить значок пользователя

Parameters

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

Response

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

Example

Пример 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();

Получить количество уведомлений пользователя

Параметри

Назва	Тип	Обов'язково	Опис
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);
}

Получить уведомления пользователя

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
urlId	string	No
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
includeTenantNotifications	boolean	No
sso	string	No

Ответ

Возвращает: 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);
}

Сбросить количество уведомлений пользователя

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
sso	string	Нет

Ответ

Возвращает: 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);
}

Сбросить уведомления пользователя

Параметры

Name	Type	Required
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Ответ

Returns: ResetUserNotificationsResponse1

Пример

Пример resetUserNotifications

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // пример UNIX‑таймстампа
  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);
})();

Обновить статус подписки пользователя на комментарии

Enable or disable notifications for a specific comment.

Parameters

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

Response

Повертає: 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
  );

Обновить статус подписки пользователя на страницу

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

Parameters

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

Response

Повертає: 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
  );
})();

Обновить статус уведомления пользователя

Параметри

Name	Type	Required
tenantId	string	Так
notificationId	string	Так
newStatus	UpdateUserNotificationStatusNewStatusEnum	Так
sso	string	Ні

Відповідь

Повертає: 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
);

Получить статусы присутствия пользователей

Параметры

Имя	Тип	Обязательный
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

Ответ

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

Поиск пользователей

Параметры

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

Ответ

Returns: 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();

Получить пользователя

Параметри

Назва	Тип	Обов'язковий	Опис
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);
})();

Создать голос

Параметри

Назва	Тип	Обов’язково
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
);

Удалить голос

Параметри

Назва	Тип	Обов’язковий
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);
})();

Получить голоса

Параметри

Назва	Тип	Обов’язково	Опис
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;
}

Получить голоса для пользователя

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
urlId	string	Да
userId	string	Нет
anonUserId	string	Нет

Ответ

Возвращает: 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, пожалуйста:

Contributing

Вклад приветствуется! Пожалуйста, посетите репозиторий на GitHub для получения руководства по внесению вклада.

Язык 🇺🇦 Русский (Украина)

Начало работы

Справочник API

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

Использование

Агрегирование

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

Блокировка по комментарию

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

Комментарии

Комментарии пользователя

Конфигурации домена

Шаблоны писем

Журнал событий

Посты ленты

Пометка комментария

Гифы

Хэштеги

Модерация

Модераторы

Количество уведомлений

Уведомления

Реакции страницы

Страницы

Ожидающие события вебхука

Настройки вопросов

Результаты вопросов

Агрегация результатов вопросов

Пользователи SSO

Подписки

Ежедневное использование тенанта

Пакеты тенанта

Пользователи тенанта

Тенанты

Тикеты

Переводы

Загрузка изображения

Прогресс значков пользователя

Значки пользователя

Уведомления пользователя

Статусы присутствия пользователя

Поиск пользователей

Пользователи

Голоса

FastComments SDK для JavaScript/TypeScript

Репозиторий

Установка

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

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

Совместимость браузера и сервера

Использование

Использование в браузере (клиентская сторона)

Использование на сервере (Node.js)

Только импорт типов

Использование отдельных классов API

Браузерная среда

Серверная среда

Публичные и защищённые API

Example: Using Public API (browser-safe)

Example: Using Default API (server-side only)

Example: Using Moderation API

Интеграция SSO (единого входа)

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

Защищённый SSO (на стороне сервера, рекомендуется)

Использование SSO из браузера (с серверно-сгенерированным токеном)

SSO при создании комментария

Распространённые сценарии использования

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

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

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

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

События в реальном времени

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

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

Получение userIdWS

Идентификаторы трансляций

Обработка ошибок

Агрегация

Параметры

Ответ