FastComments Nim SDK

Това е официалният Nim SDK за FastComments.

Официален Nim SDK за API на FastComments

Репозитория

AI кодиращи агенти

Дайте на вашия кодиращ агент контекста на FastComments, който му е необходим - уиджети, конфигурация, Secure SSO, REST API и SDK‑те:

npx skills add fastcomments/skills

Работи с Claude Code, Codex, Cursor, Copilot, Gemini и всеки друг агент, който поддържа skills CLI поддръжка.

Изисквания

Nim >= 1.6.0
nimcrypto >= 0.5.4

Инсталация

Използване на Nimble

nimble install fastcomments

Компилиране от източник

nimble build

Съдържание на библиотеката

Тази библиотека съдържа генерирания API клиент и SSO помощните инструменти, които улесняват работата с API-то.

Документация за клиентската библиотека на API

Публични срещу защитени API

За клиентския API има три модула, api_default, api_public и api_moderation. api_default съдържа методи, които изискват вашия API ключ, а api_public съдържа API повиквания, които могат да се направят директно от браузър/мобилно устройство/и т.н. без удостоверяване. Модулът api_moderation съдържа методи за таблото на модератора.

api_moderation модулът предоставя обширен набор от живи и бързи API за модериране. Всеки метод от api_moderation приема параметър sso и може да се автентифицира чрез SSO или сесийна бисквитка на 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)

Публичните крайни точки не изискват удостоверяване:

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)

Крайните точки за модериране захранват таблото на модератора и са удостоверени със SSO токен за действащия модератор:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

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

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

Common Issues

401 грешка при удостоверяване: Уверете се, че сте задали заглавката x-api-key на вашия HttpClient преди да правите заявки към DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Грешен API клас: Използвайте api_default за сървърни удостоверени заявки, api_public за клиентски/публични заявки и api_moderation за заявки към таблото на модератора.

Извършване на API заявки

Всички API методи в този SDK връщат кортежи от (Option[ResponseType], Response). Първият елемент съдържа парснатия отговор, ако е успешен, а вторият елемент е суровият HTTP отговор.

Задължителните параметри и тялото на заявката се предават позиционно. Останалите незадължителни параметри се събират в един единствен обект Api<Operation>Options, който е последният аргумент. Операциите без незадължителни параметри не използват обект за опции.

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

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

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

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

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

Бележки

Идентификатори на предаване

Ще видите, че трябва да предадете broadcastId в някои API извиквания. Когато получите събития, ще получите обратно това 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

Documentation for API Endpoints

All URIs are relative to https://fastcomments.com

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
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	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	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.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

агрегиране

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
aggregationRequest	AggregationRequest	Не
options	AggregateOptions	Не

Отговор

Връща: Option[AggregateResponse]

Пример

Пример за агрегиране

Copy

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

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

Parameters

Име	Тип	Задължително	Описание
tenantId	string	Да
options	GetAuditLogsOptions	Не

Response

Връща: Option[GetAuditLogsResponse]

Example

Пример getAuditLogs

Copy

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

Изход публичен

Отговор

Връща: Option[APIEmptyResponse]

Пример

logoutPublic Пример

Copy

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

Блокиране от коментар (публично)

Параметри

Име	Тип	Задължително
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()

Отблокиране на коментар (публично)

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително
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

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

Параметри

Име	Тип	Задължително
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

Създаване на коментар (публично)

Параметри

Име	Тип	Задължително
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

Изтриване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Отговор

Връща: Option[DeleteCommentResult]

Пример

deleteComment Пример

Copy

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

Изтриване на коментар (публично)

Параметри

Име	Тип	Задължително
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

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

Параметри

Име	Тип	Задължително
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()

Маркиране на коментар

Параметри

Име	Тип	Задължително
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

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

Параметри

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Отговор

Връща: Option[APIGetCommentResponse]

Пример

getComment Пример

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
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

Получаване на коментари (публично)

req
tenantId
urlId

Параметри

Име	Тип	Задължително
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

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

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
dir	int	Не
sso	string = ""	Не

Отговор

Връща: Option[GetCommentVoteUserNamesSuccessResponse]

Пример

getCommentVoteUserNames Пример

Copy

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

Заключване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Не
sso	string = ""	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

lockComment Пример

Copy

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

Закачане на коментар

Parameters

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

Response

Връща: Option[ChangeCommentPinStatusResponse]

Example

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

Записване на коментар

Параметри

Име	Тип	Задължително
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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Отговор

Връща: 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()

Задаване на текст на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Не
commentTextUpdateRequest	CommentTextUpdateRequest	Не
options	SetCommentTextOptions	Не

Отговор

Връща: 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()

Отблокиране на потребител от коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
unBlockFromCommentParams	UnBlockFromCommentParams	Не
options	UnBlockUserFromCommentOptions	Не

Отговор

Връща: 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()

Премахване на маркиране на коментар

Параметри

Име	Тип	Задължително
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()

Отключване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Не
sso	string = ""	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

unLockComment пример

Copy

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

Откачане на коментар

Параметри

Име	Тип	Задължително
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

Обновяване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
updatableCommentParams	UpdatableCommentParams	Не
options	UpdateCommentOptions	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

updateComment Пример

Copy

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

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

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително	Описание
options	GetCommentsForUserOptions	No

Отговор

Връща: Option[GetCommentsForUserResponse]

Пример

Пример за getCommentsForUser

Copy

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

Добавяне на конфигурация на домейн

Параметри

Име	Тип	Задължително	Описание
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()

Изтриване на конфигурация на домейн

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
domain	string	Не

Отговор

Връща: Option[DeleteDomainConfigResponse]

Пример

deleteDomainConfig Пример

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да

Отговор

Връща: Option[GetDomainConfigsResponse]

Пример

Пример за getDomainConfigs

Copy

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

Пачване на конфигурация на домейн

Параметри

Име	Тип	Задължително
tenantId	string	Да
domainToUpdate	string	Не
patchDomainConfigParams	PatchDomainConfigParams	Не

Отговор

Връща: Option[PatchDomainConfigResponse]

Пример

Пример за patchDomainConfig

Copy

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

Задаване на конфигурация на домейн

Параметри

Име	Тип	Задължително
tenantId	string	Да
domainToUpdate	string	Не
updateDomainConfigParams	UpdateDomainConfigParams	Не

Отговор

Връща: 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

Създаване на имейл шаблон

Параметри

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

Изтриване на имейл шаблон

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

deleteEmailTemplate Пример

Copy

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

Изтриване на грешка при рендериране на имейл шаблон

Параметри

Име	Тип	Задължително
tenantId	string	Yes
id	string	No
errorId	string	No

Отговор

Връща: Option[APIEmptyResponse]

Пример

Пример за deleteEmailTemplateRenderError

Copy

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

Получаване на имейл шаблон

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Не

Отговор

Връща: Option[GetEmailTemplateResponse]

Пример

getEmailTemplate Пример

Copy

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

Получаване на дефиниции на имейл шаблони

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes

Отговор

Връща: Option[GetEmailTemplateDefinitionsResponse]

Пример

getEmailTemplateDefinitions Пример

Copy

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

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
skip	float64	Не

Отговор

Връща: Option[GetEmailTemplateRenderErrorsResponse]

Пример

getEmailTemplateRenderErrors Пример

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # използвайте resp както е необходимо
else:
  # обработете липсващия отговор
  discard

Получаване на имейл шаблони

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	float64	Не

Отговор

Връща: 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

Рендериране на имейл шаблон

Параметри

Име	Тип	Задължително
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

Обновяване на имейл шаблон

Параметри

Име	Тип	Задължително
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()

Получаване на журнал на събития

req tenantId urlId userIdWS

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
userIdWS	string	Не
startTime	int64	Не
endTime	int64	Не

Отговор

Връща: Option[GetEventLogResponse]

Пример

getEventLog Пример

Copy

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

Получаване на глобален журнал на събития

req tenantId urlId userIdWS

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
userIdWS	string	Не
startTime	int64	Не
endTime	int64	Не

Отговор

Връща: Option[GetEventLogResponse]

Пример

Пример за getGlobalEventLog

Copy

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

Създаване на публикация във фийд

Параметри

Име	Тип	Задължително
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Отговор

Връща: Option[CreateFeedPostsResponse]

Пример

createFeedPost Пример

Copy

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

Създаване на публична публикация във фийд

Параметри

Име	Тип	Задължително
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

Отговор

Връща: Option[CreateFeedPostResponse]

Пример

createFeedPostPublic Пример

Copy

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

Изтриване на публична публикация във фийд

Параметри

Име	Тип	Задължителен
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()

Получаване на публикации във фийд

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

Получаване на публични публикации във фийд

req tenantId afterId

Параметри

Name	Type	Required	Description
tenantId	string	Да
options	GetFeedPostsPublicOptions	Не

Отговор

Връща: Option[PublicFeedPostsResponse]

Пример

Пример за getFeedPostsPublic

Copy

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

Получаване на статистика за публикации във фийд

Параметри

Име	Тип	Задължително
tenantId	string	Да
postIds	seq[string]	Не
sso	string = ""	Не

Отговор

Връща: Option[FeedPostsStatsResponse]

Пример

getFeedPostsStats Пример

Copy

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

Получаване на публични реакции на потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
options	GetUserReactsPublicOptions	Не

Отговор

Връща: Option[UserReactsResponse]

Пример

Пример за getUserReactsPublic

Copy

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

Реагиране публично на публикация във фийд

Параметри

Име	Тип	Задължително
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

Обновяване на публикация във фийд

Параметри

Име	Тип	Задължителен
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Отговор

Връща: Option[APIEmptyResponse]

Пример

updateFeedPost пример

Copy

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

Обновяване на публична публикация във фийд

Параметри

Име	Тип	Задължително
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Отговор

Връща: Option[CreateFeedPostResponse]

Пример

Пример за updateFeedPostPublic

Copy

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

Маркиране на коментар (публично)

Параметри

Име	Тип	Задължително
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

Получаване на голям GIF

Параметри

Име	Тип	Задължително	Описание
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

Търсене на GIF

Параметри

Име	Тип	Задължително
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, както е необходимо

Параметри

Име	Тип	Задължително	Описание
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

Добавяне на хаштаг

Параметри

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

Масово добавяне на хаштагове

Параметри

Name	Type	Required	Description
tenantId	string	Да
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Не

Отговор

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

Изтриване на хаштаг

Parameters

Име	Тип	Задължително
tenantId	string	Да
tag	string	Не
deleteHashTagRequestBody	DeleteHashTagRequestBody	Не

Response

Връща: Option[APIEmptyResponse]

Пример

Пример за deleteHashTag

Copy

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

Получаване на хаштагове

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
page	float64	Не

Отговор

Връща: Option[GetHashTagsResponse]

Пример

Пример за getHashTags

Copy

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

Пачване на хаштаг

Параметри

Име	Тип	Задължително
tenantId	string	Yes
tag	string	No
updateHashTagBody	UpdateHashTagBody	No

Отговор

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

Изтриване на модерационен глас

Параметри

Име	Тип	Задължително
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()

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

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	GetApiCommentsOptions	No

Отговор

Връща: Option[ModerationAPIGetCommentsResponse]

Пример

getApiComments Пример

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # further processing can be done with `resp`

Получаване на статус на API експортиране

Параметри

Име	Тип	Задължително	Описание
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 при нужда

Получаване на API ID-та

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
options	GetApiIdsOptions	No

Отговор

Връща: Option[ModerationAPIGetCommentIdsResponse]

Пример

getApiIds Пример

Copy

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

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

Параметри

Име	Тип	Задължително
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

Получаване на статус на забрана за коментар

Параметри

Име	Тип	Задължително
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

Получаване на дъщерни коментари

Parameters

Name	Type	Required
tenantId	string	Да
commentId	string	Да
sso	string = ""	Не

Response

Връща: Option[ModerationAPIChildCommentsResponse]

Example

Пример за getCommentChildren

Copy

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

Получаване на брой

Параметри

Име	Тип	Задължителен	Описание
tenantId	string	Да
options	GetCountOptions	Не

Отговор

Връща: Option[ModerationAPICountCommentsResponse]

Пример

Пример за getCount

Copy

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

Получаване на броя

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
sso	string = ""	No

Отговор

Връща: Option[GetBannedUsersCountResponse]

Пример

getCounts Пример

Copy

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

Получаване на журнали

Параметри

Име	Тип	Задължително
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

Получаване на ръчни значки

Параметри

Име	Тип	Задължително	Описание
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

Получаване на ръчни значки за потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
options	GetManualBadgesForUserOptions	Не

Отговор

Връща: Option[GetUserManualBadgesResponse]

Пример

Пример за getManualBadgesForUser

Copy

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

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

Параметри

Име	Тип	Задължително
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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Отговор

Връща: Option[GetCommentTextResponse]

Пример

getModerationCommentText Пример

Copy

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

Получаване на резюме преди забрана

Параметри

Име	Тип	Задължително
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()

Получаване на резюме за търсене на коментари

Параметри

Име	Тип	Задължително	Описание
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

Получаване на страници за търсене

Параметри

Име	Тип	Задължително	Описание
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()

Получаване на сайтове за търсене

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
options	GetSearchSitesOptions	No

Отговор

Връща: Option[ModerationSiteSearchResponse]

Пример

Пример за getSearchSites

Copy

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

---

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

Параметри

Име	Тип	Задължително	Описание
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

Получаване на потребители за търсене

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
options	GetSearchUsersOptions	Не

Отговор

Връща: Option[ModerationUserSearchResponse]

Пример

Пример за getSearchUsers

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
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

Получаване на вътрешен профил на потребител

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

Отговор

Връща: Option[GetUserInternalProfileResponse]

Пример

getUserInternalProfile Пример

Copy

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

Публикуване за корекция на гласове по коментари

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

Отговор

Връща: 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()

Публикуване на API експортиране

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
options	PostApiExportOptions	Не

Отговор

Връща: Option[ModerationExportResponse]

Пример

postApiExport Пример

Copy

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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
options	PostBanUserFromCommentOptions	No

Отговор

Връща: 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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
banUserUndoParams	BanUserUndoParams	No
sso	string = ""	No

Отговор

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

Публикуване на масово резюме преди забрана

Параметри

Name	Type	Required
tenantId	string	Да
bulkPreBanParams	BulkPreBanParams	Не
options	PostBulkPreBanSummaryOptions	Не

Отговор

Връща: Option[BulkPreBanSummary]

Пример

postBulkPreBanSummary Пример

Copy

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

Публикуване на коментари по ID

Параметри

Име	Тип	Задължително
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 по необходимост

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
options	PostFlagCommentOptions	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

postFlagComment пример

Copy

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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Отговор

Връща: Option[PostRemoveCommentApiResponse]

Пример

postRemoveComment Пример

Copy

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

Публикуване за възстановяване на изтрит коментар

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
options	PostRestoreDeletedCommentOptions	No

Отговор

Връща: Option[APIEmptyResponse]

Пример

postRestoreDeletedComment Пример

Copy

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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentApprovalStatusOptions	No

Отговор

Връща: 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

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
options	PostSetCommentReviewStatusOptions	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

postSetCommentReviewStatus Пример

Copy

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

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

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително
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()

Публикуване на глас

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
options	PostVoteOptions	Не

Отговор

Връща: 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()

Задаване на наградна значка

Параметри

Име	Тип	Задължителен
tenantId	string	Да
badgeId	string	Не
options	PutAwardBadgeOptions	Не

Отговор

Връща: Option[AwardUserBadgeResponse]

Пример

putAwardBadge Пример

Copy

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

Затваряне на нишка

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
sso	string = ""	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

Пример за putCloseThread

Copy

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

Премахване на значка

Параметри

Име	Тип	Задължително
tenantId	string	Да
badgeId	string	Не
options	PutRemoveBadgeOptions	Не

Отговор

Връща: Option[RemoveUserBadgeResponse]

Пример

putRemoveBadge Пример

Copy

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

Отваряне отново на нишка

Параметри

Име	Тип	Задължително
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

Задаване на фактор на доверие

Параметри

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

Създаване на модератор

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createModeratorBody	CreateModeratorBody	Не

Отговор

Връща: Option[CreateModeratorResponse]

Пример

пример за createModerator

Copy

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

Изтриване на модератор

Параметри

Име	Тип	Задължително
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"

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

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
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

Обновяване на модератор

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
updateModeratorBody	UpdateModeratorBody	Не

Отговор

Връща: 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()

Изтриване на брой известия

Параметри

Име	Тип	Задължително	Описание
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()

Получаване на кеширан брой известия

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Не

Отговор

Връща: Option[GetCachedNotificationCountResponse]

Пример

Пример за getCachedNotificationCount

Copy

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

Получаване на брой известия

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
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()

Обновяване на известие

Параметри

Име	Тип	Задължително
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()

Създаване на реакция V1 за страница

Параметри

Име	Тип	Задължително
tenantId	string	Yes
urlId	string	Yes
title	string = ""	No

Отговор

Връща: Option[CreateV1PageReact]

Пример

createV1PageReact Пример

Copy

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

Създаване на реакция V2 за страница

Параметри

Име	Тип	Задължително
tenantId	string	Yes
urlId	string	Yes
id	string	No
title	string = ""	No

Отговор

Връща: 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` според нуждите

Изтриване на реакция V1 за страница

Параметри

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Отговор

Връща: Option[CreateV1PageReact]

Пример

Пример за deleteV1PageReact

Copy

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

Изтриване на реакция V2 за страница

Parameters

Име	Тип	Задължително
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

Получаване на харесвания V1 за страница

Параметри

Име	Тип	Задължително	Описание
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 при необходимост

Получаване на реакции V2 за страница

Параметри

Име	Тип	Задължително	Описание
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

Получаване на потребители с реакции V2 за страница

Параметри

Име	Тип	Задължително
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

Добавяне на страница

Параметри

Име	Тип	Задължително	Описание
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

Изтриване на страница

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
id	string	No

Отговор

Връща: Option[DeletePageAPIResponse]

Пример

deletePage Пример

Copy

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

Получаване на офлайн потребители

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

Parameters

Име	Тип	Задължително
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Response

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

Получаване на онлайн потребители

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

Параметри

Име	Тип	Задължителен
tenantId	string	Yes
urlId	string	Yes
options	GetOnlineUsersOptions	No

Отговор

Връща: Option[PageUsersOnlineResponse]

Пример

Пример за getOnlineUsers

Copy

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

Получаване на страница по URL ID

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
urlId	string	Yes

Отговор

Returns: Option[GetPageByURLIdAPIResponse]

Пример

getPageByURLId Пример

Copy

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

Получаване на страници

Параметри

Име	Тип	Задължително	Описание
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

Получаване на публични страници

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

Име	Тип	Задължително	Описание
tenantId	string	Да
options	GetPagesPublicOptions	Не

Response

Връща: Option[GetPublicPagesResponse]

Пример

Пример за getPagesPublic

Copy

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

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

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Използва се от уиджета за коментари за обогатяване на потребителите, които току-що са се появили чрез събитие за присъствие.
No page context: privacy is enforced uniformly (private profiles are masked).
Без контекст на страницата: поверителността се налага еднородно (частните профили се маскират).

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
ids	string	Не

Отговор

Връща: Option[PageUsersInfoResponse]

Пример

getUsersInfo Пример

Copy

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

Пачване на страница

Параметри

Име	Тип	Задължително
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()

Изтриване на чакащо webhook събитие

Параметри

Име	Тип	Задължително	Описание
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()

Получаване на брой чакащи webhook събития

Параметри

Име	Тип	Задължително	Описание
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

Получаване на чакащи webhook събития

Параметри

Име	Тип	Задължително	Описание
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()

Създаване на конфигурация за въпрос

Параметри

Име	Тип	Задължително	Описание
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 при нужда

Изтриване на конфигурация за въпрос

Параметри

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Отговор

Връща: Option[APIEmptyResponse]

Пример

deleteQuestionConfig Пример

Copy

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

Получаване на конфигурация за въпрос

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
id	string	No

Отговор

Връща: Option[GetQuestionConfigResponse]

Пример

Пример за getQuestionConfig

Copy

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

Получаване на конфигурации за въпроси

Параметри

Име	Тип	Задължително	Описание
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

Обновяване на конфигурация за въпрос

Параметри

Име	Тип	Задължително
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Отговор

Връща: Option[APIEmptyResponse]

Пример

Пример за updateQuestionConfig

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createQuestionResultBody	CreateQuestionResultBody	Не

Отговор

Връща: Option[CreateQuestionResultResponse]

Пример

createQuestionResult Пример

Copy

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

Изтриване на резултат от въпрос

Parameters

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

Response

Returns: Option[APIEmptyResponse]

Example

deleteQuestionResult Пример

Copy

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

Получаване на резултат от въпрос

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
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

Обновяване на резултат от въпрос

Параметри

Име	Тип	Задължително
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()

Агрегиране на резултати от въпроси

Параметри

Name	Type	Required	Description
tenantId	string	Да
options	AggregateQuestionResultsOptions	Не

Отговор

Връща: 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()

Масово агрегиране на резултати от въпроси

Параметри

Name	Type	Required
tenantId	string	Да
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Не
forceRecalculate	bool	Не

Отговор

Връща: 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()

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

Отговор

Връща: Option[CombineQuestionResultsWithCommentsResponse]

Пример

combineCommentsWithQuestionResults Пример

Copy

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

Добавяне на SSO потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	No

Отговор

Връща: Option[AddSSOUserAPIResponse]

Пример

Пример за addSSOUser

Copy

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

Изтриване на SSO потребител

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
options	DeleteSSOUserOptions	Не

Отговор

Връща: Option[DeleteSSOUserAPIResponse]

Пример

deleteSSOUser Пример

Copy

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

Получаване на SSO потребител по имейл

Параметри

Име	Тип	Задължително	Описание
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

Получаване на SSO потребител по ID

Параметри

Име	Тип	Задължително	Описание
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

Получаване на SSO потребители

Параметри

Name	Type	Required	Description
tenantId	string	Да
skip	int	Не

Отговор

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

Пачване на SSO потребител

Parameters

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
updateAPISSOUserData	UpdateAPISSOUserData	Не
updateComments	bool	Не

Response

Връща: Option[PatchSSOUserAPIResponse]

Example

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

Задаване на SSO потребител

Параметри

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

Създаване на абонамент

Параметри

Име	Тип	Задължително	Описание
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()

Изтриване на абонамент

Параметри

Име	Тип	Задължително
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, както е необходимо

Получаване на абонаменти

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
userId	string = ""	Не

Отговор

Връща: Option[GetSubscriptionsAPIResponse]

Пример

Пример за getSubscriptions

Copy

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

Обновяване на абонамент

Параметри

Име	Тип	Задължително
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

Отговор

Връща: Option[UpdateSubscriptionAPIResponse]

Пример

updateSubscription Пример

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
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

Създаване на пакет за наемател

Параметри

Име	Тип	Задължително	Описание
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()

Изтриване на пакет за наемател

Параметри

Име	Тип	Задължително	Описание
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()

Получаване на пакет за наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Не

Отговор

Връща: Option[GetTenantPackageResponse]

Пример

Пример за getTenantPackage

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
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

Замяна на пакет за наемател

Параметри

Име	Тип	Задължителен
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

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

Параметри

Име	Тип	Задължително
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Отговор

Връща: 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()

Създаване на потребител за наемател

Параметри

Име	Тип	Задължително	Описание
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

Изтриване на потребител за наемател

Параметри

Име	Тип	Задължително
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"

Получаване на потребител за наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Не

Отговор

Връща: Option[GetTenantUserResponse]

Пример

getTenantUser Пример

Copy

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

Получаване на потребители за наемател

Параметри

Име	Тип	Задължително	Описание
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

Замяна на потребител за наемател

Параметри

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

Отговор

Връща: Option[APIEmptyResponse]

Пример

replaceTenantUser пример

Copy

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

Изпращане на линк за вход

Параметри

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

Отговор

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

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
updateTenantUserBody	UpdateTenantUserBody	Не
updateComments	string = ""	Не

Отговор

Връща: Option[APIEmptyResponse]

Пример

Пример за updateTenantUser

Copy

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

Създаване на наемател

Параметри

Име	Тип	Задължително	Описание
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

Изтриване на наемател

Параметри

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

Отговор

Returns: Option[APIEmptyResponse]

Пример

deleteTenant Пример

Copy

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

Получаване на наемател

Параметри

Име	Тип	Задължително	Описание
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

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

Parameters

Име	Тип	Задължително	Описание
tenantId	string	Да
options	GetTenantsOptions	Не

Response

Връща: Option[GetTenantsResponse]

Example

Пример за getTenants

Copy

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

Обновяване на наемател

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

Отговор

Връща: Option[APIEmptyResponse]

Пример

Пример за updateTenant

Copy

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

Промяна на състоянието на билет

Параметри

Име	Тип	Задължително
tenantId	string	Yes
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

Отговор

Връща: Option[ChangeTicketStateResponse]

Пример

Пример за changeTicketState

Copy

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

Създаване на билет

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително
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

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

Параметри

Име	Тип	Задължително	Описание
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()
  # използвайте билетите, както е необходимо

Получаване на преводи

Parameters

Име	Тип	Задължително
namespace	string	Не
component	string	Не
options	GetTranslationsOptions	Не

Response

Връща: Option[GetTranslationsResponse]

Example

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

Качване на изображение

Качване и преоразмеряване на изображение

Параметри

Име	Тип	Задължителен
tenantId	string	Да
file	string	Не
options	UploadImageOptions	Не

Отговор

Връща: Option[UploadImageResponse]

Пример

uploadImage Пример

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
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

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
options	GetUserBadgeProgressListOptions	No

Отговор

Returns: Option[APIGetUserBadgeProgressListResponse]

Пример

getUserBadgeProgressList Пример

Copy

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

Създаване на потребителска значка

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	No

Отговор

Връща: Option[APICreateUserBadgeResponse]

Пример

Пример за createUserBadge

Copy

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

Изтриване на потребителска значка

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
id	string	No

Отговор

Връща: Option[APIEmptySuccessResponse]

Пример

Пример за deleteUserBadge

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
id	string	No

Отговор

Връща: 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

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

Parameters

Име	Тип	Задължително	Описание
tenantId	string	Yes
options	GetUserBadgesOptions	No

Response

Връща: 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()

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

Параметри

Име	Тип	Задължително
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()

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
sso	string = ""	Не

Отговор

Връща: Option[GetUserNotificationCountResponse]

Пример

getUserNotificationCount Пример

Copy

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

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

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
options	GetUserNotificationsOptions	No

Отговор

Връща: Option[GetMyNotificationsResponse]

Пример

getUserNotifications пример

Copy

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

Нулиране на брой известия за потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
sso	string = ""	Не

Отговор

Връща: Option[ResetUserNotificationsResponse]

Пример

resetUserNotificationCount Пример

Copy

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

Нулиране на известия за потребител

Параметри

Име	Тип	Задължителен	Описание
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()

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

Активирайте или деактивирайте известия за конкретен коментар.

Параметри

Име	Тип	Задължително
tenantId	string	Да
notificationId	string	Не
optedInOrOut	string	Не
commentId	string	Да
sso	string = ""	Не

Отговор

Връща: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Пример

Пример за updateUserNotificationCommentSubscriptionStatus

Copy

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

Обновяване на статус на абонамент за страници в известия

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

Parameters

Име	Тип	Задължително
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Response

Връща: 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

Обновяване на статус на известие

Параметри

Име	Тип	Задължително
tenantId	string	Да
notificationId	string	Не
newStatus	string	Не
sso	string = ""	Не

Отговор

Връща: Option[UpdateUserNotificationStatusResponse]

Пример

Пример за updateUserNotificationStatus

Copy

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

Получаване на статуси на присъствие на потребител

Параметри

Име	Тип	Задължително
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()

Търсене на потребители

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
options	SearchUsersOptions	Не

Отговор

Връща: Option[SearchUsersResult]

Пример

Пример за searchUsers

Copy

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

Получаване на потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Не

Отговор

Връща: Option[GetUserResponse]

Пример

Пример getUser

Copy

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

Създаване на глас

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
direction	string	Не
options	CreateVoteOptions	Не

Отговор

Връща: Option[VoteResponse]

Пример

Пример за createVote

Copy

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

Изтриване на глас

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Не
editKey	string = ""	Не

Отговор

Връща: Option[VoteDeleteResponse]

Пример

Пример за deleteVote

Copy

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

Получаване на гласове

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
urlId	string	Да

Отговор

Връща: 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

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

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
options	GetVotesForUserOptions	Не

Отговор

Връща: Option[GetVotesForUserResponse]

Пример

Пример за getVotesForUser

Copy

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

Имате нужда от помощ?

Ако срещнете проблеми или имате въпроси относно Nim SDK, моля:

Принос

Приноси са добре дошли! Моля посетете GitHub хранилището за указания как да допринесете.

Език 🇧🇬 Български

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

Започване

API справка

Употреба

Агрегиране

Одитни записи

Удостоверяване

Блокиране от коментар

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

Коментари

Коментари за потребител

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

Имейл шаблони

Журнал на събития

Публикации във фийд

Маркиране на коментар

GIF файлове

Хаштагове

Модерация

Модератори

Брой известия

Известия

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

Страници

Чакащи webhook събития

Конфигурации за въпроси

Резултати от въпроси

Агрегиране на резултати от въпроси

SSO потребители

Абонаменти

Дневно използване на наемател

Пакети за наематели

Потребители на наемател

Наематели

Билети

Преводи

Качване на изображение

Прогрес на потребителски значки

Потребителски значки

Потребителски известия

Статус на присъствие на потребител

Търсене на потребители

Потребители

Гласове

FastComments Nim SDK

Репозитория

AI кодиращи агенти

Изисквания

Инсталация

Използване на Nimble

Компилиране от източник

Съдържание на библиотеката

Публични срещу защитени API

Бърз старт

Using Authenticated APIs (DefaultAPI)

Using Public APIs (PublicAPI)

Using Moderation APIs (ModerationAPI)

Common Issues

Извършване на API заявки

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

Бележки

Идентификатори на предаване

SSO (Еднократно влизане)

Използване на SSO

Просто SSO

Сигурно SSO

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

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

агрегиране

Параметри

Отговор

Пример

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

Parameters

Response

Example