FastComments Nim SDK

Ово је званични Nim SDK за FastComments.

Званични Nim SDK за FastComments API

Репозиторијум

Захтеви

Nim >= 1.6.0
nimcrypto >= 0.5.4

Инсталација

Коришћење Nimble

nimble install fastcomments

Грађење из извора

nimble build

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

Ова библиотека садржи генерисани API клијент и SSO алате који олакшавају рад са API-јем.

Документација API клијент библиотеке

Јавни vs заштићени 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 сесијског колачића.

Брз почетак

Коришћење аутентификованих API‑ја (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"

# Извршавање аутентификованих API позива.
# Потребни параметри (и тело захтева) су позиционални; опционо
# параметри се прослеђују преко објекта опција операције.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Коришћење јавних API‑ја (PublicAPI)

Јавне крајње тачке не захтевају аутентификацију:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Извршавање јавних API позива.
# tenantId и urlId су потребни (позиционални); све остало је опционо.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Коришћење модерацијских API‑ја (ModerationAPI)

Модерацијске крајње тачке покрећу контролни панел модератора и аутентификоване су SSO токеном за модератора који делује:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Листање коментара у модерацијском контролном панелу.
# Ова операција нема потребних параметара, тако да је све опционо.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Уобичајени проблеми

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

aggregate

Агрегира документе груписањем (ако је наведен groupBy) и примењивањем више операција.
Подржане су различите операције (нпр. sum, countDistinct, avg, итд.).

Параметри

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

Одговор

Returns: Option[AggregateResponse]

Пример

пример агрегирања

Copy

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

getAuditLogs

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetAuditLogsOptions	No

Одговор

Враћа: Option[GetAuditLogsResponse]

Пример

getAuditLogs Пример

Copy

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

logoutPublic

Одговор

Vraća: Option[APIEmptyResponse]

Пример

logoutPublic Primer

Copy

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

blockFromCommentPublic

Параметри

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

Одговор

Враћа: Option[BlockSuccess]

Пример

blockFromCommentPublic Primer

Copy

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

unBlockCommentPublic

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
publicBlockFromCommentParams	PublicBlockFromCommentParams	Не
sso	string = ""	Не

Одговор

Враћа: Option[UnblockSuccess]

Пример

Primer unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentIds	string	Не
sso	string = ""	Не

Одговор

Враћа: Option[CheckBlockedCommentsResponse]

Пример

checkedCommentsForBlocked Пример

Copy

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

blockUserFromComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
blockFromCommentParams	BlockFromCommentParams	Не
options	BlockUserFromCommentOptions	Не

Одговор

Враћа: Option[BlockSuccess]

Пример

blockUserFromComment Primer

Copy

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

createCommentPublic

Параметри

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

Одговор

Враћа: Option[SaveCommentsResponseWithPresence]

Пример

createCommentPublic Пример

Copy

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

deleteComment

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Одговор

Враћа: Option[DeleteCommentResult]

Пример

deleteComment Пример

Copy

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

deleteCommentPublic

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Одговор

Враћа: Option[PublicAPIDeleteCommentResponse]

Пример

deleteCommentPublic Пример

Copy

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

deleteCommentVote

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
options	DeleteCommentVoteOptions	No

Одговор

Враћа: Option[VoteDeleteResponse]

Пример

deleteCommentVote Primer

Copy

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

flagComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
options	FlagCommentOptions	Не

Одговор

Враћа: Option[FlagCommentResponse]

Пример

Пример flagComment

Copy

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

getComment

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[APIGetCommentResponse]

Пример

getComment Пример

Copy

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

getComments

Параметри

Назив	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetCommentsOptions	No

Одговор

Враћа: Option[APIGetCommentsResponse]

Пример

пример getComments

Copy

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

getCommentsPublic

req tenantId urlId

Параметри

Име	Тип	Обавезно
tenantId	string	Да
urlId	string	Да
options	GetCommentsPublicOptions	Не

Одговор

Враћа: Option[GetCommentsResponseWithPresencePublicComment]

Пример

Пример getCommentsPublic

Copy

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

getCommentText

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	GetCommentTextOptions	Не

Одговор

Враћа: Option[PublicAPIGetCommentTextResponse]

Пример

getCommentText Primer

Copy

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

getCommentVoteUserNames

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

Одговор

Враћа: Option[GetCommentVoteUserNamesSuccessResponse]

Пример

Пример getCommentVoteUserNames

Copy

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

lockComment

Параметри

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

Одговор

Враћа: Option[APIEmptyResponse]

Пример

lockComment Primer

Copy

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

pinComment

Параметри

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

Одговор

Враћа: Option[ChangeCommentPinStatusResponse]

Пример

pinComment Primer

Copy

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

saveComment

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

Одговор

Враћа: Option[APISaveCommentResponse]

Пример

saveComment пример

Copy

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

saveCommentsBulk

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

saveCommentsBulk Primer

Copy

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

setCommentText

Parameters

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

Response

Враћа: Option[PublicAPISetCommentTextResponse]

Example

setCommentText Primer

Copy

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

unBlockUserFromComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
unBlockFromCommentParams	UnBlockFromCommentParams	Не
options	UnBlockUserFromCommentOptions	Не

Одговор

Returns: Option[UnblockSuccess]

Пример

unBlockUserFromComment Пример

Copy

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

unFlagComment

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
options	UnFlagCommentOptions	No

Одговор

Враћа: Option[FlagCommentResponse]

Пример

Primer unFlagComment

Copy

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

unLockComment

Параметри

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

Одговор

Returns: Option[APIEmptyResponse]

Пример

Primer unLockComment

Copy

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

unPinComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
broadcastId	string	Не
sso	string = ""	Не

Одговор

Враћа: Option[ChangeCommentPinStatusResponse]

Пример

Primer unPinComment

Copy

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

updateComment

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Не
updatableCommentParams	UpdatableCommentParams	Не
options	UpdateCommentOptions	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

Пример updateComment

Copy

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

voteComment

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

Одговор

Враћа: Option[VoteResponse]

Пример

voteComment Пример

Copy

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

getCommentsForUser

Параметри

Име	Тип	Обавезно	Опис
options	GetCommentsForUserOptions	Ne

Одговор

Враћа: Option[GetCommentsForUserResponse]

Пример

getCommentsForUser Primer

Copy

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

addDomainConfig

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Одговор

Враћа: Option[AddDomainConfigResponse]

Пример

addDomainConfig Primer

Copy

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

deleteDomainConfig

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
domain	string	No

Одговор

Враћа: Option[DeleteDomainConfigResponse]

Пример

deleteDomainConfig Пример

Copy

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

getDomainConfig

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
domain	string	No

Одговор

Враћа: Option[GetDomainConfigResponse]

Пример

getDomainConfig Пример

Copy

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

getDomainConfigs

Параметри

Name	Type	Required	Description
tenantId	string	Да

Одговор

Враћа: Option[GetDomainConfigsResponse]

Пример

getDomainConfigs Пример

Copy

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

patchDomainConfig

Параметри

Име	Тип	Обавезно
tenantId	string	Да
domainToUpdate	string	Не
patchDomainConfigParams	PatchDomainConfigParams	Не

Одговор

Враћа: Option[PatchDomainConfigResponse]

Пример

patchDomainConfig Пример

Copy

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

putDomainConfig

Параметри

Име	Тип	Обавезно
tenantId	string	Да
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

createEmailTemplate

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Одговор

Враћа: Option[CreateEmailTemplateResponse]

Пример

createEmailTemplate Primer

Copy

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

deleteEmailTemplate

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteEmailTemplate Пример

Copy

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

deleteEmailTemplateRenderError

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
errorId	string	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteEmailTemplateRenderError Пример

Copy

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

getEmailTemplate

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[GetEmailTemplateResponse]

Пример

getEmailTemplate Пример

Copy

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

getEmailTemplateDefinitions

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да

Одговор

Враћа: Option[GetEmailTemplateDefinitionsResponse]

Пример

getEmailTemplateDefinitions Пример

Copy

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

getEmailTemplateRenderErrors

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
skip	float64	No

Одговор

Враћа: Option[GetEmailTemplateRenderErrorsResponse]

Пример

Пример getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Параметри

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

renderEmailTemplate

Параметри

Име	Тип	Потребно
tenantId	string	Да
renderEmailTemplateBody	RenderEmailTemplateBody	Не
locale	string = ""	Не

Одговор

Враћа: Option[RenderEmailTemplateResponse]

Пример

renderEmailTemplate Primer

Copy

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

updateEmailTemplate

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

updateEmailTemplate Пример

Copy

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

getEventLog

req tenantId urlId userIdWS

Параметри

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

Одговор

Враћа: Option[GetEventLogResponse]

Пример

getEventLog Пример

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Параметри

Име	тип	обавезно
tenantId	string	Да
urlId	string	Да
userIdWS	string	Не
startTime	int64	Не
endTime	int64	Не

Одговор

Враћа: Option[GetEventLogResponse]

Пример

getGlobalEventLog Пример

Copy

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

createFeedPost

Параметри

Име	Тип	Обавезно
tenantId	string	Да
createFeedPostParams	CreateFeedPostParams	Не
options	CreateFeedPostOptions	Не

Одговор

Враћа: Option[CreateFeedPostsResponse]

Пример

Primer createFeedPost

Copy

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

createFeedPostPublic

Параметри

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

Одговор

Враћа: Option[CreateFeedPostResponse]

Пример

createFeedPostPublic Пример

Copy

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

deleteFeedPostPublic

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

Одговор

Враћа: Option[DeleteFeedPostPublicResponse]

Пример

deleteFeedPostPublic Primer

Copy

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

getFeedPosts

req tenantId afterId

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetFeedPostsOptions	Не

Одговор

Враћа: Option[GetFeedPostsResponse]

Пример

Пример getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Параметри

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

Одговор

Returns: Option[PublicFeedPostsResponse]

Пример

Primer getFeedPostsPublic

Copy

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

getFeedPostsStats

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

Одговор

Враћа: Option[FeedPostsStatsResponse]

Пример

Пример getFeedPostsStats

Copy

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

getUserReactsPublic

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetUserReactsPublicOptions	Не

Одговор

Враћа: Option[UserReactsResponse]

Пример

getUserReactsPublic Primer

Copy

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

reactFeedPostPublic

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Одговор

Враћа: Option[ReactFeedPostResponse]

Пример

Primer reactFeedPostPublic

Copy

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

updateFeedPost

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

updateFeedPost Пример

Copy

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

updateFeedPostPublic

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Одговор

Враћа: Option[CreateFeedPostResponse]

Пример

updateFeedPostPublic Primer

Copy

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

flagCommentPublic

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string = ""	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

flagCommentPublic Пример

Copy

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

getGifLarge

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
largeInternalURLSanitized	string	No

Одговор

Враћа: Option[GifGetLargeResponse]

Пример

Пример getGifLarge

Copy

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

getGifsSearch

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

Одговор

Враћа: Option[GetGifsSearchResponse]

Пример

getGifsSearch Primer

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()
  # користите одговор по потреби

getGifsTrending

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetGifsTrendingOptions	Не

Одговор

Враћа: Option[GetGifsTrendingResponse]

Пример

Пример getGifsTrending

Copy

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

addHashTag

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
createHashTagBody	CreateHashTagBody	Не

Одговор

Враћа: Option[CreateHashTagResponse]

Пример

Primer addHashTag

Copy

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

addHashTagsBulk

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Не

Одговор

Враћа: Option[BulkCreateHashTagsResponse]

Пример

addHashTagsBulk Пример

Copy

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

deleteHashTag

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
tag	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

Пример deleteHashTag

Copy

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

getHashTags

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
page	float64	No

Одговор

Враћа: Option[GetHashTagsResponse]

Пример

Пример getHashTags

Copy

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

patchHashTag

Параметри

Name	Type	Required
tenantId	string	Да
tag	string	Не
updateHashTagBody	UpdateHashTagBody	Не

Одговор

Враћа: Option[UpdateHashTagResponse]

Пример

Primer patchHashTag

Copy

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

deleteModerationVote

Parameters

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

Response

Враћа: Option[VoteDeleteResponse]

Example

deleteModerationVote Пример

Copy

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

getApiComments

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetApiCommentsOptions	No

Одговор

Враћа: Option[ModerationAPIGetCommentsResponse]

Пример

Пример getApiComments

Copy

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

getApiExportStatus

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetApiExportStatusOptions	No

Одговор

Враћа: Option[ModerationExportStatusResponse]

Пример

Пример getApiExportStatus

Copy

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

getApiIds

Параметри

Name	Type	Required	Опис
tenantId	string	Yes
options	GetApiIdsOptions	No

Одговор

Враћа: Option[ModerationAPIGetCommentIdsResponse]

Пример

Primer getApiIds

Copy

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

getBanUsersFromComment

Параметри

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

Одговор

Враћа: Option[GetBannedUsersFromCommentResponse]

Пример

getBanUsersFromComment Пример

Copy

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

getCommentBanStatus

Параметри

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

Одговор

Враћа: Option[GetCommentBanStatusResponse]

Пример

Пример getCommentBanStatus

Copy

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

getCommentChildren

Параметри

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

Одговор

Враћа: Option[ModerationAPIChildCommentsResponse]

Пример

Пример getCommentChildren

Copy

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

getCount

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetCountOptions	No

Одговор

Враћа: Option[ModerationAPICountCommentsResponse]

Пример

Primer getCount

Copy

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

getCounts

Параметри

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

Одговор

Враћа: Option[GetBannedUsersCountResponse]

Пример

Пример getCounts

Copy

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

getLogs

Параметри

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

Одговор

Враћа: Option[ModerationAPIGetLogsResponse]

Пример

Primer getLogs

Copy

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

getManualBadges

Параметри

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

Одговор

Враћа: Option[GetTenantManualBadgesResponse]

Пример

Primer getManualBadges

Copy

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

getManualBadgesForUser

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetManualBadgesForUserOptions	Не

Одговор

Враћа: Option[GetUserManualBadgesResponse]

Пример

getManualBadgesForUser Пример

Copy

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

getModerationComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	GetModerationCommentOptions	Не

Одговор

Враћа: Option[ModerationAPICommentResponse]

Пример

Пример getModerationComment

Copy

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

getModerationCommentText

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Одговор

Враћа: Option[GetCommentTextResponse]

Пример

Пример getModerationCommentText

Copy

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

getPreBanSummary

Параметри

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

Одговор

Враћа: Option[PreBanSummary]

Пример

Primer getPreBanSummary

Copy

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

getSearchCommentsSummary

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetSearchCommentsSummaryOptions	Не

Одговор

Враћа: Option[ModerationCommentSearchResponse]

Пример

Primer getSearchCommentsSummary

Copy

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

getSearchPages

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetSearchPagesOptions	No

Одговор

Враћа: Option[ModerationPageSearchResponse]

Пример

Пример getSearchPages

Copy

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

getSearchSites

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetSearchSitesOptions	No

Одговор

Враћа: Option[ModerationSiteSearchResponse]

Пример

Пример getSearchSites

Copy

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

getSearchSuggest

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetSearchSuggestOptions	No

Одговор

Враћа: Option[ModerationSuggestResponse]

Пример

getSearchSuggest Пример

Copy

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

getSearchUsers

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetSearchUsersOptions	No

Одговор

Враћа: Option[ModerationUserSearchResponse]

Пример

Primer getSearchUsers

Copy

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

getTrustFactor

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetTrustFactorOptions	Не

Одговор

Враћа: Option[GetUserTrustFactorResponse]

Пример

Primer getTrustFactor

Copy

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

getUserBanPreference

Параметри

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

Одговор

Враћа: Option[APIModerateGetUserBanPreferencesResponse]

Пример

getUserBanPreference Primer

Copy

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

getUserInternalProfile

Параметри

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	GetUserInternalProfileOptions	Ne

Одговор

Returns: Option[GetUserInternalProfileResponse]

Пример

Primer getUserInternalProfile

Copy

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

postAdjustCommentVotes

Параметри

Name	Type	Required
tenantId	string	Da
commentId	string	Da
adjustCommentVotesParams	AdjustCommentVotesParams	Ne
options	PostAdjustCommentVotesOptions	Ne

Одговор

Vraća: Option[AdjustVotesResponse]

Пример

Primer postAdjustCommentVotes

Copy

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

postApiExport

Параметри

Име	Тип	Захтевано	Опис
tenantId	string	Yes
options	PostApiExportOptions	No

Одговор

Враћа: Option[ModerationExportResponse]

Пример

postApiExport Primer

Copy

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

postBanUserFromComment

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
options	PostBanUserFromCommentOptions	No

Одговор

Враћа: Option[BanUserFromCommentResult]

Пример

postBanUserFromComment Пример

Copy

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

postBanUserUndo

Параметри

Име	Тип	Обавезно
tenantId	string	Да
banUserUndoParams	BanUserUndoParams	Не
sso	string = ""	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

postBanUserUndo Пример

Copy

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

postBulkPreBanSummary

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Одговор

Враћа: Option[BulkPreBanSummary]

Пример

postBulkPreBanSummary Primer

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

postFlagComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	PostFlagCommentOptions	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

postFlagComment Пример

Copy

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

postRemoveComment

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Одговор

Враћа: Option[PostRemoveCommentApiResponse]

Пример

postRemoveComment Primer

Copy

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

postRestoreDeletedComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	PostRestoreDeletedCommentOptions	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

postRestoreDeletedComment пример

Copy

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

postSetCommentApprovalStatus

Параметри

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

postSetCommentReviewStatus

Parameters

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	PostSetCommentReviewStatusOptions	Не

Response

Враћа: Option[APIEmptyResponse]

Пример

postSetCommentReviewStatus Primer

Copy

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

postSetCommentSpamStatus

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	PostSetCommentSpamStatusOptions	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

postSetCommentSpamStatus Пример

Copy

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

postSetCommentText

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

Одговор

Враћа: Option[SetCommentTextResponse]

Пример

postSetCommentText Primer

Copy

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

postUnFlagComment

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
options	PostUnFlagCommentOptions	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

postUnFlagComment пример

Copy

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

postVote

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
commentId	string	Yes
options	PostVoteOptions	No

Одговор

Враћа: Option[VoteResponse]

Пример

postVote Primer

Copy

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

putAwardBadge

Параметри

Име	Тип	Обавезно
tenantId	string	Да
badgeId	string	Не
options	PutAwardBadgeOptions	Не

Одговор

Враћа: Option[AwardUserBadgeResponse]

Пример

putAwardBadge пример

Copy

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

putCloseThread

Параметри

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

Одговор

Враћа: Option[APIEmptyResponse]

Пример

putCloseThread Пример

Copy

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

putRemoveBadge

Параметри

Име	Тип	Обавезно
tenantId	string	Да
badgeId	string	Не
options	PutRemoveBadgeOptions	Не

Одговор

Враћа: Option[RemoveUserBadgeResponse]

Пример

putRemoveBadge Пример

Copy

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

putReopenThread

Параметри

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

Одговор

Враћа: Option[APIEmptyResponse]

Пример

putReopenThread Primer

Copy

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

setTrustFactor

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	SetTrustFactorOptions	Не

Одговор

Враћа: Option[SetUserTrustFactorResponse]

Пример

setTrustFactor Пример

Copy

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

createModerator

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
createModeratorBody	CreateModeratorBody	Не

Одговор

Враћа: Option[CreateModeratorResponse]

Пример

createModerator Primer

Copy

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

deleteModerator

Параметри

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

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteModerator Пример

Copy

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

getModerator

Параметри

Назив	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[GetModeratorResponse]

Пример

Пример getModerator

Copy

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

getModerators

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
skip	float64	No

Одговор

Враћа: Option[GetModeratorsResponse]

Пример

getModerators Пример

Copy

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

updateModerator

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
updateModeratorBody	UpdateModeratorBody	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

updateModerator Primer

Copy

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

deleteNotificationCount

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteNotificationCount Пример

Copy

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

getCachedNotificationCount

Параметри

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Одговор

Vraća: Option[GetCachedNotificationCountResponse]

Пример

Primer getCachedNotificationCount

Copy

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

getNotificationCount

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetNotificationCountOptions	No

Одговор

Враћа: Option[GetNotificationCountResponse]

Пример

getNotificationCount Primer

Copy

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

getNotifications

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetNotificationsOptions	No

Одговор

Враћа: Option[GetNotificationsResponse]

Пример

Primer getNotifications

Copy

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

updateNotification

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

updateNotification Пример

Copy

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

createV1PageReact

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
urlId	string	Yes
title	string = ""	No

Одговор

Враћа: Option[CreateV1PageReact]

Пример

createV1PageReact Пример

Copy

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

createV2PageReact

Параметри

Име	Тип	Обавезно
tenantId	string	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` по потреби

deleteV1PageReact

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
urlId	string	Да

Одговор

Враћа: Option[CreateV1PageReact]

Пример

Пример deleteV1PageReact

Copy

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

deleteV2PageReact

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
urlId	string	Yes
id	string	No

Одговор

Враћа: Option[CreateV1PageReact]

Пример

Пример deleteV2PageReact

Copy

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

getV1PageLikes

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
urlId	string	Да

Одговор

Враћа: Option[GetV1PageLikes]

Пример

Пример getV1PageLikes

Copy

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

getV2PageReacts

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
urlId	string	Yes

Одговор

Враћа: Option[GetV2PageReacts]

Пример

Пример getV2PageReacts

Copy

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

getV2PageReactUsers

Параметри

Име	Тип	Обавезно
tenantId	string	Да
urlId	string	Да
id	string	Не

Одговор

Враћа: Option[GetV2PageReactUsersResponse]

Пример

Primer getV2PageReactUsers

Copy

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

addPage

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Одговор

Враћа: Option[AddPageAPIResponse]

Пример

addPage Пример

Copy

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

deletePage

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[DeletePageAPIResponse]

Пример

deletePage Пример

Copy

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

getOfflineUsers

Past commenters on the page who are NOT currently online. Sorted by displayName.
Користите ово након што исцрпите /users/online да прикажете одељак „Чланови“.

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Курсорска пагинација на commenterName: сервер пролази парцијални {tenantId, urlId, commenterName} индекс од afterName унапред помоћу $gt, без трошка $skip.

Parameters

Име	Тип	Обавезно
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Response

Returns: Option[PageUsersOfflineResponse]

Example

Primer getOfflineUsers

Copy

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

getOnlineUsers

Тренутно онлајн гледаоци странице: људи чија вебсокет сесија је тренутно претплаћена на страницу.
Враћа anonCount + totalCount (претплатници у целој соби, укључујући анонимне гледаоце које не наводимо).

Parameters

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

Response

Враћа: Option[PageUsersOnlineResponse]

Пример

Primer getOnlineUsers

Copy

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

getPageByURLId

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
urlId	string	Yes

Одговор

Враћа: Option[GetPageByURLIdAPIResponse]

Пример

getPageByURLId Пример

Copy

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

getPages

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes

Одговор

Враћа: Option[GetPagesAPIResponse]

Пример

Пример getPages

Copy

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

getPagesPublic

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

Параметри

Name	Type	Required	Description
tenantId	string	Yes
options	GetPagesPublicOptions	No

Одговор

Returns: Option[GetPublicPagesResponse]

Пример

Primer getPagesPublic

Copy

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

getUsersInfo

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

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
ids	string	No

Одговор

Враћа: Option[PageUsersInfoResponse]

Пример

Пример getUsersInfo

Copy

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

patchPage

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Одговор

Враћа: Option[PatchPageAPIResponse]

Пример

patchPage Пример

Copy

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

deletePendingWebhookEvent

Параметри

Име	Тип	Обавезно	Описание
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deletePendingWebhookEvent Primer

Copy

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

getPendingWebhookEventCount

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetPendingWebhookEventCountOptions	Не

Одговор

Враћа: Option[GetPendingWebhookEventCountResponse]

Пример

Primer getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetPendingWebhookEventsOptions	Не

Одговор

Враћа: Option[GetPendingWebhookEventsResponse]

Пример

getPendingWebhookEvents Пример

Copy

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

createQuestionConfig

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	No

Одговор

Returns: 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()
  # користите одговор по потреби

deleteQuestionConfig

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteQuestionConfig пример

Copy

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

getQuestionConfig

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[GetQuestionConfigResponse]

Пример

getQuestionConfig Primer

Copy

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

getQuestionConfigs

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
skip	float64	Не

Одговор

Враћа: Option[GetQuestionConfigsResponse]

Пример

Пример getQuestionConfigs

Copy

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

updateQuestionConfig

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

Пример за updateQuestionConfig

Copy

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

createQuestionResult

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
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

deleteQuestionResult

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteQuestionResult Пример

Copy

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

getQuestionResult

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[GetQuestionResultResponse]

Пример

getQuestionResult Пример

Copy

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

getQuestionResults

Parameters

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetQuestionResultsOptions	Не

Response

Враћа: Option[GetQuestionResultsResponse]

Example

getQuestionResults Пример

Copy

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

updateQuestionResult

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
updateQuestionResultBody	UpdateQuestionResultBody	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

Пример updateQuestionResult

Copy

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

aggregateQuestionResults

Параметри

Име	Тип	Обавезно	Опис
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()

bulkAggregateQuestionResults

Параметри

Име	Тип	Обавезно
tenantId	string	Да
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Не
forceRecalculate	bool	Не

Одговор

Returns: Option[BulkAggregateQuestionResultsResponse]

Пример

bulkAggregateQuestionResults Пример

Copy

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

combineCommentsWithQuestionResults

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	CombineCommentsWithQuestionResultsOptions	Не

Одговор

Враћа: Option[CombineQuestionResultsWithCommentsResponse]

Пример

combineCommentsWithQuestionResults Primer

Copy

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

addSSOUser

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
createAPISSOUserData	CreateAPISSOUserData	Не

Одговор

Враћа: Option[AddSSOUserAPIResponse]

Пример

addSSOUser пример

Copy

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

deleteSSOUser

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Одговор

Враћа: Option[DeleteSSOUserAPIResponse]

Пример

deleteSSOUser пример

Copy

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

getSSOUserByEmail

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
email	string	Не

Одговор

Враћа: Option[GetSSOUserByEmailAPIResponse]

Пример

getSSOUserByEmail Primer

Copy

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

getSSOUserById

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[GetSSOUserByIdAPIResponse]

Пример

Пример getSSOUserById

Copy

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

getSSOUsers

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
skip	int	No

Одговор

Враћа: Option[GetSSOUsersResponse]

Пример

Пример getSSOUsers

Copy

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

patchSSOUser

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
updateAPISSOUserData	UpdateAPISSOUserData	Не
updateComments	bool	Не

Одговор

Враћа: Option[PatchSSOUserAPIResponse]

Пример

patchSSOUser Primer

Copy

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

putSSOUser

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Одговор

Враћа: Option[PutSSOUserAPIResponse]

Пример

putSSOUser Пример

Copy

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

createSubscription

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Одговор

Враћа: Option[CreateSubscriptionAPIResponse]

Пример

createSubscription Пример

Copy

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

deleteSubscription

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
userId	string = ""	No

Одговор

Враћа: Option[DeleteSubscriptionAPIResponse]

Пример

Primer deleteSubscription

Copy

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

getSubscriptions

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
userId	string = ""	Не

Одговор

Враћа: Option[GetSubscriptionsAPIResponse]

Пример

Пример getSubscriptions

Copy

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

updateSubscription

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Не
userId	string = ""	Не

Одговор

Враћа: Option[UpdateSubscriptionAPIResponse]

Пример

Пример за updateSubscription

Copy

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

getTenantDailyUsages

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetTenantDailyUsagesOptions	Не

Одговор

Враћа: Option[GetTenantDailyUsagesResponse]

Пример

Primer getTenantDailyUsages

Copy

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

createTenantPackage

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	No

Одговор

Враћа: Option[CreateTenantPackageResponse]

Пример

createTenantPackage Primer

Copy

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

deleteTenantPackage

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Returns: Option[APIEmptyResponse]

Пример

Primer za deleteTenantPackage

Copy

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

getTenantPackage

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[GetTenantPackageResponse]

Пример

getTenantPackage Пример

Copy

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

getTenantPackages

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
skip	float64	Не

Одговор

Враћа: Option[GetTenantPackagesResponse]

Пример

Пример getTenantPackages

Copy

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

replaceTenantPackage

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
replaceTenantPackageBody	ReplaceTenantPackageBody	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

replaceTenantPackage Primer

Copy

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

updateTenantPackage

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
updateTenantPackageBody	UpdateTenantPackageBody	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

Пример updateTenantPackage

Copy

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

createTenantUser

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
createTenantUserBody	CreateTenantUserBody	Не

Одговор

Враћа: Option[CreateTenantUserResponse]

Пример

Пример createTenantUser

Copy

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

deleteTenantUser

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
options	DeleteTenantUserOptions	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteTenantUser Primer

Copy

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

getTenantUser

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[GetTenantUserResponse]

Пример

getTenantUser Primer

Copy

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

getTenantUsers

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
skip	float64	No

Одговор

Враћа: Option[GetTenantUsersResponse]

Пример

getTenantUsers Primer

Copy

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

replaceTenantUser

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
replaceTenantUserBody	ReplaceTenantUserBody	Не
updateComments	string = ""	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

replaceTenantUser Primer

Copy

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

sendLoginLink

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
redirectURL	string = ""	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

Пример sendLoginLink

Copy

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

updateTenantUser

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

updateTenantUser Primer

Copy

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

createTenant

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
createTenantBody	CreateTenantBody	Не

Одговор

Враћа: Option[CreateTenantResponse]

Пример

createTenant Пример

Copy

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

deleteTenant

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
sure	string = ""	No

Одговор

Враћа: Option[APIEmptyResponse]

Пример

deleteTenant Пример

Copy

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

getTenant

Параметри

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

Одговор

Враћа: Option[GetTenantResponse]

Пример

Пример getTenant

Copy

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

getTenants

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetTenantsOptions	Не

Одговор

Враћа: Option[GetTenantsResponse]

Пример

Пример getTenants

Copy

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

updateTenant

Параметри

Име	Тип	Обавезно
tenantId	string	Да
id	string	Не
updateTenantBody	UpdateTenantBody	Не

Одговор

Враћа: Option[APIEmptyResponse]

Пример

updateTenant Primer

Copy

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

changeTicketState

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

Одговор

Враћа: Option[ChangeTicketStateResponse]

Пример

changeTicketState Primer

Copy

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

createTicket

Параметри

Име	Тип	Обавезно
tenantId	string	Да
userId	string	Не
createTicketBody	CreateTicketBody	Не

Одговор

Враћа: Option[CreateTicketResponse]

Пример

createTicket Пример

Copy

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

getTicket

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
id	string	No
userId	string = ""	No

Одговор

Враћа: Option[GetTicketResponse]

Пример

Primer getTicket

Copy

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

getTickets

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetTicketsOptions	Не

Одговор

Враћа: Option[GetTicketsResponse]

Пример

getTickets Primer

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # koristite karte po potrebi

getTranslations

Parameters

Име	Тип	Обавезно
namespace	string	Не
component	string	Не
options	GetTranslationsOptions	Не

Response

Враћа: Option[GetTranslationsResponse]

Пример

Пример getTranslations

Copy

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

uploadImage

Отпремање и промена величине слике

Параметри

Име	Тип	Обавезно
tenantId	string	Да
file	string	Не
options	UploadImageOptions	Не

Одговор

Враћа: Option[UploadImageResponse]

Пример

uploadImage Пример

Copy

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

getUserBadgeProgressById

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
id	string	Не

Одговор

Враћа: Option[APIGetUserBadgeProgressResponse]

Пример

getUserBadgeProgressById Primer

Copy

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

getUserBadgeProgressByUserId

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
userId	string	Не

Одговор

Враћа: Option[APIGetUserBadgeProgressResponse]

Пример

Пример getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetUserBadgeProgressListOptions	No

Одговор

Враћа: Option[APIGetUserBadgeProgressListResponse]

Пример

getUserBadgeProgressList Primer

Copy

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

createUserBadge

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
createUserBadgeParams	CreateUserBadgeParams	Не

Одговор

Враћа: Option[APICreateUserBadgeResponse]

Пример

createUserBadge Primer

Copy

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

deleteUserBadge

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[APIEmptySuccessResponse]

Пример

deleteUserBadge Primer

Copy

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

getUserBadge

Параметри

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

getUserBadges

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	GetUserBadgesOptions	Не

Одговор

Враћа: Option[APIGetUserBadgesResponse]

Пример

Primer getUserBadges

Copy

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

updateUserBadge

Параметри

Name	Type	Required
tenantId	string	Yes
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Одговор

Враћа: Option[APIEmptySuccessResponse]

Пример

updateUserBadge Primer

Copy

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

getUserNotificationCount

Параметри

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

Одговор

Враћа: Option[GetUserNotificationCountResponse]

Пример

getUserNotificationCount Пример

Copy

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

getUserNotifications

Parameters

Име	Тип	Обавезно	Опис
tenantId	string	Yes
options	GetUserNotificationsOptions	No

Response

Враћа: Option[GetMyNotificationsResponse]

Example

Пример getUserNotifications

Copy

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

resetUserNotificationCount

Параметри

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

Одговор

Враћа: Option[ResetUserNotificationsResponse]

Пример

resetUserNotificationCount пример

Copy

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

resetUserNotifications

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
options	ResetUserNotificationsOptions	Не

Одговор

Враћа: Option[ResetUserNotificationsResponse]

Пример

resetUserNotifications Пример

Copy

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

updateUserNotificationCommentSubscriptionStatus

Омогућите или онемогућите обавештења за одређени коментар.

Параметри

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

Одговор

Враћа: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Пример

updateUserNotificationCommentSubscriptionStatus Пример

Copy

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

updateUserNotificationPageSubscriptionStatus

Омогућите или онемогућите обавештења за страницу. Када су корисници претплаћени на страницу, обавештења се креирају за нове коренске коментаре, а такође

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Одговор

Враћа: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Пример

updateUserNotificationPageSubscriptionStatus Primer

Copy

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

updateUserNotificationStatus

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
notificationId	string	No
newStatus	string	No
sso	string = ""	No

Одговор

Враћа: Option[UpdateUserNotificationStatusResponse]

Пример

updateUserNotificationStatus Пример

Copy

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

getUserPresenceStatuses

Параметри

Име	Тип	Обавезно
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

Одговор

Враћа: Option[GetUserPresenceStatusesResponse]

Пример

Пример getUserPresenceStatuses

Copy

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

searchUsers

Параметри

Име	Тип	Обавезно
tenantId	string	Да
urlId	string	Да
options	SearchUsersOptions	Не

Одговор

Враћа: Option[SearchUsersResult]

Пример

searchUsers Пример

Copy

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

getUser

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Yes
id	string	No

Одговор

Враћа: Option[GetUserResponse]

Пример

Primer getUser

Copy

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

createVote

Параметри

Име	Тип	Обавезно
tenantId	string	Да
commentId	string	Да
direction	string	Не
options	CreateVoteOptions	Не

Одговор

Враћа: Option[VoteResponse]

Пример

Primer createVote

Copy

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

deleteVote

Параметри

Назив	Тип	Обавезно
tenantId	string	Да
id	string	Не
editKey	string = ""	Не

Одговор

Returns: Option[VoteDeleteResponse]

Пример

Пример deleteVote

Copy

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

getVotes

Параметри

Име	Тип	Обавезно	Опис
tenantId	string	Да
urlId	string	Да

Одговор

Враћа: Option[GetVotesResponse]

Пример

getVotes Primer

Copy

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

getVotesForUser

Параметри

Назив	Тип	Обавезно
tenantId	string	Yes
urlId	string	Yes
options	GetVotesForUserOptions	No

Одговор

Враћа: Option[GetVotesForUserResponse]

Пример

Primer 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-ја

Употреба

Агрегација

Дневници ревизије

Аутентикација

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

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

Коментари

Коментари за корисника

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

Шаблони е-порука

Дневник догађаја

Објаве фида

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

Гифови

Хештегови

Модерација

Модератори

Број обавештења

Обавештења

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

Странице

Очекујући webhook догађаји

Поставке питања

Резултати питања

Агрегација резултата питања

SSO корисници

Претплате

Дневна употреба тенанта

Пакети тенанта

Корисници тенанта

Тенанти

Тикети

Преводи

Отпреми слику

Напредак корисничке ознаке

Корисничке ознаке

Корисничка обавештења

Статуси присутности корисника

Претрага корисника

Корисници

Гласови

FastComments Nim SDK

Репозиторијум

Захтеви

Инсталација

Коришћење Nimble

Грађење из извора

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

Јавни vs заштићени API-ји

Брз почетак

Коришћење аутентификованих API‑ја (DefaultAPI)

Коришћење јавних API‑ја (PublicAPI)

Коришћење модерацијских API‑ја (ModerationAPI)

Уобичајени проблеми

Прављење API позива

Пример: Прибављање коментара

Напомене

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

SSO (Једнократно пријављивање)

Коришћење SSO

Једноставан SSO

Безбедан SSO

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

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

Параметри

Одговор

Пример

getAuditLogs

Параметри

Одговор

Пример

logoutPublic