FastComments Nim SDK

Это официальный SDK на Nim для FastComments.

Официальный SDK на Nim для API FastComments

Репозиторий

Требования

Nim >= 1.6.0
nimcrypto >= 0.5.4

Установка

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

nimble install fastcomments

Сборка из исходников

nimble build

Содержимое библиотеки

Эта библиотека содержит сгенерированный клиент API и утилиты SSO, упрощающие работу с API.

API Client Library Docs

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

Для клиента API существует три модуля API, api_default, api_public и api_moderation. api_default содержит методы, требующие ваш API‑ключ, а api_public содержит api calls
that can be made directly from a browser/mobile device/etc without authentication. Модуль api_moderation содержит методы для панели модератора.

api_moderation предоставляет обширный набор живых и быстрых API модерации. Каждый метод api_moderation принимает параметр sso и может аутентифицироваться через SSO или cookie сеанса FastComments.com.

Быстрый старт

Using Authenticated APIs (DefaultAPI)

Important: Authenticated endpoints require your API key to be set as the x-api-key header.

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"

# Выполняйте аутентифицированные API вызовы.
# Обязательные параметры (и тело запроса) передаются позиционно; необязательные
# параметры передаются через объект опций операции.
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"

Using Public APIs (PublicAPI)

Public endpoints don't require authentication:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Выполняйте публичные API вызовы.
# tenantId и urlId обязательны (позиционно); всё остальное необязательно.
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"

Using Moderation APIs (ModerationAPI)

Moderation endpoints power the moderator dashboard and are authenticated with an SSO token for the acting moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Получить список комментариев на панели модерации.
# Эта операция не имеет обязательных параметров, поэтому все параметры необязательны.
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"

Common Issues

401 authentication error: Make sure you set the x-api-key header on your HttpClient before making DefaultAPI requests: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Use api_default for server-side authenticated requests, api_public for client-side/public requests, and api_moderation for moderator dashboard requests.

Вызовы API

All 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"

Примечания

Идентификаторы Broadcast

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

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

Все URI являются относительными к https://fastcomments.com

Класс	Метод	HTTP запрос	Описание
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	Массовая информация о пользователях для арендатора. По заданным userIds возвращается отображаемая информация из User / SSOUser. Используется виджетом комментариев для обогащения данных о пользователях, только что появившихся через событие presence. Без контекста страницы: конфиденциальность применяется одинаково (приватные профили маскируются).
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}	Включить или отключить уведомления для конкретного комментария.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Включить или отключить уведомления для страницы. Когда пользователи подписаны на страницу, создаются уведомления о новых корневых комментариях, а также
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Загрузить и изменить размер изображения
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

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

aggregate

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Ответ

Возвращает: Option[AggregateResponse]

Пример

пример агрегирования

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

Параметри

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

Відповідь

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

Параметры

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

Ответ

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

Параметры

Name	Type	Required
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	Так
id	string	Ні
options	FlagCommentOptions	Ні

Відповідь

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

Параметри

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

Відповідь

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

Параметри

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

Параметри

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

Відповідь

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

Приклад

Приклад 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	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

Ответ

Возвращает: 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	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Відповідь

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

Parameters

Name	Type	Required
tenantId	string	Так
createCommentParams	seq[CreateCommentParams]	Ні
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Ні
id	string	Ні
fromName	string	Ні

Response

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

Example

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

Параметры

Имя	Тип	Обязательно
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	Да
commentId	string	Да
broadcastId	string	Нет
sso	string = ""	Нет

Ответ

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

Параметры

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

Ответ

Возвращает: 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	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Ответ

Возвращает: 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	Да
commentId	string	Да
urlId	string	Да
broadcastId	string	Нет
voteBodyParams	VoteBodyParams	Нет
options	VoteCommentOptions	Нет

Ответ

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

Ответ

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

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Response

Возвращает: 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	Да
domain	string	Нет

Ответ

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

Parameters

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

Response

Возвращает: Option[GetDomainConfigResponse]

Example

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

Параметри

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

Відповідь

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

Приклад

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	Да
createEmailTemplateBody	CreateEmailTemplateBody	Нет

Ответ

Возвращает: 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	Yes
id	string	No

Відповідь

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

Параметры

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

Ответ

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

Параметри

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

Відповідь

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

Відповідь

Повертає: 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	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Ответ

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

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Відповідь

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

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
urlId	string	Да
userIdWS	string	Нет
startTime	int64	Нет
endTime	int64	Нет

Ответ

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

Параметри

Назва	Тип	Обов’язково
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Відповідь

Повертає: 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	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

Ответ

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

Параметры

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

Parameters

Name	Type	Required
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

Response

Возвращает: Option[FeedPostsStatsResponse]

Example

Пример 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	Да
options	GetUserReactsPublicOptions	Нет

Ответ

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

Параметри

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

Параметры

Name	Type	Required
tenantId	string	Да
postId	string	Нет
updateFeedPostParams	UpdateFeedPostParams	Нет
options	UpdateFeedPostPublicOptions	Нет

Ответ

Возвращает: 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	Да
largeInternalURLSanitized	string	Нет

Ответ

Возвращает: 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	Yes
search	string	No
options	GetGifsSearchOptions	No

Відповідь

Повертає: 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	Да
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Нет

Ответ

Возвращает: 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	Так
tag	string	Ні
updateHashTagBody	UpdateHashTagBody	Ні

Відповідь

Повертає: 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	Yes
options	GetApiCommentsOptions	No

Ответ

Возвращает: 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	Yes
options	GetApiIdsOptions	No

Відповідь

Повертає: 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	Так
commentId	string	Так
sso	string = ""	Ні

Відповідь

Повертає: 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	Да
sso	string = ""	Нет

Ответ

Возвращает: 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	Yes
sso	string = ""	No

Ответ

Возвращает: 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	Yes
options	GetManualBadgesForUserOptions	No

Відповідь

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

Параметри

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

Параметры

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

Параметры

Name	Type	Required
tenantId	string	Да
commentId	string	Да
options	GetPreBanSummaryOptions	Ні

Ответ

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

Parameters

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

Response

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

Example

Приклад getSearchCommentsSummary

Copy

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

getSearchPages

Параметры

Name	Type	Required	Description
tenantId	string	Yes
options	GetSearchPagesOptions	No

Ответ

Возвращает: 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	Yes
options	GetSearchSuggestOptions	No

Ответ

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

Параметры

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

Ответ

Возвращает: 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	Yes
sso	string = ""	No

Ответ

Возвращает: 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	Да
commentId	string	Да
options	PostBanUserFromCommentOptions	Нет

Ответ

Возвращает: 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	Так
banUserUndoParams	BanUserUndoParams	Ні
sso	string = ""	Ні

Відповідь

Повертає: 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	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Відповідь

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

Параметри

Name	Type	Required
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	Yes
commentId	string	Yes
options	PostFlagCommentOptions	No

Ответ

Возвращает: 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	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Ответ

Возвращает: 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	Yes
commentId	string	Yes
options	PostRestoreDeletedCommentOptions	No

Ответ

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

Параметры

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

Ответ

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

Параметри

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

Відповідь

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

Параметры

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

Ответ

Возвращает: 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	Yes
badgeId	string	No
options	PutRemoveBadgeOptions	No

Відповідь

Повертає: 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	Yes
urlId	string	Yes
sso	string = ""	No

Відповідь

Returns: 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	Yes
options	SetTrustFactorOptions	No

Ответ

Возвращает: 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	Yes
id	string	No
sendEmail	string = ""	No

Ответ

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

Параметры

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Ответ

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

Ответ

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

Параметри

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Відповідь

Возвращает: 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	Yes
urlId	string	Yes

Відповідь

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

Параметры

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

Ответ

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

Параметри

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

Відповідь

Returns: 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	Yes
urlId	string	Yes
id	string	No

Ответ

Возвращает: 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	Да
createAPIPageData	CreateAPIPageData	Нет

Ответ

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

Параметры

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

Ответ

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

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

Parameters

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

Response

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

Текущие онлайн‑просмотрщики страницы: люди, чья websocket‑сессия сейчас подписана на страницу.
Возвращает anonCount + totalCount (подписчики по всей комнате, включая анонимных зрителей, которых мы не перечисляем).

Параметры

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

Ответ

Возвращает: Option[PageUsersOnlineResponse]

Пример

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

Параметры

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Ответ

Returns: 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	Yes

Ответ

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

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

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

Parameters

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	Да
id	string	Нет
updateAPIPageData	UpdateAPIPageData	Нет

Ответ

Возвращает: 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	Yes
id	string	No

Ответ

Возвращает: 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	Yes
options	GetPendingWebhookEventCountOptions	No

Відповідь

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

Параметры

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

Ответ

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

Параметри

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

Відповідь

Повертає: 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	Да
skip	float64	Нет

Ответ

Возвращает: 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	Да
id	string	Нет
updateQuestionConfigBody	UpdateQuestionConfigBody	Нет

Ответ

Возвращает: 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	Так
options	GetQuestionResultsOptions	Ні

Відповідь

Повертає: 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	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Відповідь

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

Параметры

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

Параметри

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

Відповідь

Повертає: 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	Так
createAPISSOUserData	CreateAPISSOUserData	Ні

Відповідь

Повертає: 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	Yes
id	string	No
options	DeleteSSOUserOptions	No

Ответ

Возвращает: 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	Да
id	string	Нет

Ответ

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

Параметри

Name	Type	Required	Description
tenantId	string	Yes
skip	int	No

Відповідь

Возвращает: 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	Да
id	string	Нет
updateAPISSOUserData	UpdateAPISSOUserData	Нет
updateComments	bool	Нет

Ответ

Возвращает: 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	Yes
id	string	No
userId	string = ""	No

Ответ

Возвращает: 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	Yes
userId	string = ""	No

Відповідь

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

Параметры

Name	Type	Required	Description
tenantId	string	Yes
options	GetTenantDailyUsagesOptions	No

Ответ

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

Параметри

Name	Type	Required	Description
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	Yes
id	string	No

Ответ

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

Параметри

Назва	Тип	Обов’язковий	Опис
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	Yes
createTenantUserBody	CreateTenantUserBody	No

Відповідь

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

Параметри

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

Відповідь

Возвращает: 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	Да
id	string	Нет

Ответ

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

Параметри

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

Відповідь

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

Параметры

Name	Type	Required
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Ответ

Возвращает: 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	Yes
id	string	No
redirectURL	string = ""	No

Ответ

Возвращает: 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	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Відповідь

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

Параметри

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

Відповідь

Повертає: 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 = ""	Нет

Ответ

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

Параметри

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

Відповідь

Повертає: 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	Yes
userId	string	No
createTicketBody	CreateTicketBody	No

Ответ

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

Параметри

Name	Type	Required	Description
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()
  # использовать билеты по мере необходимости

getTranslations

Параметри

Назва	Тип	Обов’язково
namespace	string	No
component	string	No
options	GetTranslationsOptions	No

Відповідь

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

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

Параметри

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

Відповідь

Повертає: 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()
  # використати результат за потреби

getUserBadgeProgressById

Параметры

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Ответ

Возвращает: 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	Да
options	GetUserBadgeProgressListOptions	Нет

Ответ

Возвращаемое значение: 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	Yes
id	string	No

Ответ

Возвращает: 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	Yes
options	GetUserBadgesOptions	No

Ответ

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

Параметры

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

Параметри

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

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	ResetUserNotificationsOptions	No

Відповідь

Возвращает: Option[ResetUserNotificationsResponse]

Приклад

resetUserNotifications Пример

Copy

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

updateUserNotificationCommentSubscriptionStatus

Включить или отключить уведомления для конкретного комментария.

Параметры

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

Ответ

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

Параметри

Name	Type	Required
tenantId	string	Так
urlIdWS	string	Ні
userIds	string	Ні

Відповідь

Повертає: 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	Да
urlId	string	Да
options	SearchUsersOptions	Нет

Ответ

Возвращает: 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	Да
id	string	Нет

Ответ

Возвращает: 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	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Ответ

Возвращает: 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	Yes
id	string	No
editKey	string = ""	No

Ответ

Возвращает: 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	Yes
urlId	string	Yes
options	GetVotesForUserOptions	No

Ответ

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

Репозиторий

Требования

Установка

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

Сборка из исходников

Содержимое библиотеки

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

Быстрый старт

Using Authenticated APIs (DefaultAPI)

Using Public APIs (PublicAPI)

Using Moderation APIs (ModerationAPI)

Common Issues

Вызовы API

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

Примечания

Идентификаторы Broadcast

SSO (единого входа)

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

Простой SSO

Защищённый SSO

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

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

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

aggregate

Параметры

Ответ

Пример

getAuditLogs

Параметри

Відповідь

Приклад

logoutPublic

Ответ

Пример