FastComments SDK для Nim

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

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

Репозиторий

Требования

Nim >= 1.6.0
nimcrypto >= 0.5.4

Установка

Using Nimble

nimble install fastcomments

Building from Source

nimble build

Library Contents

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

API Client Library Docs

Public vs Secured APIs

Для клиента API существуют три модуля API, api_default, api_public и api_moderation. api_default содержит методы, требующие ваш API‑ключ, а api_public содержит вызовы API которые можно выполнять напрямую из браузера/мобильного устройства и т.д. без аутентификации. Модуль api_moderation содержит методы для панели модератора.

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

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

Using Authenticated APIs (DefaultAPI)

Важно: Аутентифицированные конечные точки требуют, чтобы ваш API‑ключ был установлен в заголовке x-api-key.

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

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

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

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

Using Public APIs (PublicAPI)

Public endpoints don't require authentication:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

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

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

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

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

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

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

Все методы 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"

Примечания

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

Вы увидите, что в некоторых вызовах 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‑конечных точек

All URIs are relative to 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 для отображения раздела "Members". Пагинация курсором по commenterName: сервер проходит частичный индекс {tenantId, urlId, commenterName} от afterName вперёд через $gt, без стоимости $skip.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Текущие онлайн зрители страницы: люди, чья websocket‑сессия подписана на страницу прямо сейчас. Возвращает anonCount + totalCount (подписчики по всей комнате, включая анонимных зрителей, которых мы не перечисляем).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Список страниц для арендатора. Используется десктоп‑клиентом FChat для заполнения списка комнат. Требует, чтобы `enableFChat` был true в разрешённой пользовательской конфигурации для каждой страницы. Страницы, требующие SSO, фильтруются в соответствии с групповым доступом запрашивающего пользователя.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Включить или отключить уведомления для конкретного комментария.
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

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

Параметры

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

Ответ

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

Пример

aggregate Пример

Copy

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

getAuditLogs

Параметры

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

Ответ

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

Ответ

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

Параметры

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

Параметры

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

Ответ

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

Ответ

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

Пример

Пример getComments

Copy

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

getCommentsPublic

req tenantId urlId

Параметры

Name	Type	Required
tenantId	string	Да
urlId	string	Да
options	GetCommentsPublicOptions	Нет

Ответ

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

Ответ

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

Параметры

Name	Type	Required
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	Yes
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

Ответ

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

Пример

Пример saveComment

Copy

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

saveCommentsBulk

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
createCommentParams	seq[CreateCommentParams]	Нет
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Нет
id	string	Нет
fromName	string	Нет

Ответ

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

Пример

Пример saveCommentsBulk

Copy

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

setCommentText

Параметры

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

Ответ

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

Пример

Пример setCommentText

Copy

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

unBlockUserFromComment

Параметры

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

Ответ

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

Пример

Пример unFlagComment

Copy

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

unLockComment

Параметры

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

Ответ

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

Ответ

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

Пример

Пример unPinComment

Copy

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

updateComment

Параметры

Имя	Тип	Обязательно
tenantId	string	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	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

Ответ

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

Пример

voteComment Пример

Copy

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

getCommentsForUser

Parameters

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

Параметры

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

Ответ

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

Пример

addDomainConfig Пример

Copy

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

deleteDomainConfig

Параметры

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

Ответ

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

Пример

Пример deleteDomainConfig

Copy

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

getDomainConfig

Параметры

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

Ответ

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

Пример

Пример getDomainConfig

Copy

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

getDomainConfigs

Параметры

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

Ответ

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

Пример

getDomainConfigs Пример

Copy

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

patchDomainConfig

Параметры

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Ответ

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

Параметры

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

Ответ

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

Parameters

Name	Type	Required	Description
tenantId	string	Да
id	string	Нет

Response

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

Ответ

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

Пример

Пример getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parameters

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

Response

Возвращает: 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	Да
renderEmailTemplateBody	RenderEmailTemplateBody	Нет
locale	string = ""	Нет

Ответ

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

Пример

Пример renderEmailTemplate

Copy

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

updateEmailTemplate

Параметры

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

Ответ

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

Пример

updateEmailTemplate Пример

Copy

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

getEventLog

req tenantId urlId userIdWS

Параметры

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

Ответ

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

Пример

Пример getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Параметры

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

Ответ

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

Ответ

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

Пример

Пример createFeedPost

Copy

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

createFeedPostPublic

Параметры

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

Ответ

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

Пример

Пример createFeedPostPublic

Copy

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

deleteFeedPostPublic

Параметры

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

Ответ

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

Пример

Пример deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Параметры

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

Ответ

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

Пример

Пример getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Параметры

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

Ответ

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

Пример

Пример getFeedPostsPublic

Copy

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

getFeedPostsStats

Параметры

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

Ответ

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

Пример

Пример getFeedPostsStats

Copy

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

getUserReactsPublic

Параметры

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserReactsPublicOptions	No

Ответ

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

Пример

Пример getUserReactsPublic

Copy

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

reactFeedPostPublic

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
postId	string	Нет
reactBodyParams	ReactBodyParams	Нет
options	ReactFeedPostPublicOptions	Нет

Ответ

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

Пример

Пример reactFeedPostPublic

Copy

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

updateFeedPost

Параметры

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

Ответ

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

Пример

updateFeedPost Пример

Copy

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

updateFeedPostPublic

Параметры

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

Ответ

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

Ответ

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

Пример

Пример getGifsSearch

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # использовать resp по необходимости

getGifsTrending

Параметры

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

Ответ

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

Ответ

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

Пример

Пример getHashTags

Copy

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

patchHashTag

Параметры

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

Ответ

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

Пример

patchHashTag Пример

Copy

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

deleteModerationVote

Параметры

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

Ответ

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

Пример

Пример deleteModerationVote

Copy

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

getApiComments

Параметры

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

Ответ

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

Пример

Пример getApiComments

Copy

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

getApiExportStatus

Параметры

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

Ответ

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

Пример

Пример getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # использовать exportStatus по необходимости

getApiIds

Параметры

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

Ответ

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

Пример

Пример getApiIds

Copy

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

getBanUsersFromComment

Параметры

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

Ответ

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

Параметры

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

Ответ

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

Ответ

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

Ответ

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

Пример

Пример getLogs

Copy

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

getManualBadges

Параметры

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

Ответ

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

Пример

Пример getManualBadges

Copy

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

getManualBadgesForUser

Параметры

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

Параметры

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

Ответ

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

Пример

Пример getModerationComment

Copy

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

getModerationCommentText

Параметры

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

Ответ

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

Пример

Пример getModerationCommentText

Copy

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

getPreBanSummary

Параметры

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

Параметры

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

Ответ

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

Пример

Пример getSearchCommentsSummary

Copy

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

getSearchPages

Параметры

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

Ответ

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

Пример

Пример getSearchPages

Copy

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

getSearchSites

Параметры

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

Ответ

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

Пример

getSearchSites Пример

Copy

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

getSearchSuggest

Параметры

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

Ответ

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

Пример

Пример getSearchSuggest

Copy

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

getSearchUsers

Параметры

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

Ответ

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

Ответ

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

Пример

Пример getUserBanPreference

Copy

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

getUserInternalProfile

Параметры

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

Ответ

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

Пример

Пример getUserInternalProfile

Copy

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

postAdjustCommentVotes

Параметры

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

Ответ

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

Пример

postAdjustCommentVotes Пример

Copy

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

postApiExport

Параметры

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

Ответ

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

Параметры

Name	Type	Required
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Ответ

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

Пример

postBulkPreBanSummary Пример

Copy

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

postCommentsByIds

Параметры

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

Ответ

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

Пример

Пример postCommentsByIds

Copy

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

postFlagComment

Параметры

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

Ответ

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

Пример

postRemoveComment Пример

Copy

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

postRestoreDeletedComment

Параметры

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

Ответ

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

Пример

Пример postRestoreDeletedComment

Copy

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

postSetCommentApprovalStatus

Параметры

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

Ответ

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

Пример

postSetCommentApprovalStatus Пример

Copy

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

postSetCommentReviewStatus

Параметры

Имя	Тип	Обязательно
tenantId	string	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	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

Ответ

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

Ответ

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

Ответ

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

Пример

Пример putCloseThread

Copy

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

putRemoveBadge

Параметры

Name	Type	Required
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	Да
urlId	string	Да
sso	string = ""	Нет

Ответ

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

Пример

putReopenThread Пример

Copy

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

setTrustFactor

Параметры

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

Ответ

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

Пример

setTrustFactor Пример

Copy

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

createModerator

Параметры

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

Ответ

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

Пример

Пример createModerator

Copy

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

deleteModerator

Параметры

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

Ответ

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

Пример

deleteModerator Пример

Copy

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

getModerator

Параметры

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

Ответ

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

Параметры

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

Ответ

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

Пример

Пример getNotifications

Copy

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

updateNotification

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
id	string	Нет
updateNotificationBody	UpdateNotificationBody	Нет
userId	string = ""	Нет

Ответ

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

Ответ

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

Пример

Пример createV1PageReact

Copy

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

createV2PageReact

Параметры

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

Ответ

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

Пример

createV2PageReact Пример

Copy

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

deleteV1PageReact

Параметры

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

Ответ

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

Пример

deleteV1PageReact Пример

Copy

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

deleteV2PageReact

Parameters

Name	Type	Required
tenantId	string	Да
urlId	string	Да
id	string	Нет

Response

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

Example

Пример deleteV2PageReact

Copy

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

getV1PageLikes

Параметры

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

Ответ

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

Пример

Пример getV1PageLikes

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # использовать pageLikes по необходимости

getV2PageReacts

Параметры

Name	Type	Required	Description
tenantId	string	Да
urlId	string	Да

Ответ

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

Пример

Пример getV2PageReacts

Copy

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

getV2PageReactUsers

Параметры

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

Ответ

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

Пример

Пример getV2PageReactUsers

Copy

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

addPage

Параметры

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

Ответ

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

Пример

Пример addPage

Copy

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

deletePage

Параметры

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

Ответ

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

Пример

Пример deletePage

Copy

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

getOfflineUsers

Past commenters on the page who are NOT currently online. Sorted by displayName.
Russian: Прошлые комментаторы на странице, которые НЕ находятся в сети в данный момент. Отсортированы по displayName.

Use this after exhausting /users/online to render a "Members" section.
Russian: Используйте это после исчерпания /users/online для отображения раздела "Members".

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Russian: Курсорная пагинация по commenterName: сервер проходит частичный {tenantId, urlId, commenterName} индекс от afterName вперёд через $gt, без затрат на $skip.

Parameters

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

Response

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

Example

Пример getOfflineUsers

Copy

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

getOnlineUsers

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

Parameters

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

Response

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

Example

Пример getOnlineUsers

Copy

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

getPageByURLId

Параметры

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

Ответ

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

Пример

getPageByURLId Пример

Copy

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

getPages

Параметры

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

Ответ

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

Пример

Пример getPages

Copy

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

getPagesPublic

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

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetPagesPublicOptions	No

Response

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

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

Параметры

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Ответ

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

Пример

Пример getUsersInfo

Copy

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

patchPage

Параметры

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Ответ

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

Пример

patchPage Пример

Copy

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

deletePendingWebhookEvent

Параметры

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

Ответ

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

Пример

Пример deletePendingWebhookEvent

Copy

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

getPendingWebhookEventCount

Параметры

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

Ответ

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

Пример

Пример getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Параметры

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

Ответ

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

Параметры

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

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	No

Response

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

Example

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

Параметры

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

Параметры

Name	Type	Required
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	Да
id	string	Нет
userId	string = ""	Нет

Ответ

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

Пример

Пример deleteSubscription

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # использовать apiResult по мере необходимости

getSubscriptions

Параметры

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

Ответ

Returns: Option[UpdateSubscriptionAPIResponse]

Пример

Пример updateSubscription

Copy

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

getTenantDailyUsages

Параметры

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

Ответ

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

Параметры

Name	Type	Required	Описание
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	Да
skip	float64	Нет

Ответ

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

Ответ

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

Пример

replaceTenantPackage Пример

Copy

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

updateTenantPackage

Параметры

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

Ответ

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

Пример

Пример updateTenantPackage

Copy

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

createTenantUser

Параметры

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

Ответ

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

Пример

Пример createTenantUser

Copy

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

deleteTenantUser

Параметры

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

Ответ

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

Пример

Пример deleteTenantUser

Copy

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

getTenantUser

Параметры

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

Ответ

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

Пример

Пример getTenantUser

Copy

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

getTenantUsers

Параметры

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

Ответ

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

Пример

Пример getTenantUsers

Copy

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

replaceTenantUser

Параметры

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

Ответ

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

Пример

Пример sendLoginLink

Copy

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

updateTenantUser

Параметры

Name	Type	Required
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 = ""	Нет

Ответ

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

Ответ

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

Ответ

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

Параметры

Name	Type	Required
tenantId	string	Да
id	string	Нет
userId	string = ""	Нет

Ответ

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

Пример

Пример getTicket

Copy

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

getTickets

Параметры

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

Ответ

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

Ответ

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

Пример

uploadImage Пример

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # использовать результат по мере необходимости

getUserBadgeProgressById

Параметры

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

Ответ

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

Пример

Пример getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Параметры

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

Ответ

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

Параметры

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserBadgeProgressListOptions	No

Ответ

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

Пример

getUserBadgeProgressList Пример

Copy

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

createUserBadge

Параметры

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

Ответ

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

Пример

createUserBadge Пример

Copy

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

deleteUserBadge

Параметры

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

Ответ

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

Пример

deleteUserBadge Пример

Copy

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

getUserBadge

Параметры

Name	Type	Обязательно	Описание
tenantId	string	Да
id	string	Нет

Ответ

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

Пример

getUserBadge Пример

Copy

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

getUserBadges

Параметры

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

Ответ

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

Пример

Пример getUserBadges

Copy

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

updateUserBadge

Параметры

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

Ответ

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

Ответ

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

Пример

getUserNotificationCount Пример

Copy

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

getUserNotifications

Параметры

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

Ответ

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

Пример

Пример getUserNotifications

Copy

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

resetUserNotificationCount

Параметры

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

Ответ

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

Параметры

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

Ответ

Returns: Option[ResetUserNotificationsResponse]

Пример

Пример resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Параметры

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

Параметры

Name	Type	Required
tenantId	string	Yes
notificationId	string	No
newStatus	string	No
sso	string = ""	No

Ответ

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

Пример

Пример updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Параметры

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

Ответ

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

Пример

Пример getUserPresenceStatuses

Copy

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

searchUsers

Параметры

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

Ответ

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

Пример

Пример searchUsers

Copy

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

getUser

Параметры

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

Ответ

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

Пример

getUser Пример

Copy

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

createVote

Параметры

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

Ответ

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

Параметры

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

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

Агрегация

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

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

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

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

Комментарии

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

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

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

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

Посты ленты

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

GIF

Хэштеги

Модерация

Модераторы

Счетчик уведомлений

Уведомления

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

Страницы

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

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

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

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

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

Подписки

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

Пакеты арендатора

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

Арендаторы

Тикеты

Переводы

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

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

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

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

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

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

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

Голоса

FastComments SDK для Nim

Репозиторий

Требования

Установка

Using Nimble

Building from Source

Library Contents

Public vs Secured APIs

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

Using Authenticated APIs (DefaultAPI)

Using Public APIs (PublicAPI)

Using Moderation APIs (ModerationAPI)

Common Issues

Вызовы API

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

Примечания

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

SSO (Единый вход)

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

Простой SSO

Безопасный SSO

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

Документация для API‑конечных точек

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

aggregate

Параметры

Ответ

Пример

getAuditLogs

Параметры

Ответ

Пример

logoutPublic

Ответ

Пример