FastComments Nim SDK

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

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

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

Захтеви

Nim >= 1.6.0
nimcrypto >= 0.5.4

Инсталација

Korišćenje Nimble

nimble install fastcomments

Građenje iz izvornog koda

nimble build

Sadržaj biblioteke

Ova biblioteka sadrži generisanog API klijenta i SSO alate kako bi rad sa API‑jem bio jednostavniji.

API Client Library Docs

Javni vs zaštićeni API‑ji

Za klijenta API‑ja, postoje tri modula API‑ja, api_default, api_public i api_moderation. api_default sadrži metode koje zahtevaju vaš API ključ, a api_public sadrži API pozive koji se mogu izvršiti direktno iz pregledača/mobilnog uređaja/itd bez autentifikacije. api_moderation modul sadrži metode za moderacijsku kontrolnu tablu.

api_moderation modul pruža opsežan skup live i brzih moderacijskih API‑ja. Svaka metoda api_moderation prihvata parametar sso i može da se autentifikuje putem SSO‑a ili FastComments.com sesijskog kolačića.

Брз почетак

Korišćenje autentifikovanih API‑ja (DefaultAPI)

Važno: Autentifikovani endpoint‑i zahtevaju da vaš API ključ bude postavljen u zaglavlje 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"

# Napravite autentifikovane API pozive.
# Obavezni parametri (i telo zahteva) su pozicioni; opciona
# parametri se prosleđuju kroz objekat opcija operacije.
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"

Korišćenje javnih API‑ja (PublicAPI)

Javni endpoint‑i ne zahtevaju autentifikaciju:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Napravite javne API pozive.
# tenantId i urlId su obavezni (pozicioni); sve ostalo je opciono.
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"

Korišćenje moderacijskih API‑ja (ModerationAPI)

Moderacijski endpoint‑i napajaju moderatorsku kontrolnu tablu i autentifikovani su SSO tokenom za moderatora koji deluje:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Listajte komentare u moderacijskoj kontrolnoj tabli.
# Ova operacija nema obavezne parametre, pa je sve opciono.
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"

Česti problemi

401 greška autentifikacije: Proverite da ste postavili zaglavlje x-api-key na vaš HttpClient pre slanja DefaultAPI zahteva: client.headers["x-api-key"] = "your-api-key"
Pogrešna API klasa: Koristite api_default za server‑side autentifikovane zahteve, api_public za client‑side/javne zahteve, i api_moderation za zahteve moderatorske kontrolne table.

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

All API methods in this SDK return tuples of (Option[ResponseType], Response). The first element contains the parsed response if successful, and the second element is the raw HTTP response.

Obavezni parametri i telo zahteva se prosleđuju pozicioni. Preostali opcioni parametri se skupljaju u jedan objekat Api<Operation>Options, koji je poslednji argument. Operacije bez opcionalnih parametara ne uzimaju objekat opcija.

Primer: Dohvatanje komentara

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

Документација за API крајње тачке

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

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

aggregate

Agregira dokumente grupišući ih (ako je naveden groupBy) i primenjujući više operacija.
Različite operacije (npr. sum, countDistinct, avg, itd.) su podržane.

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Odgovor

Vraća: Option[AggregateResponse]

Primer

Primer agregacije

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetAuditLogsOptions	Ne

Odgovor

Vraća: Option[GetAuditLogsResponse]

Primer

getAuditLogs Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Odgovor

Vraća: Option[BlockSuccess]

Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ne
sso	string = ""	Ne

Odgovor

Vraća: Option[UnblockSuccess]

Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

Odgovor

Vraća: Option[CheckBlockedCommentsResponse]

Primer

checkedCommentsForBlocked Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
urlId	string	Da
broadcastId	string	Ne
commentData	CommentData	Ne
options	CreateCommentPublicOptions	Ne

Odgovor

Vraća: Option[SaveCommentsResponseWithPresence]

Primer

createCommentPublic Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Odgovor

Vraća: Option[DeleteCommentResult]

Primer

deleteComment Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Odgovor

Vraća: Option[PublicAPIDeleteCommentResponse]

Primer

deleteCommentPublic Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
options	FlagCommentOptions	No

Odgovor

Vraća: Option[FlagCommentResponse]

Primer

flagComment Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[APIGetCommentResponse]

Primer

Primer getComment

Copy

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

getComments

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetCommentsOptions	Ne

Odgovor

Vraća: Option[APIGetCommentsResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
urlId	string	Yes
options	GetCommentsPublicOptions	No

Odgovor

Vraća: Option[GetCommentsResponseWithPresencePublicComment]

Primer

getCommentsPublic Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
options	GetCommentTextOptions	Ne

Odgovor

Vraća: Option[PublicAPIGetCommentTextResponse]

Primer

Primer getCommentText

Copy

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

getCommentVoteUserNames

Параметри

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

Одговор

Враћа: Option[GetCommentVoteUserNamesSuccessResponse]

Пример

Пример getCommentVoteUserNames

Copy

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

lockComment

Параметри

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

Одговор

Враћа: Option[APIEmptyResponse]

Пример

lockComment 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

Odgovor

Vraća: Option[APISaveCommentResponse]

Primer

saveComment Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

Odgovor

Vraća: Option[UnblockSuccess]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

updateComment Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
urlId	string	Da
broadcastId	string	Ne
voteBodyParams	VoteBodyParams	Ne
options	VoteCommentOptions	Ne

Odgovor

Vraća: Option[VoteResponse]

Primer

voteComment Primer

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

Parametri

Ime	Tip	Potrebno	Opis
tenantId	string	Da
domain	string	Ne

Odgovor

Vraća: Option[DeleteDomainConfigResponse]

Primer

deleteDomainConfig Primer

Copy

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

getDomainConfig

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
domain	string	Ne

Odgovor

Vraća: Option[GetDomainConfigResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da

Odgovor

Vraća: Option[GetDomainConfigsResponse]

Primer

Primer getDomainConfigs

Copy

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

patchDomainConfig

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Odgovor

Vraća: Option[PatchDomainConfigResponse]

Primer

patchDomainConfig Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
domainToUpdate	string	Ne
updateDomainConfigParams	UpdateDomainConfigParams	Ne

Odgovor

Vraća: Option[PutDomainConfigResponse]

Primer

putDomainConfig Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

deleteEmailTemplate Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
id	string	Ne
errorId	string	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

deleteEmailTemplateRenderError Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[GetEmailTemplateResponse]

Primer

Primer getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametri

Name	Type	Required	Description
tenantId	string	Yes

Odgovor

Vraća: Option[GetEmailTemplateDefinitionsResponse]

Primer

Primer getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
skip	float64	No

Odgovor

Vraća: Option[GetEmailTemplateRenderErrorsResponse]

Primer

Primer getEmailTemplateRenderErrors

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # upotrebite odgovor po potrebi
else:
  # obradite nedostajući odgovor
  discard

getEmailTemplates

Parametri

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Odgovor

Vraća: Option[GetEmailTemplatesResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

updateEmailTemplate Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
urlId	string	Da
userIdWS	string	Ne
startTime	int64	Ne
endTime	int64	Ne

Odgovor

Vraća: Option[GetEventLogResponse]

Primer

getEventLog Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
urlId	string	Da
userIdWS	string	Ne
startTime	int64	Ne
endTime	int64	Ne

Odgovor

Vraća: Option[GetEventLogResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
createFeedPostParams	CreateFeedPostParams	Ne
options	CreateFeedPostPublicOptions	Ne

Odgovor

Vraća: Option[CreateFeedPostResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetFeedPostsOptions	Ne

Odgovor

Vraća: Option[GetFeedPostsResponse]

Primer

getFeedPosts Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

Odgovor

Vraća: Option[FeedPostsStatsResponse]

Primer

getFeedPostsStats Primer

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()
  # koristite statistiku po potrebi

getUserReactsPublic

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetUserReactsPublicOptions	No

Odgovor

Vraća: Option[UserReactsResponse]

Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
postId	string	Ne
updateFeedPostParams	UpdateFeedPostParams	Ne
options	UpdateFeedPostPublicOptions	Ne

Odgovor

Vraća: Option[CreateFeedPostResponse]

Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string = ""	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

flagCommentPublic Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
largeInternalURLSanitized	string	Ne

Odgovor

Vraća: Option[GifGetLargeResponse]

Primer

getGifLarge Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

Odgovor

Vraća: Option[GetGifsSearchResponse]

Primer

Primer getGifsSearch

Copy

let opts = GetGifsSearchOptions(limit = 10, rating = "g")
let (responseOpt, httpResponse) = client.getGifsSearch(tenantId = "my-tenant-123", search = "funny cats", options = opts)
if responseOpt.isSome:
  let resp = responseOpt.get()
  # koristite resp po potrebi

getGifsTrending

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetGifsTrendingOptions	Ne

Odgovor

Vraća: Option[GetGifsTrendingResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Ne

Odgovor

Vraća: Option[BulkCreateHashTagsResponse]

Primer

addHashTagsBulk Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
page	float64	Ne

Odgovor

Vraća: Option[GetHashTagsResponse]

Primer

getHashTags Primer

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

Parametri

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
options	DeleteModerationVoteOptions	No

Odgovor

Vraća: Option[VoteDeleteResponse]

Primer

deleteModerationVote Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetApiCommentsOptions	No

Odgovor

Vraća: Option[ModerationAPIGetCommentsResponse]

Primer

getApiComments Primer

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # dalja obrada se može izvršiti uz `resp`

getApiExportStatus

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetApiExportStatusOptions	Ne

Odgovor

Vraća: Option[ModerationExportStatusResponse]

Primer

Primer getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # koristite exportStatus po potrebi

getApiIds

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetApiIdsOptions	No

Odgovor

Vraća: Option[ModerationAPIGetCommentIdsResponse]

Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Odgovor

Vraća: Option[GetBannedUsersFromCommentResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Odgovor

Vraća: Option[GetCommentBanStatusResponse]

Primer

getCommentBanStatus Primer

Copy

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

getCommentChildren

Parametri

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

Odgovor

Vraća: Option[ModerationAPIChildCommentsResponse]

Primer

Primer 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

Parameters

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetCountOptions	Ne

Response

Vraća: Option[ModerationAPICountCommentsResponse]

Example

Primer getCount

Copy

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

getCounts

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
sso	string = ""	No

Odgovor

Vraća: Option[GetBannedUsersCountResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Odgovor

Vraća: Option[ModerationAPIGetLogsResponse]

Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
sso	string = ""	Ne

Odgovor

Vraća: Option[GetTenantManualBadgesResponse]

Primer

getManualBadges Primer

Copy

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

getManualBadgesForUser

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

Odgovor

Vraća: Option[GetUserManualBadgesResponse]

Primer

Primer getManualBadgesForUser

Copy

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

getModerationComment

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
options	GetModerationCommentOptions	No

Odgovor

Vraća: Option[ModerationAPICommentResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
sso	string = ""	Ne

Odgovor

Vraća: Option[GetCommentTextResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	GetSearchCommentsSummaryOptions	Ne

Odgovor

Vraća: Option[ModerationCommentSearchResponse]

Primer

getSearchCommentsSummary Primer

Copy

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

getSearchPages

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetSearchPagesOptions	Ne

Odgovor

Vraća: Option[ModerationPageSearchResponse]

Primer

getSearchPages Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetSearchSitesOptions	No

Odgovor

Returns: Option[ModerationSiteSearchResponse]

Primer

Primer getSearchSites

Copy

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

getSearchSuggest

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetSearchSuggestOptions	Ne

Odgovor

Vraća: Option[ModerationSuggestResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	GetTrustFactorOptions	Ne

Odgovor

Vraća: Option[GetUserTrustFactorResponse]

Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
options	PostBanUserFromCommentOptions	Ne

Odgovor

Vraća: Option[BanUserFromCommentResult]

Primer

postBanUserFromComment Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
banUserUndoParams	BanUserUndoParams	Ne
sso	string = ""	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

postBanUserUndo Primer

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

postCommentsByIds

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentsByIdsParams	CommentsByIdsParams	Ne
sso	string = ""	Ne

Odgovor

Vraća: Option[ModerationAPIChildCommentsResponse]

Primer

postCommentsByIds Primer

Copy

let tenantId = "my-tenant-123"
let params = CommentsByIdsParams(commentIds = @["cmt-001", "cmt-002"])
let (maybeResp, httpResp) = client.postCommentsByIds(tenantId = tenantId, commentsByIdsParams = params, sso = "")
if maybeResp.isSome:
  let resp = maybeResp.get()
  # koristite resp po potrebi

postFlagComment

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
options	PostFlagCommentOptions	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

postFlagComment Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
options	PostRestoreDeletedCommentOptions	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

postRestoreDeletedComment Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
options	PostSetCommentApprovalStatusOptions	Ne

Odgovor

Vraća: Option[SetCommentApprovedResponse]

Primer

postSetCommentApprovalStatus Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

postSetCommentSpamStatus Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
commentId	string	Da
options	PostUnFlagCommentOptions	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

postUnFlagComment Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

Odgovor

Vraća: Option[AwardUserBadgeResponse]

Primer

putAwardBadge Primer

Copy

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

putCloseThread

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
urlId	string	Da
sso	string = ""	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

putCloseThread Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
badgeId	string	Ne
options	PutRemoveBadgeOptions	Ne

Odgovor

Vraća: Option[RemoveUserBadgeResponse]

Primer

putRemoveBadge Primer

Copy

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

putReopenThread

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
urlId	string	Da
sso	string = ""	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

Primer putReopenThread

Copy

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

setTrustFactor

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	SetTrustFactorOptions	Ne

Odgovor

Vraća: Option[SetUserTrustFactorResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
createModeratorBody	CreateModeratorBody	Ne

Odgovor

Vraća: Option[CreateModeratorResponse]

Primer

Primer createModerator

Copy

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

deleteModerator

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
id	string	Ne
sendEmail	string = ""	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

Primer 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

Parametri

Name	Type	Required	Description
tenantId	string	Da
skip	float64	Ne

Odgovor

Vraća: Option[GetModeratorsResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

deleteNotificationCount Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetNotificationsOptions	No

Odgovor

Returns: Option[GetNotificationsResponse]

Primer

getNotifications Primer

Copy

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

updateNotification

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

updateNotification Primer

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

Parametri

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

Odgovor

Vraća: Option[CreateV1PageReact]

Primer

createV1PageReact Primer

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

Parameters

Ime	Tip	Obavezno
tenantId	string	Yes
urlId	string	Yes
id	string	No
title	string = ""	No

Response

Vraća: Option[CreateV1PageReact]

Primer

createV2PageReact Primer

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()
  # koristite `page` po potrebi

deleteV1PageReact

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vraća: Option[CreateV1PageReact]

Primer

deleteV1PageReact Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Returns: Option[GetV1PageLikes]

Primer

Primer getV1PageLikes

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let pageLikes = response.get()
  # koristite pageLikes po potrebi

getV2PageReacts

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Vraća: Option[GetV2PageReacts]

Primer

getV2PageReacts Primer

Copy

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

getV2PageReactUsers

Parameters

Naziv	Tip	Obavezno
tenantId	string	Yes
urlId	string	Yes
id	string	No

Response

Vraća: Option[GetV2PageReactUsersResponse]

Example

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

Parametri

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Odgovor

Vraća: Option[AddPageAPIResponse]

Primer

addPage Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[DeletePageAPIResponse]

Primer

deletePage Primer

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

Prethodni komentatori na stranici koji NISU trenutno online. Sortirano po displayName.
Koristite ovo nakon što iscrpite /users/online da prikažete sekciju „Members“.
Cursor paginacija po commenterName: server prolazi kroz parcijalni {tenantId, urlId, commenterName} indeks od afterName napred putem $gt, bez troška $skip.

Parameters

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

Response

Vraća: Option[PageUsersOfflineResponse]

Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vraća: Option[GetPageByURLIdAPIResponse]

Primer

getPageByURLId Primer

Copy

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

getPages

Parametri

Naziv	Tip	Obavezno	Opis

Odgovor

Vraća: Option[GetPagesAPIResponse]

Primer

Primer 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.

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	GetPagesPublicOptions	Ne

Odgovor

Vraća: Option[GetPublicPagesResponse]

Primer

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

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

Returns: Option[PageUsersInfoResponse]

Example

Primer getUsersInfo

Copy

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

patchPage

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
id	string	Ne
updateAPIPageData	UpdateAPIPageData	Ne

Odgovor

Vraća: Option[PatchPageAPIResponse]

Primer

patchPage Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetPendingWebhookEventCountOptions	No

Odgovor

Vraća: Option[GetPendingWebhookEventCountResponse]

Primer

Primer getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetPendingWebhookEventsOptions	Ne

Odgovor

Vraća: Option[GetPendingWebhookEventsResponse]

Primer

getPendingWebhookEvents Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

deleteQuestionConfig Primer

Copy

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

getQuestionConfig

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[GetQuestionConfigResponse]

Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
skip	float64	No

Odgovor

Vraća: Option[GetQuestionConfigsResponse]

Primer

Primer getQuestionConfigs

Copy

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

updateQuestionConfig

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

updateQuestionConfig Primer

Copy

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

createQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	No

Response

Vraća: Option[CreateQuestionResultResponse]

Example

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

deleteQuestionResult Primer

Copy

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

getQuestionResult

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[GetQuestionResultResponse]

Primer

Primer getQuestionResult

Copy

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

getQuestionResults

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetQuestionResultsOptions	No

Odgovor

Vraća: Option[GetQuestionResultsResponse]

Primer

Primer getQuestionResults

Copy

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

updateQuestionResult

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

updateQuestionResult Primer

Copy

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

aggregateQuestionResults

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	AggregateQuestionResultsOptions	Ne

Odgovor

Vraća: Option[AggregateQuestionResultsResponse]

Primer

aggregateQuestionResults Primer

Copy

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

bulkAggregateQuestionResults

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Odgovor

Vraća: Option[BulkAggregateQuestionResultsResponse]

Primer

bulkAggregateQuestionResults Primer

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

Parameters

Name	Type	Required	Description
tenantId	string	Da
options	CombineCommentsWithQuestionResultsOptions	Ne

Response

Vraća: Option[CombineQuestionResultsWithCommentsResponse]

Example

combineCommentsWithQuestionResults Primer

Copy

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

addSSOUser

Parameters

Ime	Tip	Obavezno	Opis
tenantId	string	Da
createAPISSOUserData	CreateAPISSOUserData	Ne

Response

Vraća: Option[AddSSOUserAPIResponse]

Example

addSSOUser Primer

Copy

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

deleteSSOUser

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Odgovor

Vraća: Option[DeleteSSOUserAPIResponse]

Primer

deleteSSOUser Primer

Copy

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

getSSOUserByEmail

Parametri

Name	Type	Required	Description
tenantId	string	Yes
email	string	No

Odgovor

Vraća: Option[GetSSOUserByEmailAPIResponse]

Primer

Primer getSSOUserByEmail

Copy

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

getSSOUserById

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[GetSSOUserByIdAPIResponse]

Primer

getSSOUserById Primer

Copy

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

getSSOUsers

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
skip	int	No

Odgovor

Vraća: Option[GetSSOUsersResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
id	string	Ne
updateAPISSOUserData	UpdateAPISSOUserData	Ne
updateComments	bool	Ne

Odgovor

Vraća: Option[PatchSSOUserAPIResponse]

Primer

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

Parameters

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Response

Vraća: Option[PutSSOUserAPIResponse]

Example

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ne

Odgovor

Vraća: Option[CreateSubscriptionAPIResponse]

Primer

createSubscription Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
userId	string = ""	Ne

Odgovor

Vraća: Option[GetSubscriptionsAPIResponse]

Primer

Primer getSubscriptions

Copy

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

updateSubscription

Parametri

Ime	Tip	Obavezno
tenantId	string	Da
id	string	Ne
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Ne
userId	string = ""	Ne

Odgovor

Vraća: Option[UpdateSubscriptionAPIResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[GetTenantPackageResponse]

Primer

Primer getTenantPackage

Copy

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

getTenantPackages

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vraća: Option[GetTenantPackagesResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

updateTenantPackage Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
createTenantUserBody	CreateTenantUserBody	Ne

Odgovor

Vraća: Option[CreateTenantUserResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

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

Parameters

Ime	Tip	Obavezno
tenantId	string	Da
id	string	Ne
redirectURL	string = ""	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

sendLoginLink Primer

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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
createTenantBody	CreateTenantBody	Ne

Odgovor

Vraća: Option[CreateTenantResponse]

Primer

createTenant Primer

Copy

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

deleteTenant

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
id	string	No
sure	string = ""	No

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

deleteTenant Primer

Copy

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

getTenant

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[GetTenantResponse]

Primer

Primer getTenant

Copy

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

getTenants

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	GetTenantsOptions	Ne

Odgovor

Vraća: Option[GetTenantsResponse]

Primer

getTenants Primer

Copy

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

updateTenant

Parametri

Naziv	Tip	Obavezno
tenantId	string	Da
id	string	Ne
updateTenantBody	UpdateTenantBody	Ne

Odgovor

Vraća: Option[APIEmptyResponse]

Primer

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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
userId	string	No
createTicketBody	CreateTicketBody	No

Odgovor

Vraća: Option[CreateTicketResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
id	string	No
userId	string = ""	No

Odgovor

Vraća: Option[GetTicketResponse]

Primer

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

Parametri

Ime	Tip	Obavezno
namespace	string	Ne
component	string	Ne
options	GetTranslationsOptions	Ne

Odgovor

Vraća: Option[GetTranslationsResponse]

Primer

Primer 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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vraća: Option[APIGetUserBadgeProgressResponse]

Primer

Primer getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
userId	string	No

Odgovor

Vraća: Option[APIGetUserBadgeProgressResponse]

Primer

Primer 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

Parametri

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	No

Odgovor

Vraća: Option[APICreateUserBadgeResponse]

Primer

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

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[APIGetUserBadgeResponse]

Primer

getUserBadge Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
options	GetUserBadgesOptions	No

Odgovor

Vraća: Option[APIGetUserBadgesResponse]

Primer

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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Yes
sso	string = ""	No

Odgovor

Vraća: Option[GetUserNotificationCountResponse]

Primer

getUserNotificationCount Primer

Copy

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

getUserNotifications

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
options	GetUserNotificationsOptions	Ne

Odgovor

Vraća: Option[GetMyNotificationsResponse]

Primer

Primer getUserNotifications

Copy

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

resetUserNotificationCount

Parameters

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

Response

Vraća: Option[ResetUserNotificationsResponse]

Example

Primer 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

Parametri

Ime	Tip	Obavezno	Opis
tenantId	string	Da
options	ResetUserNotificationsOptions	Ne

Odgovor

Vraća: Option[ResetUserNotificationsResponse]

Primer

resetUserNotifications Primer

Copy

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

updateUserNotificationCommentSubscriptionStatus

Omogući ili onemogući obaveštenja za određeni komentar.

Parameters

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

Response

Vraća: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Primer

Primer 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

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

Parameters

Ime	Tip	Obavezno
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Response

Vraća: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Example

Primer updateUserNotificationPageSubscriptionStatus

Copy

let (optResp, httpResp) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-456",
  url = "https://example.com/news/article-456",
  pageTitle = "Breaking News: Something Happened",
  subscribedOrUnsubscribed = "subscribed",
  sso = ""
)
if optResp.isSome:
  let resp = optResp.get()
  # dalja obrada sa resp

updateUserNotificationStatus

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
notificationId	string	No
newStatus	string	No
sso	string = ""	No

Odgovor

Vraća: Option[UpdateUserNotificationStatusResponse]

Primer

updateUserNotificationStatus Primer

Copy

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

getUserPresenceStatuses

Parametri

Naziv	Tip	Obavezno
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

Odgovor

Returns: Option[GetUserPresenceStatusesResponse]

Primer

Primer 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

Parametri

Ime	Tip	Obavezno
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

Odgovor

Vraća: Option[SearchUsersResult]

Primer

searchUsers Primer

Copy

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

getUser

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vraća: Option[GetUserResponse]

Primer

getUser Primer

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

Parametri

Naziv	Tip	Obavezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vraća: Option[GetVotesResponse]

Primer

Primer getVotes

Copy

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

getVotesForUser

Параметри

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

Одговор

Враћа: Option[GetVotesForUserResponse]

Пример

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

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

Захтеви

Инсталација

Korišćenje Nimble

Građenje iz izvornog koda

Sadržaj biblioteke

Javni vs zaštićeni API‑ji

Брз почетак

Korišćenje autentifikovanih API‑ja (DefaultAPI)

Korišćenje javnih API‑ja (PublicAPI)

Korišćenje moderacijskih API‑ja (ModerationAPI)

Česti problemi

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

Primer: Dohvatanje komentara

Напомене

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

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

Коришћење SSO

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

Безбедан SSO

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

Документација за API крајње тачке

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

aggregate

Parametri

Odgovor

Primer

getAuditLogs

Parametri

Odgovor

Primer

logoutPublic

Одговор

Пример