FastComments Nim SDK

Це офіційний SDK на Nim для FastComments.

Офіційний Nim SDK для API FastComments

Репозиторій

Вимоги

Nim >= 1.6.0
nimcrypto >= 0.5.4

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

Using Nimble

nimble install fastcomments

Building from Source

nimble build

Library Contents

This library contains the generated API client and the SSO utilities to make working with the API easier.

API Client Library Docs

Public vs Secured APIs

For the API client, there are three API modules, api_default, api_public, and api_moderation. The api_default contains methods that require your API key, and api_public contains api calls that can be made directly from a browser/mobile device/etc without authentication. The api_moderation module contains methods for the moderator dashboard.

The api_moderation module provides an extensive suite of live and fast moderation APIs. Every api_moderation method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.

Швидкий старт

Використання автентифікованих API (DefaultAPI)

Important: Автентифіковані кінцеві точки потребують, щоб ваш API ключ був встановлений у заголовок x-api-key.

import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

# Make authenticated API calls.
# Required parameters (and the request body) are positional; optional
# parameters are passed via the operation's options object.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

Використання публічних API (PublicAPI)

Публічні кінцеві точки не вимагають автентифікації:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Make public API calls.
# tenantId and urlId are required (positional); everything else is optional.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

if response.isSome:
  let resp = response.get()
  if resp.comments.isSome:
    echo "Found ", resp.comments.get().len, " comments"

Використання модераційних API (ModerationAPI)

Модераційні кінцеві точки живлять панель модератора і автентифіковані за допомогою SSO токена для діючого модератора:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# List comments in the moderation dashboard.
# This operation has no required parameters, so everything is optional.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

if response.isSome:
  let resp = response.get()
  echo "Found ", resp.comments.len, " comments"

Поширені проблеми

401 authentication error: Переконайтеся, що ви встановили заголовок x-api-key у вашому HttpClient перед виконанням запитів DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Використовуйте api_default для серверних автентифікованих запитів, api_public для клієнтських/публічних запитів, і api_moderation для запитів панелі модератора.

Виклики API

Усі методи API в цьому SDK повертають кортежі (Option[ResponseType], Response). Перший елемент містить розпарсений відповідь, якщо успішно, а другий елемент — це необроблена HTTP‑відповідь.

Обов’язкові параметри та тіло запиту передаються позиційно. Решта необов’язкових параметрів збираються в один об’єкт Api<Operation>Options, який є останнім аргументом. Операції без необов’язкових параметрів не беруть об’єкт параметрів.

Приклад: отримання коментарів

import httpclient
import options
import fastcomments
import fastcomments/apis/api_default

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

if httpResponse.code == Http200:
  if response.isSome:
    let resp = response.get()
    if resp.comments.isSome:
      echo "Found ", resp.comments.get().len, " comments"

Примітки

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

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

SSO (Єдиний вхід)

Для прикладів SSO дивіться нижче.

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

Простий SSO

import fastcomments/sso

let user = newSimpleSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()

echo "SSO Token: ", token

Безпечний SSO

import fastcomments/sso

let user = newSecureSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  username = "johndoe",
  avatar = "https://example.com/avatar.jpg"
)

let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()

echo "Secure SSO Token: ", token

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

Документація для API-ендоинтів

All URIs are relative to https://fastcomments.com → Усі URI є відносними до https://fastcomments.com

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Скуповує документи шляхом групування їх (якщо вказано groupBy) та застосування декількох операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Користувачі, які раніше коментували сторінку, але зараз НЕ в онлайн. Сортовано за displayName. Використовуйте це після того, як вичерпані дані /users/online, щоб відобразити розділ “Учасники”. Пагінація за курсором по commenterName: сервер проходить частковий індекс {tenantId, urlId, commenterName} від afterName вперед через $gt, без витрат на $skip.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Користувачі, які зараз онлайн і переглядають сторінку: люди, чия WebSocket‑сесія підписана на сторінку в даний момент. Повертає anonCount + totalCount (всі підписники кімнати, включаючи анонімних глядачів, які не перераховуються).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Список сторінок для орендаря. Використовується десктоп‑клієнтом FChat для заповнення списку кімнат. Потрібно, щоб `enableFChat` був встановлений у true у розв’язаній кастомній конфігурації для кожної сторінки. Сторінки, що потребують SSO, фільтруються відповідно до групового доступу запитуючого користувача.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

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

aggregate

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

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Відповідь

Returns: Option[AggregateResponse]

Приклад

aggregate Приклад

Copy

let (aggResp, httpResp) = client.aggregate(tenantId = "my-tenant-123", aggregationRequest = AggregationRequest(), options = AggregateOptions())
if aggResp.isSome:
  let response = aggResp.get()
  echo response
echo httpResp

getAuditLogs

Параметри

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

Відповідь

Повертає: Option[GetAuditLogsResponse]

Приклад

getAuditLogs Приклад

Copy

let (auditOpt, httpResp) = client.getAuditLogs(tenantId = "my-tenant-123", options = GetAuditLogsOptions())
if auditOpt.isSome:
  let audit = auditOpt.get()
  echo audit

logoutPublic

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

logoutPublic Приклад

Copy

let (responseOpt, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", userId = "user-456")
if responseOpt.isSome:
  let emptyResponse = responseOpt.get()

blockFromCommentPublic

Параметри

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

Відповідь

Повертає: Option[BlockSuccess]

Приклад

blockFromCommentPublic Приклад

Copy

let (blockOpt, httpResp) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if blockOpt.isSome:
  let block = blockOpt.get()

unBlockCommentPublic

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Відповідь

Повертає: Option[UnblockSuccess]

Приклад

unBlockCommentPublic Приклад

Copy

let (unblockResult, httpResp) = client.unBlockCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = ""
)
if unblockResult.isSome:
  let result = unblockResult.get()

checkedCommentsForBlocked

Параметри

Name	Type	Required
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

Відповідь

Повертає: Option[CheckBlockedCommentsResponse]

Приклад

Приклад checkedCommentsForBlocked

Copy

let (maybeResponse, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "cmt-1,cmt-2",
  sso = ""
)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  discard response

blockUserFromComment

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

Відповідь

Повертає: Option[BlockSuccess]

Приклад

blockUserFromComment Приклад

Copy

let params = BlockFromCommentParams()
let opts = BlockUserFromCommentOptions()
let (blockResult, httpResp) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  blockFromCommentParams = params,
  options = opts
)
if blockResult.isSome:
  let success = blockResult.get()
  discard success

createCommentPublic

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Відповідь

Повертає: Option[SaveCommentsResponseWithPresence]

Приклад

createCommentPublic Приклад

Copy

let
  tenantId = "my-tenant-123"
  urlId = "news/article-title"
  broadcastId = "broadcast-456"
  commentData = CommentData()
  options = CreateCommentPublicOptions()
let (maybeResp, httpResp) = client.createCommentPublic(
  tenantId = tenantId,
  urlId = urlId,
  broadcastId = broadcastId,
  commentData = commentData,
  options = options)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

deleteComment

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Відповідь

Повертає: Option[DeleteCommentResult]

Приклад

Приклад deleteComment

Copy

let (delResult, httpResponse) = client.deleteComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  options = DeleteCommentOptions()
)
if delResult.isSome:
  let result = delResult.get()
  echo result

deleteCommentPublic

Параметри

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

Відповідь

Повертає: Option[PublicAPIDeleteCommentResponse]

Приклад

Приклад deleteCommentPublic

Copy

let (responseOpt, httpResp) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  options = DeleteCommentPublicOptions())
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

deleteCommentVote

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
commentId	string	Так
voteId	string	Ні
urlId	string	Так
broadcastId	string	Ні
options	DeleteCommentVoteOptions	Ні

Відповідь

Повертає: Option[VoteDeleteResponse]

Приклад

Приклад deleteCommentVote

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  voteId = "vote-789",
  urlId = "news/article-title",
  broadcastId = "broadcast-001",
  options = DeleteCommentVoteOptions()
)
if response.isSome:
  let voteDelete = response.get()

flagComment

Параметри

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

Відповідь

Повертає: Option[FlagCommentResponse]

Приклад

Приклад flagComment

Copy

let options = FlagCommentOptions(reason: "spam content", note: "Automated posting detected", isSpam: true, categories: @["spam"])
let (flagRes, httpRes) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-789", options = options)
if flagRes.isSome:
  let res = flagRes.get()
  discard res

getComment

Параметри

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Відповідь

Повертає: Option[APIGetCommentResponse]

Приклад

Приклад getComment

Copy

let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-789")
if response.isSome:
  let comment = response.get()
  discard comment

getComments

Параметри

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

Відповідь

Повертає: Option[APIGetCommentsResponse]

Приклад

getComments Приклад

Copy

let options = GetCommentsOptions(
  urlId = "news/article-title",
  page = 0,
  pageSize = 20,
  sort = "newest",
  includeDeleted = false,
  includeReplies = true,
  userIds = @[],
  tags = @[]
)
let (response, httpResponse) = client.getComments(tenantId = "my-tenant-123", options = options)
if response.isSome:
  let comments = response.get()
  discard comments

getCommentsPublic

req tenantId urlId

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
options	GetCommentsPublicOptions	No

Відповідь

Повертає: Option[GetCommentsResponseWithPresencePublicComment]

Приклад

getCommentsPublic Приклад

Copy

let (optResp, httpResp) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetCommentsPublicOptions(
    page = 0,
    pageSize = 10,
    includeDeleted = false,
    tags = @[]
  )
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getCommentText

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
options	GetCommentTextOptions	No

Response

Returns: Option[PublicAPIGetCommentTextResponse]

Example

Приклад getCommentText

Copy

let (maybeResponse, httpResponse) = client.getCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = GetCommentTextOptions()
)
if maybeResponse.isSome:
  let response = maybeResponse.get()

getCommentVoteUserNames

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
commentId	string	Так
dir	int	Ні
sso	string = ""	Ні

Відповідь

Повертає: Option[GetCommentVoteUserNamesSuccessResponse]

Приклад

Приклад getCommentVoteUserNames

Copy

let (voteNamesOpt, httpRes) = client.getCommentVoteUserNames(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  dir = 0,
  sso = ""
)
if voteNamesOpt.isSome:
  let voteNames = voteNamesOpt.get()
  echo voteNames

lockComment

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

lockComment Приклад

Copy

let (lockResult, httpRes) = client.lockComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  broadcastId = "",
  sso = "")
if lockResult.isSome:
  let resp = lockResult.get()
  discard resp

pinComment

Параметри

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

Відповідь

Повертає: Option[ChangeCommentPinStatusResponse]

Приклад

pinComment Приклад

Copy

let (pinResult, httpResp) = client.pinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = "",
)
if pinResult.isSome:
  let response = pinResult.get()
  echo response

saveComment

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
createCommentParams	CreateCommentParams	Ні
options	SaveCommentOptions	Ні

Відповідь

Повертає: Option[APISaveCommentResponse]

Приклад

saveComment Приклад

Copy

let commentParams = CreateCommentParams(
  body: "Great read, thanks!",
  name: "Alice Smith",
  email: "alice@example.com",
  parentId: ""
)
let saveOpts = SaveCommentOptions(
  isPreview: false,
  isApproved: true,
  skipSpamCheck: false
)
let (apiResponse, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = commentParams,
  options = saveOpts
)
if apiResponse.isSome:
  let saved = apiResponse.get()
  echo saved

saveCommentsBulk

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
createCommentParams	seq[CreateCommentParams]	Ні
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Ні
id	string	Ні
fromName	string	Ні

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

saveCommentsBulk Приклад

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  options = SaveCommentsBulkOptions(),
  id = "",
  fromName = ""
)
if response.isSome:
  let result = response.get()

setCommentText

Параметри

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

Відповідь

Повертає: Option[PublicAPISetCommentTextResponse]

Приклад

setCommentText Приклад

Copy

let commentUpdate = CommentTextUpdateRequest(text: "Updated comment text")
let opts = SetCommentTextOptions()
let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  broadcastId = "broadcast-789",
  commentTextUpdateRequest = commentUpdate,
  options = opts)
if response.isSome:
  let result = response.get()

unBlockUserFromComment

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

Відповідь

Повертає: Option[UnblockSuccess]

Приклад

unBlockUserFromComment Приклад

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  unBlockFromCommentParams = UnBlockFromCommentParams(userId = "user-789", commentId = "cmt-321"),
  options = UnBlockUserFromCommentOptions(),
)
if response.isSome:
  let unblockSuccess = response.get()

unFlagComment

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Так
id	string	Ні
options	UnFlagCommentOptions	Ні

Відповідь

Повертає: Option[FlagCommentResponse]

Приклад

unFlagComment Приклад

Copy

let (flagRespOpt, httpResp) = client.unFlagComment(tenantId = "my-tenant-123", id = "comment-456", options = UnFlagCommentOptions())
if flagRespOpt.isSome:
  let flagResp = flagRespOpt.get()

unLockComment

Параметри

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

Відповідь

Returns: Option[APIEmptyResponse]

Приклад

unLockComment Приклад

Copy

let (maybeEmpty, httpResp) = client.unLockComment(tenantId = "my-tenant-123", commentId = "comment-456", broadcastId = "", sso = "")
if maybeEmpty.isSome:
  let emptyResp = maybeEmpty.get()
  echo "Comment unlocked"
else:
  echo "Failed to unlock comment"

unPinComment

Параметри

Name	Type	Required
tenantId	string	Так
commentId	string	Так
broadcastId	string	Ні
sso	string = ""	Ні

Відповідь

Повертає: Option[ChangeCommentPinStatusResponse]

Приклад

unPinComment Приклад

Copy

let (responseOpt, httpResponse) = client.unPinComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "broadcast-001",
  sso = ""
)
if responseOpt.isSome:
  let resp = responseOpt.get()
  echo resp

updateComment

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Ні
updatableCommentParams	UpdatableCommentParams	Ні
options	UpdateCommentOptions	Ні

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateComment Приклад

Copy

let commentParams = UpdatableCommentParams(content: "Updated comment content")
let updateOpts = UpdateCommentOptions(force: false)
let (respOpt, httpResp) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = commentParams,
  options = updateOpts
)
if respOpt.isSome:
  let resp = respOpt.get()

voteComment

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

Відповідь

Повертає: Option[VoteResponse]

Приклад

voteComment Приклад

Copy

let (voteRespOpt, httpResp) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  urlId = "blog/how-to-code",
  broadcastId = "",
  voteBodyParams = VoteBodyParams(),
  options = VoteCommentOptions()
)
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()

getCommentsForUser

Параметри

Назва	Тип	Обов’язковий	Опис
options	GetCommentsForUserOptions	No

Відповідь

Повертає: Option[GetCommentsForUserResponse]

Приклад

Приклад getCommentsForUser

Copy

let (maybeResp, httpResp) = client.getCommentsForUser(options = GetCommentsForUserOptions(
  tenantId = "my-tenant-123",
  userId = "user-456",
  page = 0,
  pageSize = 20,
  includeDeleted = false,
  commentIds = @[]
))
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp

addDomainConfig

Параметри

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

Відповідь

Повертає: Option[AddDomainConfigResponse]

Приклад

addDomainConfig Приклад

Copy

let (respOpt, httpResp) = client.addDomainConfig(
  tenantId = "my-tenant-123",
  addDomainConfigParams = default(AddDomainConfigParams)
)
if respOpt.isSome:
  let cfg = respOpt.get()

deleteDomainConfig

Параметри

Ім'я	Тип	Обов'язково	Опис
tenantId	string	Yes
domain	string	No

Відповідь

Повертає: Option[DeleteDomainConfigResponse]

Приклад

deleteDomainConfig Приклад

Copy

let (optResp, httpResp) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getDomainConfig

Параметри

Name	Type	Required	Description
tenantId	string	Так
domain	string	Ні

Відповідь

Повертає: Option[GetDomainConfigResponse]

Приклад

getDomainConfig Приклад

Copy

let (configOpt, httpResp) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if configOpt.isSome:
  let cfg = configOpt.get()
  discard cfg

getDomainConfigs

Параметри

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

Відповідь

Повертає: Option[GetDomainConfigsResponse]

Приклад

getDomainConfigs Приклад

Copy

let (domainConfigsOpt, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if domainConfigsOpt.isSome:
  let domainConfigs = domainConfigsOpt.get()
  echo domainConfigs

patchDomainConfig

Parameters

Назва	Тип	Обов’язковий
tenantId	string	Так
domainToUpdate	string	Ні
patchDomainConfigParams	PatchDomainConfigParams	Ні

Response

Повертає: Option[PatchDomainConfigResponse]

Example

patchDomainConfig Приклад

Copy

let (optResp, httpResp) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news.mywebsite.com",
  patchDomainConfigParams = PatchDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

putDomainConfig

Параметри

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

Відповідь

Повертає: Option[PutDomainConfigResponse]

Приклад

putDomainConfig Приклад

Copy

let (optResp, httpResp) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "example.com",
  updateDomainConfigParams = UpdateDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

createEmailTemplate

Параметри

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

Відповідь

Повертає: Option[CreateEmailTemplateResponse]

Приклад

createEmailTemplate Приклад

Copy

let createBody = CreateEmailTemplateBody(
  name: "Welcome Email",
  subject: "Welcome to FastComments",
  htmlBody: "<p>Hello, thank you for joining us!</p>",
  isActive: true,
  tags: @[]
)
let (optResp, httpResp) = client.createEmailTemplate(
  tenantId = "my-tenant-123",
  createEmailTemplateBody = createBody
)
if optResp.isSome:
  let emailTemplate = optResp.get()

deleteEmailTemplate

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteEmailTemplate Приклад

Copy

let (respOpt, httpResp) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if respOpt.isSome:
  let emptyResp = respOpt.get()
  echo "Email template deleted"
else:
  echo "Failed to delete email template"

deleteEmailTemplateRenderError

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteEmailTemplateRenderError Приклад

Copy

let (apiRes, httpRes) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  errorId = "render-err-456"
)
if apiRes.isSome:
  let empty = apiRes.get()

getEmailTemplate

Параметри

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

Відповідь

Повертає: Option[GetEmailTemplateResponse]

Приклад

getEmailTemplate Приклад

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email")
if response.isSome:
  let tmpl = response.get()

getEmailTemplateDefinitions

Параметри

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

Відповідь

Повертає: Option[GetEmailTemplateDefinitionsResponse]

Приклад

getEmailTemplateDefinitions Приклад

Copy

let (responseOpt, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if responseOpt.isSome:
  let definitions = responseOpt.get()
  echo definitions

getEmailTemplateRenderErrors

Параметри

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

Відповідь

Повертає: Option[GetEmailTemplateRenderErrorsResponse]

Приклад

getEmailTemplateRenderErrors Приклад

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # використати resp за потребою
else:
  # обробити відсутню відповідь
  discard

getEmailTemplates

Параметри

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

Відповідь

Returns: Option[GetEmailTemplatesResponse]

Приклад

getEmailTemplates Приклад

Copy

let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if emailTemplatesOpt.isSome:
  let templates = emailTemplatesOpt.get()
  echo templates

renderEmailTemplate

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
renderEmailTemplateBody	RenderEmailTemplateBody	Ні
locale	string = ""	Ні

Відповідь

Повертає: Option[RenderEmailTemplateResponse]

Приклад

renderEmailTemplate Приклад

Copy

let body = RenderEmailTemplateBody()
let (responseOpt, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = body, locale = "en-US")
if responseOpt.isSome:
  let response = responseOpt.get()
  discard response
discard httpResponse

updateEmailTemplate

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад updateEmailTemplate

Copy

let updateBody = UpdateEmailTemplateBody(
  subject: "Welcome to FastComments",
  body: "Hello \{{user_name}}, thanks for joining!",
  enabled: true,
)
let (maybeResp, httpResp) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-email",
  updateEmailTemplateBody = updateBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()

getEventLog

req tenantId urlId userIdWS

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Відповідь

Повертає: Option[GetEventLogResponse]

Приклад

Приклад getEventLog

Copy

let (eventLogOpt, httpResp) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

getGlobalEventLog

req tenantId urlId userIdWS

Параметри

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

Відповідь

Повертає: Option[GetEventLogResponse]

Приклад

getGlobalEventLog Приклад

Copy

let (eventLogOpt, httpResp) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "user-456",
  startTime = 1700000000'i64,
  endTime = 1700003600'i64,
)
if eventLogOpt.isSome:
  let eventLog = eventLogOpt.get()
  echo eventLog

createFeedPost

Параметри

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Відповідь

Returns: Option[CreateFeedPostsResponse]

Приклад

Приклад createFeedPost

Copy

let (respOpt, httpResp) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(),
  options = CreateFeedPostOptions()
)
if respOpt.isSome:
  let feedPost = respOpt.get()

createFeedPostPublic

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
createFeedPostParams	CreateFeedPostParams	Ні
options	CreateFeedPostPublicOptions	Ні

Відповідь

Повертає: Option[CreateFeedPostResponse]

Приклад

createFeedPostPublic Приклад

Copy

let params = CreateFeedPostParams(
  urlId: "news/big-event",
  title: "Big Event Happened",
  content: "Full article content goes here.",
  tags: @["news", "event"]
)
let opts = CreateFeedPostPublicOptions(
  sendNotifications: false,
  allowComments: true
)
let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = params,
  options = opts
)
if response.isSome:
  let post = response.get()
  echo post

deleteFeedPostPublic

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
postId	string	Ні
options	DeleteFeedPostPublicOptions	Ні

Відповідь

Повертає: Option[DeleteFeedPostPublicResponse]

Приклад

deleteFeedPostPublic Приклад

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-42",
  options = DeleteFeedPostPublicOptions()
)
if response.isSome:
  let deleteResp = response.get()

getFeedPosts

req tenantId afterId

Параметри

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

Відповідь

Повертає: Option[GetFeedPostsResponse]

Приклад

getFeedPosts Приклад

Copy

let (feedResponseOpt, httpResp) = client.getFeedPosts(tenantId = "my-tenant-123", options = GetFeedPostsOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()
  echo feedResponse

getFeedPostsPublic

req tenantId afterId

Параметри

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

Відповідь

Повертає: Option[PublicFeedPostsResponse]

Приклад

Приклад getFeedPostsPublic

Copy

let (feedResponseOpt, httpResponse) = client.getFeedPostsPublic(tenantId = "my-tenant-123", options = GetFeedPostsPublicOptions())
if feedResponseOpt.isSome:
  let feedResponse = feedResponseOpt.get()

getFeedPostsStats

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
postIds	seq[string]	Ні
sso	string = ""	Ні

Відповідь

Повертає: Option[FeedPostsStatsResponse]

Приклад

getFeedPostsStats Приклад

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # використовуйте stats за потреби

getUserReactsPublic

Параметри

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

Відповідь

Повертає: Option[UserReactsResponse]

Приклад

Приклад getUserReactsPublic

Copy

let opts = GetUserReactsPublicOptions(
  limit = 20,
  offset = 0,
  includeDeleted = false
)
let (response, httpResponse) = client.getUserReactsPublic(
  tenantId = "my-tenant-123",
  options = opts
)
if response.isSome:
  let userReacts = response.get()

reactFeedPostPublic

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
postId	string	Ні
reactBodyParams	ReactBodyParams	Ні
options	ReactFeedPostPublicOptions	Ні

Відповідь

Повертає: Option[ReactFeedPostResponse]

Приклад

reactFeedPostPublic приклад

Copy

let reactParams = ReactBodyParams()
let (optResp, httpResp) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  reactBodyParams = reactParams,
  options = ReactFeedPostPublicOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

updateFeedPost

Parameters

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад updateFeedPost

Copy

let feedPost = FeedPost(
  title: "Breaking News",
  content: "Updated story content",
  tags: @["news", "update"]
)
let (apiRes, httpRes) = client.updateFeedPost(
  tenantId = "my-tenant-123",
  id = "post-456",
  feedPost = feedPost
)
if apiRes.isSome:
  let res = apiRes.get()

updateFeedPostPublic

Параметри

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

Відповідь

Повертає: Option[CreateFeedPostResponse]

Приклад

Приклад updateFeedPostPublic

Copy

let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-789",
  updateFeedPostParams = UpdateFeedPostParams(),
  options = UpdateFeedPostPublicOptions()
)
if response.isSome:
  let post = response.get()

flagCommentPublic

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

flagCommentPublic Приклад

Copy

let (optResp, httpResp) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  isFlagged = true,
  sso = ""
)
if optResp.isSome:
  let empty = optResp.get()
  discard empty

getGifLarge

Параметри

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

Відповідь

Повертає: Option[GifGetLargeResponse]

Приклад

Приклад getGifLarge

Copy

let (gifOpt, httpResp) = client.getGifLarge(
  tenantId = "my-tenant-123",
  largeInternalURLSanitized = "https://cdn.example.com/gifs/large123.gif")
if gifOpt.isSome:
  let gif = gifOpt.get()
  echo gif

getGifsSearch

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
search	string	Ні
options	GetGifsSearchOptions	Ні

Відповідь

Повертає: Option[GetGifsSearchResponse]

Приклад

Приклад getGifsSearch

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # використовуйте resp за потребою

getGifsTrending

Параметри

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

Відповідь

Повертає: Option[GetGifsTrendingResponse]

Приклад

Приклад getGifsTrending

Copy

let (maybeResponse, httpResponse) = client.getGifsTrending(
  tenantId = "my-tenant-123",
  options = GetGifsTrendingOptions()
)
if maybeResponse.isSome:
  let gifs = maybeResponse.get()
  echo gifs

addHashTag

Параметри

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

Відповідь

Повертає: Option[CreateHashTagResponse]

Приклад

addHashTag Приклад

Copy

let (hashTagOpt, httpResp) = client.addHashTag(
  tenantId = "my-tenant-123",
  createHashTagBody = CreateHashTagBody(),
)
if hashTagOpt.isSome:
  let tag = hashTagOpt.get()

addHashTagsBulk

Параметри

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

Відповідь

Повертає: Option[BulkCreateHashTagsResponse]

Приклад

addHashTagsBulk Приклад

Copy

let (optResp, httpResp) = client.addHashTagsBulk(
  tenantId = "my-tenant-123",
  bulkCreateHashTagsBody = BulkCreateHashTagsBody(
    hashTags = @["news", "technology"]
  )
)
if optResp.isSome:
  let resp = optResp.get()

deleteHashTag

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteHashTag Приклад

Copy

let (apiResp, httpResp) = client.deleteHashTag(tenantId = "my-tenant-123", tag = "sports", deleteHashTagRequestBody = DeleteHashTagRequestBody())
if apiResp.isSome:
  let emptyResp = apiResp.get()

getHashTags

Параметри

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

Відповідь

Повертає: Option[GetHashTagsResponse]

Приклад

Приклад getHashTags

Copy

let (hashTagsOpt, httpResp) = client.getHashTags(tenantId = "my-tenant-123", page = 0.0)
if hashTagsOpt.isSome:
  let hashTags = hashTagsOpt.get()
  echo hashTags
else:
  echo "No hashtags found"

patchHashTag

Параметри

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

Відповідь

Повертає: Option[UpdateHashTagResponse]

Приклад

patchHashTag Приклад

Copy

let updateBody = UpdateHashTagBody()
let (optResp, httpResp) = client.patchHashTag(
  tenantId = "my-tenant-123",
  tag = "news",
  updateHashTagBody = updateBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp
else:
  echo "No response"

deleteModerationVote

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
options	DeleteModerationVoteOptions	No

Відповідь

Повертає: Option[VoteDeleteResponse]

Приклад

deleteModerationVote Приклад

Copy

let (respOpt, httpResp) = client.deleteModerationVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  voteId = "vote-abc123",
  options = DeleteModerationVoteOptions()
)
if respOpt.isSome:
  let resp = respOpt.get()

getApiComments

Параметри

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

Відповідь

Повертає: Option[ModerationAPIGetCommentsResponse]

Приклад

getApiComments Приклад

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # подальша обробка може бути виконана з `resp`

getApiExportStatus

Параметри

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

Відповідь

Повертає: Option[ModerationExportStatusResponse]

Приклад

Приклад getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # використовуйте exportStatus за потребою

getApiIds

Параметри

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

Відповідь

Повертає: Option[ModerationAPIGetCommentIdsResponse]

Приклад

getApiIds Приклад

Copy

let opts = GetApiIdsOptions()
let (maybeResponse, httpResponse) = client.getApiIds(tenantId = "my-tenant-123", options = opts)
if maybeResponse.isSome:
  let response = maybeResponse.get()
  echo response

getBanUsersFromComment

Параметри

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

Відповідь

Повертає: Option[GetBannedUsersFromCommentResponse]

Приклад

Приклад getBanUsersFromComment

Copy

let (response, httpResponse) = client.getBanUsersFromComment(tenantId = "my-tenant-001", commentId = "cmt-123456", sso = "")
if response.isSome:
  let banInfo = response.get()
  echo banInfo

getCommentBanStatus

Параметри

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

Відповідь

Повертає: Option[GetCommentBanStatusResponse]

Приклад

getCommentBanStatus Приклад

Copy

let (banStatusOpt, httpResp) = client.getCommentBanStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  sso = "")
if banStatusOpt.isSome:
  let banStatus = banStatusOpt.get()
  echo banStatus

getCommentChildren

Параметри

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

Відповідь

Повертає: Option[ModerationAPIChildCommentsResponse]

Приклад

Приклад getCommentChildren

Copy

let (childRespOpt, httpResp) = client.getCommentChildren(tenantId = "my-tenant-123", commentId = "cmt-456789", sso = "")
if childRespOpt.isSome:
  let childResp = childRespOpt.get()
  echo childResp

getCount

Параметри

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

Відповідь

Повертає: Option[ModerationAPICountCommentsResponse]

Приклад

Приклад getCount

Copy

let (countOpt, httpResponse) = client.getCount(tenantId = "my-tenant-123", options = GetCountOptions())
if countOpt.isSome:
  let count = countOpt.get()

getCounts

Параметри

Назва	Тип	Обов’язковий	Опис
tenantId	string	Yes
sso	string = ""	No

Відповідь

Повертає: Option[GetBannedUsersCountResponse]

Приклад

Приклад getCounts

Copy

let (maybeCounts, httpRes) = client.getCounts(tenantId = "my-tenant-123", sso = "")
if maybeCounts.isSome:
  let counts = maybeCounts.get()
  echo counts
else:
  echo "No counts returned"

getLogs

Параметри

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

Відповідь

Повертає: Option[ModerationAPIGetLogsResponse]

Приклад

getLogs Приклад

Copy

let (logsOpt, httpRes) = client.getLogs(tenantId = "my-tenant-123", commentId = "cmt-789", sso = "")
if logsOpt.isSome:
  let logs = logsOpt.get()
  echo logs

getManualBadges

Параметри

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

Відповідь

Повертає: Option[GetTenantManualBadgesResponse]

Приклад

Приклад getManualBadges

Copy

let (manualBadgesOpt, httpResponse) = client.getManualBadges(tenantId = "my-tenant-123", sso = "")
if manualBadgesOpt.isSome:
  let manualBadges = manualBadgesOpt.get()
  echo manualBadges

getManualBadgesForUser

Параметри

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

Відповідь

Повертає: Option[GetUserManualBadgesResponse]

Приклад

Приклад getManualBadgesForUser

Copy

let (userBadgesOpt, httpResp) = client.getManualBadgesForUser(
  tenantId = "my-tenant-123",
  options = GetManualBadgesForUserOptions()
)
if userBadgesOpt.isSome:
  let badges = userBadgesOpt.get()
  echo badges

getModerationComment

Параметри

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

Відповідь

Повертає: Option[ModerationAPICommentResponse]

Приклад

Приклад getModerationComment

Copy

let (maybeComment, httpResponse) = client.getModerationComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(GetModerationCommentOptions)
)
if maybeComment.isSome:
  let comment = maybeComment.get()
  echo comment

getModerationCommentText

Параметри

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

Відповідь

Повертає: Option[GetCommentTextResponse]

Приклад

getModerationCommentText Приклад

Copy

let (optResp, httpResp) = client.getModerationCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-456abc",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getPreBanSummary

Параметри

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

Відповідь

Повертає: Option[PreBanSummary]

Приклад

getPreBanSummary Приклад

Copy

let (preBanSummaryOpt, httpResponse) = client.getPreBanSummary(tenantId = "my-tenant-123", commentId = "cmt-456", options = GetPreBanSummaryOptions())
if preBanSummaryOpt.isSome:
  let summary = preBanSummaryOpt.get()

getSearchCommentsSummary

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

Відповідь

Повертає: Option[ModerationCommentSearchResponse]

Приклад

getSearchCommentsSummary Приклад

Copy

let (summaryOpt, httpResp) = client.getSearchCommentsSummary(
  tenantId = "my-tenant-123",
  options = GetSearchCommentsSummaryOptions()
)
if summaryOpt.isSome:
  let summary = summaryOpt.get()
  echo summary

getSearchPages

Параметри

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

Відповідь

Повертає: Option[ModerationPageSearchResponse]

Приклад

Приклад getSearchPages

Copy

let (searchResp, httpResp) = client.getSearchPages(
  tenantId = "my-tenant-123",
  options = GetSearchPagesOptions(
    page: 1,
    pageSize: 20,
    query: "spam"
  )
)
if searchResp.isSome:
  let resp = searchResp.get()

getSearchSites

Параметри

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

Відповідь

Повертає: Option[ModerationSiteSearchResponse]

Приклад

Приклад getSearchSites

Copy

let (searchResult, httpResp) = client.getSearchSites(tenantId = "my-tenant-123", options = GetSearchSitesOptions())
if searchResult.isSome:
  let siteResp = searchResult.get()

getSearchSuggest

Параметри

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

Відповідь

Повертає: Option[ModerationSuggestResponse]

Приклад

Приклад getSearchSuggest

Copy

let (suggestOpt, httpResp) = client.getSearchSuggest(
  tenantId = "my-tenant-123",
  options = GetSearchSuggestOptions(),
)
if suggestOpt.isSome:
  let suggest = suggestOpt.get()
  echo suggest

getSearchUsers

Параметри

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

Відповідь

Повертає: Option[ModerationUserSearchResponse]

Приклад

getSearchUsers Приклад

Copy

let (searchRes, httpRes) = client.getSearchUsers(tenantId = "my-tenant-123", options = default(GetSearchUsersOptions))
if searchRes.isSome:
  let data = searchRes.get()
  echo data

getTrustFactor

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	GetTrustFactorOptions	No

Відповідь

Повертає: Option[GetUserTrustFactorResponse]

Приклад

Приклад getTrustFactor

Copy

let (trustOpt, httpResp) = client.getTrustFactor(tenantId = "my-tenant-123", options = GetTrustFactorOptions())
if trustOpt.isSome:
  let trust = trustOpt.get()
  discard trust

getUserBanPreference

Параметри

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

Відповідь

Повертає: Option[APIModerateGetUserBanPreferencesResponse]

Приклад

Приклад getUserBanPreference

Copy

let (maybePref, httpResp) = client.getUserBanPreference(tenantId = "my-tenant-123", sso = "")
if maybePref.isSome:
  let pref = maybePref.get()
  echo pref

getUserInternalProfile

Параметри

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

Відповідь

Повертає: Option[GetUserInternalProfileResponse]

Приклад

getUserInternalProfile Приклад

Copy

let (profileOpt, httpResp) = client.getUserInternalProfile(
  tenantId = "my-tenant-123",
  options = GetUserInternalProfileOptions()
)
if profileOpt.isSome:
  let profile = profileOpt.get()

postAdjustCommentVotes

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
commentId	string	Так
adjustCommentVotesParams	AdjustCommentVotesParams	Ні
options	PostAdjustCommentVotesOptions	Ні

Відповідь

Повертає: Option[AdjustVotesResponse]

Приклад

postAdjustCommentVotes Приклад

Copy

let (adjustRespOpt, httpResp) = client.postAdjustCommentVotes(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  adjustCommentVotesParams = AdjustCommentVotesParams(),
  options = PostAdjustCommentVotesOptions()
)
if adjustRespOpt.isSome:
  let adjustResp = adjustRespOpt.get()

postApiExport

Параметри

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

Відповідь

Повертає: Option[ModerationExportResponse]

Приклад

postApiExport Приклад

Copy

let (optExport, httpResp) = client.postApiExport(tenantId = "my-tenant-123", options = PostApiExportOptions())
if optExport.isSome:
  let export = optExport.get()
  echo export

postBanUserFromComment

Параметри

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

Відповідь

Returns: Option[BanUserFromCommentResult]

Приклад

postBanUserFromComment Приклад

Copy

let (banResult, httpResp) = client.postBanUserFromComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456",
  options = PostBanUserFromCommentOptions()
)
if banResult.isSome:
  let result = banResult.get()
  echo result

postBanUserUndo

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
banUserUndoParams	BanUserUndoParams	No
sso	string = ""	No

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад postBanUserUndo

Copy

let (apiResp, httpResp) = client.postBanUserUndo(
  tenantId = "my-tenant-123",
  banUserUndoParams = BanUserUndoParams(userId = "user-456"),
  sso = ""
)
if apiResp.isSome:
  let _ = apiResp.get()

postBulkPreBanSummary

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
bulkPreBanParams	BulkPreBanParams	Ні
options	PostBulkPreBanSummaryOptions	Ні

Відповідь

Повертає: Option[BulkPreBanSummary]

Приклад

Приклад postBulkPreBanSummary

Copy

let bulkParams = BulkPreBanParams(emailAddresses: @["spam@example.com"], ipAddresses: @["203.0.113.5"])
let opt = PostBulkPreBanSummaryOptions(dryRun: false, maxResults: 0)
let (summaryOpt, httpResp) = client.postBulkPreBanSummary(tenantId = "my-tenant-123", bulkPreBanParams = bulkParams, options = opt)
if summaryOpt.isSome:
  let _ = summaryOpt.get()

postCommentsByIds

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentsByIdsParams	CommentsByIdsParams	Ні
sso	string = ""	Ні

Відповідь

Повертає: Option[ModerationAPIChildCommentsResponse]

Приклад

postCommentsByIds Приклад

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # використати resp за потреби

postFlagComment

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

postFlagComment Приклад

Copy

let opts = PostFlagCommentOptions()
let (response, httpResponse) = client.postFlagComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = opts,
)
if response.isSome:
  let result = response.get()

postRemoveComment

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
options	PostRemoveCommentOptions	Ні

Відповідь

Повертає: Option[PostRemoveCommentApiResponse]

Приклад

postRemoveComment Приклад

Copy

let (apiResponseOpt, httpResp) = client.postRemoveComment(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  options = PostRemoveCommentOptions()
)
if apiResponseOpt.isSome:
  let apiResponse = apiResponseOpt.get()

postRestoreDeletedComment

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

postRestoreDeletedComment Приклад

Copy

let (respOpt, httpResp) = client.postRestoreDeletedComment(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  options = default(PostRestoreDeletedCommentOptions)
)
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Comment restored"

postSetCommentApprovalStatus

Параметри

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

Відповідь

Повертає: Option[SetCommentApprovedResponse]

Приклад

postSetCommentApprovalStatus Приклад

Copy

let (approvedOpt, httpResp) = client.postSetCommentApprovalStatus(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  options = PostSetCommentApprovalStatusOptions()
)
if approvedOpt.isSome:
  let approved = approvedOpt.get()
  echo approved

postSetCommentReviewStatus

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

postSetCommentReviewStatus Приклад

Copy

let (apiResp, httpResp) = client.postSetCommentReviewStatus(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  options = PostSetCommentReviewStatusOptions()
)
if apiResp.isSome:
  let _ = apiResp.get()
  discard
else:
  discard

postSetCommentSpamStatus

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

postSetCommentSpamStatus Приклад

Copy

let defaultOpts = PostSetCommentSpamStatusOptions()
let (maybeResp, httpResp) = client.postSetCommentSpamStatus(tenantId = "my-tenant-123", commentId = "cmt-456789", options = defaultOpts)
if maybeResp.isSome:
  let resp = maybeResp.get()

postSetCommentText

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

Відповідь

Повертає: Option[SetCommentTextResponse]

Приклад

postSetCommentText Приклад

Copy

let (responseOpt, httpResponse) = client.postSetCommentText(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  setCommentTextParams = SetCommentTextParams(),
  options = PostSetCommentTextOptions()
)
if responseOpt.isSome:
  let updatedComment = responseOpt.get()

postUnFlagComment

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

postUnFlagComment Приклад

Copy

let (maybeResp, httpResp) = client.postUnFlagComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  options = default(PostUnFlagCommentOptions)
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

postVote

Параметри

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

Відповідь

Повертає: Option[VoteResponse]

Приклад

postVote Приклад

Copy

let (voteOpt, httpResp) = client.postVote(
  tenantId = "my-tenant-123",
  commentId = "comment-789",
  options = default(PostVoteOptions)
)
if voteOpt.isSome:
  let vote = voteOpt.get()

putAwardBadge

Параметри

Name	Type	Required
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

Відповідь

Returns: Option[AwardUserBadgeResponse]

Приклад

putAwardBadge Приклад

Copy

let (response, httpResponse) = client.putAwardBadge(
  tenantId = "my-tenant-123",
  badgeId = "gold-badge",
  options = PutAwardBadgeOptions()
)
if response.isSome:
  let award = response.get()

putCloseThread

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад putCloseThread

Copy

let (respOpt, httpResp) = client.putCloseThread(tenantId = "my-tenant-123", urlId = "news/fastcomments-integration", sso = "")
if respOpt.isSome:
  let empty = respOpt.get()
  echo "Thread successfully closed"

putRemoveBadge

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
badgeId	string	Ні
options	PutRemoveBadgeOptions	Ні

Відповідь

Повертає: Option[RemoveUserBadgeResponse]

Приклад

putRemoveBadge Приклад

Copy

let (maybeResp, httpResp) = client.putRemoveBadge(
  tenantId = "my-tenant-123",
  badgeId = "badge-456",
  options = PutRemoveBadgeOptions()
)
if maybeResp.isSome:
  let badgeResp = maybeResp.get()

putReopenThread

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

putReopenThread Приклад

Copy

let (apiRespOpt, httpResp) = client.putReopenThread(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  sso = ""
)
if apiRespOpt.isSome:
  let emptyResp = apiRespOpt.get()
  discard

setTrustFactor

Параметри

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

Відповідь

Повертає: Option[SetUserTrustFactorResponse]

Приклад

setTrustFactor Приклад

Copy

let opts = SetTrustFactorOptions(userId = "user-456", trustFactor = 5, reason = "spam detection")
let (trustResponse, httpResponse) = client.setTrustFactor(tenantId = "my-tenant-123", options = opts)
if trustResponse.isSome:
  let result = trustResponse.get()

createModerator

Параметри

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

Відповідь

Повертає: Option[CreateModeratorResponse]

Приклад

createModerator Приклад

Copy

let (moderatorRes, httpResp) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = CreateModeratorBody())
if moderatorRes.isSome:
  let moderator = moderatorRes.get()

deleteModerator

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Ні
sendEmail	string = ""	Ні

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад deleteModerator

Copy

let (apiResp, httpResp) = client.deleteModerator(
  tenantId = "my-tenant-123",
  id = "mod-789",
  sendEmail = "admin@mydomain.com",
)
if apiResp.isSome:
  let empty = apiResp.get()
  echo "Moderator removed"

getModerator

Параметри

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

Відповідь

Повертає: Option[GetModeratorResponse]

Приклад

Приклад getModerator

Copy

let (moderatorOpt, httpResponse) = client.getModerator(tenantId = "my-tenant-123", id = "moderator-456")
if moderatorOpt.isSome:
  let moderator = moderatorOpt.get()
  discard moderator

getModerators

Параметри

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

Відповідь

Повертає: Option[GetModeratorsResponse]

Приклад

Приклад getModerators

Copy

let (moderatorsOpt, httpResp) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if moderatorsOpt.isSome:
  let moderators = moderatorsOpt.get()
  echo moderators

updateModerator

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад updateModerator

Copy

let body = UpdateModeratorBody(name = "John Doe", email = "john@example.com", isActive = true)
let (apiResult, httpResp) = client.updateModerator(tenantId = "my-tenant-123", id = "mod-456", updateModeratorBody = body)
if apiResult.isSome:
  let result = apiResult.get()

deleteNotificationCount

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteNotificationCount Приклад

Copy

let (apiRespOpt, httpResp) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if apiRespOpt.isSome:
  let _ = apiRespOpt.get()

getCachedNotificationCount

Параметри

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

Відповідь

Повертає: Option[GetCachedNotificationCountResponse]

Приклад

Приклад getCachedNotificationCount

Copy

let (cachedCountOpt, httpResp) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "article-456")
if cachedCountOpt.isSome:
  let cachedCount = cachedCountOpt.get()
  echo cachedCount

getNotificationCount

Параметри

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

Відповідь

Повертає: Option[GetNotificationCountResponse]

Приклад

Приклад getNotificationCount

Copy

let (notifOpt, httpResp) = client.getNotificationCount(tenantId = "my-tenant-123", options = GetNotificationCountOptions())
if notifOpt.isSome:
  let notif = notifOpt.get()
  echo notif

getNotifications

Parameters

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

Response

Повертає: Option[GetNotificationsResponse]

Example

Приклад getNotifications

Copy

let (notifOpt, httpResp) = client.getNotifications(tenantId = "my-tenant-123", options = GetNotificationsOptions())
if notifOpt.isSome:
  let notifications = notifOpt.get()

updateNotification

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateNotification Приклад

Copy

let body = UpdateNotificationBody(message: "Your comment was approved", isRead: false)
let (optResp, httpResp) = client.updateNotification(
  tenantId = "my-tenant-123",
  id = "notif-789",
  updateNotificationBody = body,
  userId = "user-42"
)
if optResp.isSome:
  let _ = optResp.get()

createV1PageReact

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
urlId	string	Yes
title	string = ""	No

Відповідь

Повертає: Option[CreateV1PageReact]

Приклад

Приклад createV1PageReact

Copy

let (pageOpt, httpResp) = client.createV1PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  title = "Breaking News: Nim Takes Over"
)
if pageOpt.isSome:
  let page = pageOpt.get()
  discard page
  discard httpResp

createV2PageReact

Параметри

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

Відповідь

Повертає: Option[CreateV1PageReact]

Приклад

Приклад createV2PageReact

Copy

let (pageResult, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "page-456",
  title = "Breaking News",
)
if pageResult.isSome:
  let page = pageResult.get()
  # використати `page` за потреби

deleteV1PageReact

Параметри

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

Відповідь

Повертає: Option[CreateV1PageReact]

Приклад

deleteV1PageReact Приклад

Copy

let (reactOpt, httpResp) = client.deleteV1PageReact(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactOpt.isSome:
  let react = reactOpt.get()

deleteV2PageReact

Параметри

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

Відповідь

Повертає: Option[CreateV1PageReact]

Приклад

deleteV2PageReact Приклад

Copy

let (maybeReact, httpResp) = client.deleteV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "react-456",
)
if maybeReact.isSome:
  let react = maybeReact.get()
  echo react

getV1PageLikes

Параметри

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

Відповідь

Повертає: Option[GetV1PageLikes]

Приклад

getV1PageLikes Приклад

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # використовуйте pageLikes за потреби

getV2PageReacts

Параметри

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Відповідь

Повертає: Option[GetV2PageReacts]

Приклад

Приклад getV2PageReacts

Copy

let (reactsOpt, httpResp) = client.getV2PageReacts(tenantId = "my-tenant-123", urlId = "news/article-title")
if reactsOpt.isSome:
  let reacts = reactsOpt.get()
  echo reacts

getV2PageReactUsers

Параметри

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

Відповідь

Повертає: Option[GetV2PageReactUsersResponse]

Приклад

getV2PageReactUsers Приклад

Copy

let (maybeResponse, httpResponse) = client.getV2PageReactUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "user-456"
)
if maybeResponse.isSome:
  let resp = maybeResponse.get()
  echo resp

addPage

Параметри

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

Відповідь

Повертає: Option[AddPageAPIResponse]

Приклад

addPage Приклад

Copy

let pageData = CreateAPIPageData(
  urlId = "news/article-2024",
  title = "Breaking News: Nim Takes Over",
  description = "An in-depth article about Nim's rise.",
  tags = @["nim", "programming", "news"]
)
let (addPageResp, httpResp) = client.addPage(
  tenantId = "my-tenant-123",
  createAPIPageData = pageData
)
if addPageResp.isSome:
  let resp = addPageResp.get()
  echo resp

deletePage

Параметри

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

Відповідь

Повертає: Option[DeletePageAPIResponse]

Приклад

deletePage Приклад

Copy

let (deleteRespOpt, httpResp) = client.deletePage(tenantId = "my-tenant-123", id = "news/article-title")
if deleteRespOpt.isSome:
  let deleteResp = deleteRespOpt.get()
  discard deleteResp
discard httpResp

getOfflineUsers

Попередні коментатори на сторінці, які НЕ перебувають онлайн. Відсортовано за displayName.
Використовуйте це після використання /users/online, щоб відобразити розділ «Members».
Пагінація курсором за commenterName: сервер проходить частковий {tenantId, urlId, commenterName} індекс після afterName вперед за допомогою $gt, без витрат $skip.

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Відповідь

Returns: Option[PageUsersOfflineResponse]

Приклад

Приклад getOfflineUsers

Copy

let (offlineResp, httpResponse) = client.getOfflineUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetOfflineUsersOptions()
)
if offlineResp.isSome:
  let offline = offlineResp.get()
  echo offline)

getOnlineUsers

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

Parameters

Назва	Тип	Обов’язково
tenantId	string	Yes
urlId	string	Yes
options	GetOnlineUsersOptions	No

Response

Повертає: Option[PageUsersOnlineResponse]

Example

Приклад getOnlineUsers

Copy

let opts = GetOnlineUsersOptions()
let (onlineUsersOpt, httpResp) = client.getOnlineUsers(tenantId = "my-tenant-123", urlId = "news/article-title", options = opts)
if onlineUsersOpt.isSome:
  let onlineUsers = onlineUsersOpt.get()
  echo onlineUsers

getPageByURLId

Параметри

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

Відповідь

Повертає: Option[GetPageByURLIdAPIResponse]

Приклад

Приклад getPageByURLId

Copy

let (pageOpt, httpRes) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if pageOpt.isSome:
  let page = pageOpt.get()
  echo page

getPages

Параметри

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

Відповідь

Повертає: Option[GetPagesAPIResponse]

Приклад

Приклад getPages

Copy

let (pagesOpt, httpResp) = client.getPages(tenantId = "my-tenant-123")
if pagesOpt.isSome:
  let pages = pagesOpt.get()
  echo pages
else:
  echo "No pages returned"
echo httpResp

getPagesPublic

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.

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetPagesPublicOptions	No

Response

Повертає: Option[GetPublicPagesResponse]

Example

getPagesPublic Приклад

Copy

let (response, httpResponse) = client.getPagesPublic(tenantId = "my-tenant-123", options = GetPagesPublicOptions())
if response.isSome:
  let pages = response.get()
  echo pages

getUsersInfo

Пакетна інформація про користувачів для орендаря. За заданими userIds повертає інформацію для відображення з User / SSOUser. Використовується віджетом коментарів для збагачення користувачів, які лише‑що з’явилися через подію присутності. Без контексту сторінки: конфіденційність застосовується уніфіковано (приватні профілі маскуються).

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

Returns: Option[PageUsersInfoResponse]

Example

Приклад getUsersInfo

Copy

let (usersInfoOpt, httpResp) = client.getUsersInfo(tenantId = "my-tenant-123", ids = "user42")
if usersInfoOpt.isSome:
  let usersInfo = usersInfoOpt.get()

patchPage

Параметри

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

Відповідь

Повертає: Option[PatchPageAPIResponse]

Приклад

patchPage Приклад

Copy

let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/article-456",
  updateAPIPageData = UpdateAPIPageData(title = "Updated article title", description = "Revised description")
)
if response.isSome:
  let resp = response.get()

deletePendingWebhookEvent

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deletePendingWebhookEvent Приклад

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "event-456")
if response.isSome:
  let empty = response.get()

getPendingWebhookEventCount

Параметри

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

Відповідь

Повертає: Option[GetPendingWebhookEventCountResponse]

Приклад

Приклад getPendingWebhookEventCount

Copy

let (pendingCountOpt, httpResponse) = client.getPendingWebhookEventCount(tenantId = "my-tenant-123", options = GetPendingWebhookEventCountOptions())
if pendingCountOpt.isSome:
  let pendingCount = pendingCountOpt.get()
  echo pendingCount

getPendingWebhookEvents

Параметри

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

Відповідь

Повертає: Option[GetPendingWebhookEventsResponse]

Приклад

Приклад getPendingWebhookEvents

Copy

let (maybeResp, httpResp) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  options = GetPendingWebhookEventsOptions()
)
if maybeResp.isSome:
  let resp = maybeResp.get()

createQuestionConfig

Параметри

Name	Type	Required	Description
tenantId	string	Так
createQuestionConfigBody	CreateQuestionConfigBody	Ні

Відповідь

Повертає: Option[CreateQuestionConfigResponse]

Приклад

createQuestionConfig Приклад

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # використати resp за потребою

deleteQuestionConfig

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад deleteQuestionConfig

Copy

let (apiResult, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "question-config-456")
if apiResult.isSome:
  let empty = apiResult.get()

getQuestionConfig

Параметри

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

Відповідь

Повертає: Option[GetQuestionConfigResponse]

Приклад

Приклад getQuestionConfig

Copy

let (questionConfigOpt, httpResp) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "question-987")
if questionConfigOpt.isSome:
  let config = questionConfigOpt.get()
  echo config

getQuestionConfigs

Параметри

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

Відповідь

Повертає: Option[GetQuestionConfigsResponse]

Приклад

Приклад getQuestionConfigs

Copy

let (response, httpResponse) = client.getQuestionConfigs(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let configs = response.get()
  echo configs

updateQuestionConfig

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateQuestionConfig Приклад

Copy

let (apiResp, httpResp) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if apiResp.isSome:
  let resp = apiResp.get()

createQuestionResult

Параметри

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

Відповідь

Повертає: Option[CreateQuestionResultResponse]

Приклад

createQuestionResult Приклад

Copy

let tenantId = "my-tenant-123"
let body = CreateQuestionResultBody()
let (optResult, httpResp) = client.createQuestionResult(tenantId = tenantId, createQuestionResultBody = body)
if optResult.isSome:
  let result = optResult.get()
  echo result

deleteQuestionResult

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteQuestionResult Приклад

Copy

let (maybeResult, httpResp) = client.deleteQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if maybeResult.isSome:
  let result = maybeResult.get()

getQuestionResult

Параметри

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

Відповідь

Повертає: Option[GetQuestionResultResponse]

Приклад

Приклад getQuestionResult

Copy

let (optResult, httpResp) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if optResult.isSome:
  let result = optResult.get()
  discard result

getQuestionResults

Параметри

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

Відповідь

Повертає: Option[GetQuestionResultsResponse]

Приклад

getQuestionResults Приклад

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  options = GetQuestionResultsOptions()
)
if response.isSome:
  let results = response.get()
  echo results

updateQuestionResult

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateQuestionResult Приклад

Copy

let (optResp, httpResp) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody()
)
if optResp.isSome:
  let resp = optResp.get()

aggregateQuestionResults

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	AggregateQuestionResultsOptions	No

Відповідь

Повертає: Option[AggregateQuestionResultsResponse]

Приклад

aggregateQuestionResults Приклад

Copy

let opts = AggregateQuestionResultsOptions()
let (aggResultOpt, httpResp) = client.aggregateQuestionResults(tenantId = "my-tenant-123", options = opts)
if aggResultOpt.isSome:
  let aggResult = aggResultOpt.get()

bulkAggregateQuestionResults

Параметри

Name	Type	Required
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Відповідь

Повертає: Option[BulkAggregateQuestionResultsResponse]

Приклад

bulkAggregateQuestionResults Приклад

Copy

let request = BulkAggregateQuestionResultsRequest()
let (maybeResult, httpResp) = client.bulkAggregateQuestionResults(
  tenantId = "my-tenant-123",
  bulkAggregateQuestionResultsRequest = request,
  forceRecalculate = false)
if maybeResult.isSome:
  let result = maybeResult.get()

combineCommentsWithQuestionResults

Параметри

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

Відповідь

Повертає: Option[CombineQuestionResultsWithCommentsResponse]

Приклад

combineCommentsWithQuestionResults Приклад

Copy

let (combineOpt, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  options = default(CombineCommentsWithQuestionResultsOptions)
)
if combineOpt.isSome:
  let combineResult = combineOpt.get()

addSSOUser

Параметри

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

Відповідь

Повертає: Option[AddSSOUserAPIResponse]

Приклад

addSSOUser Приклад

Copy

let (optResp, httpResp) = client.addSSOUser(tenantId = "my-tenant-123", createAPISSOUserData = CreateAPISSOUserData())
if optResp.isSome:
  let userResp = optResp.get()

deleteSSOUser

Параметри

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

Відповідь

Повертає: Option[DeleteSSOUserAPIResponse]

Приклад

deleteSSOUser Приклад

Copy

let (apiRespOpt, httpResp) = client.deleteSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteSSOUserOptions()
)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()

getSSOUserByEmail

Параметри

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

Відповідь

Повертає: Option[GetSSOUserByEmailAPIResponse]

Приклад

Приклад getSSOUserByEmail

Copy

let (optResp, httpResp) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "john.doe@example.com")
if optResp.isSome:
  let user = optResp.get()
  discard user

getSSOUserById

Параметри

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

Відповідь

Повертає: Option[GetSSOUserByIdAPIResponse]

Приклад

Приклад getSSOUserById

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "user-456")
if response.isSome:
  let userInfo = response.get()
  discard userInfo

getSSOUsers

Параметри

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

Відповідь

Повертає: Option[GetSSOUsersResponse]

Приклад

getSSOUsers Приклад

Copy

let (maybeResponse, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if maybeResponse.isSome:
  let users = maybeResponse.get()
  echo users
else:
  echo "No SSO users found"
echo httpResponse.statusCode

patchSSOUser

Параметри

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

Відповідь

Повертає: Option[PatchSSOUserAPIResponse]

Приклад

patchSSOUser Приклад

Copy

let updateData = UpdateAPISSOUserData()
let (responseOpt, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = updateData,
  updateComments = true)
if responseOpt.isSome:
  let response = responseOpt.get()
  echo response
echo httpResponse.statusCode

putSSOUser

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Відповідь

Returns: Option[PutSSOUserAPIResponse]

Приклад

putSSOUser Приклад

Copy

let (apiRespOpt, httpResp) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = default(UpdateAPISSOUserData),
  updateComments = false)
if apiRespOpt.isSome:
  let apiResp = apiRespOpt.get()
  echo apiResp

createSubscription

Параметри

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

Відповідь

Повертає: Option[CreateSubscriptionAPIResponse]

Приклад

Приклад createSubscription

Copy

let (respOpt, httpResp) = client.createSubscription(
  tenantId = "my-tenant-123",
  createAPIUserSubscriptionData = default(CreateAPIUserSubscriptionData),
)
if respOpt.isSome:
  let resp = respOpt.get()

deleteSubscription

Параметри

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

Відповідь

Повертає: Option[DeleteSubscriptionAPIResponse]

Приклад

deleteSubscription Приклад

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # використовуйте apiResult за потребою

getSubscriptions

Параметри

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

Відповідь

Повертає: Option[GetSubscriptionsAPIResponse]

Приклад

getSubscriptions Приклад

Copy

let (subscriptionsOpt, httpResp) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "user-456")
if subscriptionsOpt.isSome:
  let subscriptions = subscriptionsOpt.get()
  echo subscriptions

updateSubscription

Параметри

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

Відповідь

Повертає: Option[UpdateSubscriptionAPIResponse]

Приклад

Приклад updateSubscription

Copy

let subscriptionData = UpdateAPIUserSubscriptionData(
  planId = "premium-plan",
  isActive = true,
  expiresAt = "2025-01-01",
)
let (responseOpt, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = subscriptionData,
  userId = "user-789",
)
if responseOpt.isSome:
  let subscriptionResult = responseOpt.get()

getTenantDailyUsages

Параметри

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

Відповідь

Повертає: Option[GetTenantDailyUsagesResponse]

Приклад

Приклад getTenantDailyUsages

Copy

let (respOpt, httpResp) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  options = default(GetTenantDailyUsagesOptions),
)
if respOpt.isSome:
  let usage = respOpt.get()
  echo usage
  echo httpResp.statusCode

createTenantPackage

Параметри

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

Відповідь

Повертає: Option[CreateTenantPackageResponse]

Приклад

createTenantPackage Приклад

Copy

let (responseOpt, httpResponse) = client.createTenantPackage(
  tenantId = "my-tenant-123",
  createTenantPackageBody = CreateTenantPackageBody()
)
if responseOpt.isSome:
  let response = responseOpt.get()

deleteTenantPackage

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

Приклад deleteTenantPackage

Copy

let (apiResponse, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-456def")
if apiResponse.isSome:
  let emptyResponse = apiResponse.get()

getTenantPackage

Параметри

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

Відповідь

Повертає: Option[GetTenantPackageResponse]

Приклад

Приклад getTenantPackage

Copy

let (pkgOpt, httpResp) = client.getTenantPackage(tenantId = "my-tenant-123", id = "premium-plan")
if pkgOpt.isSome:
  let pkg = pkgOpt.get()
  echo pkg

getTenantPackages

Параметри

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Відповідь

Повертає: Option[GetTenantPackagesResponse]

Приклад

Приклад getTenantPackages

Copy

let (maybeResp, httpResp) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if maybeResp.isSome:
  let packages = maybeResp.get()
  echo packages
  echo httpResp.statusCode

replaceTenantPackage

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

replaceTenantPackage Приклад

Copy

let (optResp, httpResp) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-456",
  replaceTenantPackageBody = ReplaceTenantPackageBody()
)
if optResp.isSome:
  let resp = optResp.get()
  discard resp

updateTenantPackage

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateTenantPackage Приклад

Copy

let body = UpdateTenantPackageBody()
let (optResp, httpResp) = client.updateTenantPackage(
  tenantId = "my-tenant-123",
  id = "premium-plan",
  updateTenantPackageBody = body
)
if optResp.isSome:
  let empty = optResp.get()

createTenantUser

Параметри

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

Відповідь

Повертає: Option[CreateTenantUserResponse]

Приклад

createTenantUser Приклад

Copy

let tenantId = "my-tenant-123"
let userBody = CreateTenantUserBody(
  email: "john.doe@example.com",
  name: "John Doe",
  password: "s3cr3tP@ss",
  role: "admin"
)
let (optResp, httpResp) = client.createTenantUser(
  tenantId = tenantId,
  createTenantUserBody = userBody
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp.userId

deleteTenantUser

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteTenantUser Приклад

Copy

let (response, httpResponse) = client.deleteTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  options = DeleteTenantUserOptions(),
)
if response.isSome:
  let empty = response.get()
  echo "User successfully deleted"

getTenantUser

Параметри

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

Відповідь

Повертає: Option[GetTenantUserResponse]

Приклад

Приклад getTenantUser

Copy

let (maybeUser, httpResp) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-456")
if maybeUser.isSome:
  let user = maybeUser.get()
  echo user

getTenantUsers

Параметри

Name	Type	Required	Description
tenantId	string	Так
skip	float64	Ні

Відповідь

Повертає: Option[GetTenantUsersResponse]

Приклад

getTenantUsers Приклад

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let data = response.get()
  echo data

replaceTenantUser

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

replaceTenantUser Приклад

Copy

let replaceBody = ReplaceTenantUserBody()
let (response, httpResponse) = client.replaceTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  replaceTenantUserBody = replaceBody,
  updateComments = "")
if response.isSome:
  let empty = response.get()

sendLoginLink

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

sendLoginLink Приклад

Copy

let (maybeResp, httpResp) = client.sendLoginLink(
  tenantId = "my-tenant-123",
  id = "user-456",
  redirectURL = "https://myapp.example.com/login-success"
)
if maybeResp.isSome:
  let emptyResp = maybeResp.get()

updateTenantUser

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateTenantUser Приклад

Copy

let updateBody = UpdateTenantUserBody()
let (optResp, httpResp) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateTenantUserBody = updateBody,
  updateComments = "Changed role to moderator",
)
if optResp.isSome:
  let _ = optResp.get()

createTenant

Параметри

Name	Type	Required	Description
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Відповідь

Повертає: Option[CreateTenantResponse]

Приклад

createTenant Приклад

Copy

let (maybeResp, httpResp) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody())
if maybeResp.isSome:
  let resp = maybeResp.get()
  discard resp
discard httpResp

deleteTenant

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

deleteTenant Приклад

Copy

let (respOpt, httpResp) = client.deleteTenant(tenantId = "my-tenant-123", id = "tenant-to-delete", sure = "yes")
if respOpt.isSome:
  let emptyResp = respOpt.get()

getTenant

Параметри

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

Відповідь

Повертає: Option[GetTenantResponse]

Приклад

getTenant Приклад

Copy

let (tenantResponse, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "config-001")
if tenantResponse.isSome:
  let tenant = tenantResponse.get()
  echo tenant

getTenants

Параметри

Ім'я	Тип	Обов’язково	Опис
tenantId	string	Так
options	GetTenantsOptions	Ні

Відповідь

Повертає: Option[GetTenantsResponse]

Приклад

Приклад getTenants

Copy

let (maybeResp, httpResp) = client.getTenants(tenantId = "my-tenant-123", options = GetTenantsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

updateTenant

Параметри

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

Відповідь

Повертає: Option[APIEmptyResponse]

Приклад

updateTenant Приклад

Copy

let updateBody = UpdateTenantBody(
  name: "My Tenant",
  description: "Tenant for news site",
  isActive: true,
  allowedDomains: @["example.com", "news.com"]
)
let (apiResp, httpResp) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = updateBody
)
if apiResp.isSome:
  let emptyResp = apiResp.get()

changeTicketState

Parameters

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

Response

Повертає: Option[ChangeTicketStateResponse]

Приклад

changeTicketState Приклад

Copy

let (optResp, httpResp) = client.changeTicketState(
  tenantId = "my-tenant-001",
  userId = "user-42",
  id = "ticket-12345",
  changeTicketStateBody = ChangeTicketStateBody(state = "closed")
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

createTicket

Параметри

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

Відповідь

Повертає: Option[CreateTicketResponse]

Приклад

createTicket Приклад

Copy

let tenantId = "my-tenant-123"
let userId = "user-456"
let ticketBody = CreateTicketBody()
let (responseOpt, httpResponse) = client.createTicket(tenantId = tenantId, userId = userId, createTicketBody = ticketBody)
if responseOpt.isSome:
  let ticketResponse = responseOpt.get()

getTicket

Параметри

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

Відповідь

Повертає: Option[GetTicketResponse]

Приклад

Приклад getTicket

Copy

let (ticketOpt, httpResp) = client.getTicket(tenantId = "my-tenant-123", id = "ticket-456", userId = "")
if ticketOpt.isSome:
  let ticket = ticketOpt.get()
  discard ticket

getTickets

Параметри

Ім'я	Тип	Обов'язковий	Опис
tenantId	string	Yes
options	GetTicketsOptions	No

Відповідь

Повертає: Option[GetTicketsResponse]

Приклад

Приклад getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # використовуйте tickets за потребою

getTranslations

Параметри

Name	Type	Required
namespace	string	Ні
component	string	Ні
options	GetTranslationsOptions	Ні

Відповідь

Повертає: Option[GetTranslationsResponse]

Приклад

Приклад getTranslations

Copy

let opts = GetTranslationsOptions()
let (maybeResp, httpResp) = client.getTranslations(namespace = "my-tenant-123", component = "news/article-title", options = opts)
if maybeResp.isSome:
  let resp = maybeResp.get()
  echo resp

uploadImage

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

Параметри

Name	Type	Required
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Відповідь

Повертає: Option[UploadImageResponse]

Приклад

uploadImage Приклад

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # use result as needed

getUserBadgeProgressById

Параметри

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

Відповідь

Повертає: Option[APIGetUserBadgeProgressResponse]

Приклад

getUserBadgeProgressById Приклад

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "badge-456")
if badgeProgressOpt.isSome:
  let badgeProgress = badgeProgressOpt.get()
  echo badgeProgress

getUserBadgeProgressByUserId

Параметри

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

Відповідь

Повертає: Option[APIGetUserBadgeProgressResponse]

Приклад

getUserBadgeProgressByUserId Приклад

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if badgeProgressOpt.isSome:
  let progress = badgeProgressOpt.get()
  echo progress

getUserBadgeProgressList

Параметри

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

Відповідь

Повертає: Option[APIGetUserBadgeProgressListResponse]

Приклад

Приклад getUserBadgeProgressList

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(tenantId = "my-tenant-123", options = GetUserBadgeProgressListOptions())
if response.isSome:
  let badgeProgress = response.get()

createUserBadge

Параметри

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

Відповідь

Повертає: Option[APICreateUserBadgeResponse]

Приклад

createUserBadge Приклад

Copy

let (badgeRespOpt, httpResp) = client.createUserBadge(tenantId = "my-tenant-123", createUserBadgeParams = default(CreateUserBadgeParams))
if badgeRespOpt.isSome:
  let badgeResp = badgeRespOpt.get()

deleteUserBadge

Параметри

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

Відповідь

Повертає: Option[APIEmptySuccessResponse]

Приклад

deleteUserBadge Приклад

Copy

let (apiResponse, httpResponse) = client.deleteUserBadge(tenantId = "my-tenant-123", id = "badge-456")
if apiResponse.isSome:
  let success = apiResponse.get()

getUserBadge

Параметри

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

Відповідь

Повертає: Option[APIGetUserBadgeResponse]

Приклад

Приклад getUserBadge

Copy

let (badgeOpt, httpResp) = client.getUserBadge(tenantId = "my-tenant-123", id = "user-789")
if badgeOpt.isSome:
  let badge = badgeOpt.get()
  echo badge
else:
  echo "No badge found"
echo httpResp.statusCode

getUserBadges

Параметри

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

Відповідь

Повертає: Option[APIGetUserBadgesResponse]

Приклад

Приклад getUserBadges

Copy

let opts = GetUserBadgesOptions()
let (badgesOpt, httpResp) = client.getUserBadges(tenantId = "my-tenant-123", options = opts)
if badgesOpt.isSome:
  let badges = badgesOpt.get()

updateUserBadge

Параметри

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

Відповідь

Повертає: Option[APIEmptySuccessResponse]

Приклад

updateUserBadge Приклад

Copy

let params = UpdateUserBadgeParams()
let (maybeResp, httpResp) = client.updateUserBadge(tenantId = "my-tenant-123", id = "user-456", updateUserBadgeParams = params)
if maybeResp.isSome:
  let success = maybeResp.get()

getUserNotificationCount

Параметри

Name	Type	Required	Опис
tenantId	string	Так
sso	string = ""	Ні

Відповідь

Повертає: Option[GetUserNotificationCountResponse]

Приклад

getUserNotificationCount Приклад

Copy

let (optResp, httpResp) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if optResp.isSome:
  let resp = optResp.get()
  echo resp

getUserNotifications

Параметри

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

Відповідь

Повертає: Option[GetMyNotificationsResponse]

Приклад

getUserNotifications Приклад

Copy

let (maybeResponse, httpResponse) = client.getUserNotifications(tenantId = "my-tenant-123", options = GetUserNotificationsOptions())
if maybeResponse.isSome:
  let notifications = maybeResponse.get()

resetUserNotificationCount

Параметри

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

Відповідь

Повертає: Option[ResetUserNotificationsResponse]

Приклад

resetUserNotificationCount Приклад

Copy

let (resetRespOpt, httpResp) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "user-456")
if resetRespOpt.isSome:
  let resetResp = resetRespOpt.get()
  echo resetResp
else:
  echo "Reset notification count response not available"

resetUserNotifications

Parameters

Name	Type	Required	Description
tenantId	string	Так
options	ResetUserNotificationsOptions	Ні

Response

Повертає: Option[ResetUserNotificationsResponse]

Example

resetUserNotifications Приклад

Copy

let (maybeResp, httpResp) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  options = ResetUserNotificationsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
notificationId	string	Ні
optedInOrOut	string	Ні
commentId	string	Так
sso	string = ""	Ні

Відповідь

Повертає: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Приклад

Приклад updateUserNotificationCommentSubscriptionStatus

Copy

let (optResp, httpResp) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted-in",
  commentId = "comment-789",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()

updateUserNotificationPageSubscriptionStatus

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

Параметри

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

Відповідь

Повертає: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Приклад

updateUserNotificationPageSubscriptionStatus Приклад

Copy

let (optResp, httpResp) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  url = "https://example.com/news/article-456",
  pageTitle = "Breaking News: Something Happened",
  subscribedOrUnsubscribed = "subscribed",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  # подальша обробка з resp

updateUserNotificationStatus

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
notificationId	string	Ні
newStatus	string	Ні
sso	string = ""	Ні

Відповідь

Повертає: Option[UpdateUserNotificationStatusResponse]

Приклад

updateUserNotificationStatus Приклад

Copy

let (respOpt, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = ""
)
if respOpt.isSome:
  let status = respOpt.get()

getUserPresenceStatuses

Параметри

Ім'я	Тип	Обов'язковий
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

Відповідь

Повертає: Option[GetUserPresenceStatusesResponse]

Приклад

getUserPresenceStatuses Приклад

Copy

let (presenceOpt, httpResp) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user42")
if presenceOpt.isSome:
  let presence = presenceOpt.get()

searchUsers

Параметри

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

Відповідь

Повертає: Option[SearchUsersResult]

Приклад

searchUsers Приклад

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = SearchUsersOptions()
)
if response.isSome:
  let result = response.get()

getUser

Параметри

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Відповідь

Повертає: Option[GetUserResponse]

Приклад

Приклад getUser

Copy

let (userOpt, httpResp) = client.getUser(tenantId = "my-tenant-123", id = "user-456")
if userOpt.isSome:
  let user = userOpt.get()
  echo user
else:
  echo "User not found"

createVote

Параметри

Назва	Тип	Обов’язково
tenantId	string	Так
commentId	string	Так
direction	string	Ні
options	CreateVoteOptions	Ні

Відповідь

Повертає: Option[VoteResponse]

Приклад

Приклад createVote

Copy

let (voteOpt, httpResp) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "comment-7890",
  direction = "up",
  options = CreateVoteOptions()
)
if voteOpt.isSome:
  let vote = voteOpt.get()
  echo vote

deleteVote

Параметри

Назва	Тип	Обов’язковий
tenantId	string	Так
id	string	Ні
editKey	string = ""	Ні

Відповідь

Повертає: Option[VoteDeleteResponse]

Приклад

Приклад deleteVote

Copy

let (voteRespOpt, httpResp) = client.deleteVote(tenantId = "my-tenant-123", id = "comment-456", editKey = "")
if voteRespOpt.isSome:
  let voteResp = voteRespOpt.get()
  discard voteResp
  discard httpResp

getVotes

Параметри

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

Відповідь

Повертає: Option[GetVotesResponse]

Приклад

getVotes Приклад

Copy

let (optVotes, httpResp) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/article-42")
if optVotes.isSome:
  let votes = optVotes.get()
  discard votes

getVotesForUser

Параметри

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

Відповідь

Повертає: Option[GetVotesForUserResponse]

Приклад

getVotesForUser Приклад

Copy

let (optResp, httpResp) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  options = GetVotesForUserOptions()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

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

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

Участь у проєкті

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

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

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

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

Довідник API

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

Агрегація

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

Аутентифікація

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

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

Коментарі

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

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

Шаблони електронної пошти

Журнал подій

Публікації стрічки

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

Гіфки

Хештеги

Модерація

Модератори

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

Сповіщення

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

Сторінки

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

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

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

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

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

Підписки

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

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

Користувачі орендаря

Орендарі

Тікети

Переклади

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

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

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

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

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

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

Користувачі

Голоси

FastComments Nim SDK

Репозиторій

Вимоги

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

Using Nimble

Building from Source

Library Contents

Public vs Secured APIs

Швидкий старт

Використання автентифікованих API (DefaultAPI)

Використання публічних API (PublicAPI)

Використання модераційних API (ModerationAPI)

Поширені проблеми

Виклики API

Приклад: отримання коментарів

Примітки

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

SSO (Єдиний вхід)

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

Простий SSO

Безпечний SSO

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

Документація для API-ендоинтів

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

aggregate

Параметри

Відповідь

Приклад

getAuditLogs

Параметри

Відповідь

Приклад

logoutPublic

Відповідь

Приклад