FastComments Nim SDK

To je uradni Nim SDK za FastComments.

Uradni Nim SDK za FastComments API

Repozitorij

Zahteve

Nim >= 1.6.0
nimcrypto >= 0.5.4

Namestitev

Uporaba Nimble

nimble install fastcomments

Gradnja iz izvorne kode

nimble build

Vsebina knjižnice

Ta knjižnica vsebuje generiran odjemalec API in SSO orodja za lažje delo z API-jem.

Dokumentacija knjižnice odjemalca API

Javni in zavarovani API-ji

Za odjemalca API so na voljo trije moduli API, api_default, api_public in api_moderation. api_default vsebuje metode, ki zahtevajo vaš API ključ, api_public pa vsebuje klice API-ja, ki jih je mogoče izvajati neposredno iz brskalnika/mobilne naprave/itd. brez overjanja. Modul api_moderation vsebuje metode za nadzorno ploščo moderatorja.

Metode api_moderation zajemajo izpisovanje, štetje, iskanje in izvoz komentarjev in njihovih dnevnikov; moderacijske ukrepe, kot so odstranjevanje/obnavljanje komentarjev, prijavljanje, nastavljanje statusa pregleda/spama/odobritve, spreminjanje glasov ter ponovno odpiranje/zapiranje nití; prepovedi (blokiranje uporabnika glede komentiranja, razveljavitev prepovedi, povzetki pred prepovedjo, stanje in nastavitve prepovedi ter število prepovedanih uporabnikov); in značke ter zaupanje (podeljevanje/odstranjevanje značke, seznam ročnih značk, pridobivanje/nastavljanje faktorja zaupanja uporabnika in pridobitev notranjega profila uporabnika). Vsaka metoda api_moderation sprejme parameter sso, tako da je klic avtenticiran kot SSO moderator.

Hiter začetek

Uporaba avtenticiranih API-jev (DefaultAPI)

Pomembno: Avtenticirane končne točke zahtevajo, da je vaš API ključ nastavljen v glavi 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"

# Izvedi avtenticirane API klice
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  page = 0,
  limit = 0,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "your-url-id",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.DESC
)

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

Uporaba javnih API-jev (PublicAPI)

Javne končne točke ne zahtevajo avtentikacije:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Izvedi javne API klice
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  page = 0,
  direction = SortDirections.DESC,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 0,
  limitChildren = 0,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = false,
  countAll = false,
  includei10n = false,
  locale = "",
  modules = "",
  isCrawler = false,
  includeNotificationCount = false,
  asTree = false,
  maxTreeDepth = 0,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "",
  hashTags = @[],
  userId = "",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)

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

Uporaba moderacijskih API-jev (ModerationAPI)

Moderacijske končne točke poganjajo nadzorno ploščo moderatorja in so avtenticirane z SSO žetonom aktivnega moderatorja:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Naštej komentarje v moderacijskem vmesniku
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Pogoste težave

401 napaka avtentikacije: Prepričajte se, da nastavite glavo x-api-key na svojem HttpClient pred izvajanjem DefaultAPI zahtev: client.headers["x-api-key"] = "your-api-key"
Napačen razred API: Uporabite api_default za strežniške avtenticirane zahteve, api_public za odjemalčeve/javne zahteve in api_moderation za zahteve nadzorne plošče moderatorja.

Klicanje API-ja

Vse API metode v tem SDK vračajo pare (Option[ResponseType], Response). Prvi element vsebuje razčlenjen odgovor, če je zahteva uspešna, drugi element pa je surovi HTTP odgovor.

Primer: Pridobivanje komentarjev

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",
  page = 0,
  limit = 0,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "your-url-id",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  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"

Opombe

ID-ji oddaj

Opazili boste, da morate v nekaterih klicih API posredovati broadcastId. Ko prejmete dogodke, boste ta ID prejeli nazaj, zato boste vedeli, naj dogodek prezrete, če nameravate optimistično uporabiti spremembe na odjemalcu (kar boste verjetno želeli narediti, saj zagotavlja najboljšo izkušnjo). Tukaj posredujte UUID. ID naj bo dovolj edinstven, da se v eni seji brskalnika ne pojavi dvakrat.

SSO (Enkratna prijava)

Za primere SSO glejte spodaj.

Uporaba SSO

Enostaven 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

Varen 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

Dokumentacija za fastcomments

Dokumentacija za API končne točke

Vsi URI-ji so relativni na https://fastcomments.com

Razred	Metoda	HTTP zahteva	Opis
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	Združuje dokumente glede na skupine (če je podan groupBy) in izvaja več operacij. Podprte so različne operacije (npr. sum, countDistinct, avg itd.).
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	zahteva 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/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/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}	zahteva tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	zahteva tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	zahteva 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}	zahteva tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Pretekli komentatorji na strani, ki trenutno NISO na spletu. Razvrščeni po displayName. Uporabite to potem, ko izčrpate /users/online, za prikaz odseka »Člani«. Paginacija s kurzorjem po commenterName: strežnik prehodi delni indeks {tenantId, urlId, commenterName} naprej preko $gt, brez $skip stroška.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Trenutno prisotni gledalci strani: ljudje, katerih websocket seja je trenutno naročena na stran. Vrne anonCount + totalCount (vsi naročeni v sobi, vključno z anonimnimi gledalci, ki jih ne naštevamo).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Seznam strani za najemnika. Uporablja ga namizni odjemalec FChat za izpolnjevanje seznama sob. Zahteva, da je `enableFChat` nastavljen na true v prilagojeni konfiguraciji vsake strani. Strani, ki zahtevajo SSO, se filtrirajo glede na dostop skupine uporabnika, ki pošilja zahtevo.
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	Skupinski podatki o uporabnikih za najemnika. Glede na userIds vrne prikazne podatke iz User / SSOUser. Uporablja ga pripomoček za komentarje za obogatitev uporabnikov, ki so se pravkar pojavili z dogodkom prisotnosti. Brez konteksta strani: zasebnost je enotno zagotovljena (zasebni profili so zakriti).
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}	Omogoči ali onemogoči obvestila za določen komentar.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Omogoči ali onemogoči obvestila za stran. Ko so uporabniki naročeni na stran, se obvestila ustvarjajo za nove glavne komentarje, prav tako pa tudi
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Naloži in spremeni velikost slike
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentacija za modele

aggregate

Agregira dokumente z združevanjem (če je podan groupBy) in izvajanjem več operacij. Podprte so različne operacije (npr. sum, countDistinct, avg itd.).

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
aggregationRequest	AggregationRequest	Ne
parentTenantId	string	Ne
includeStats	bool	Ne

Odgovor

Vrne: Option[AggregateResponse]

Primer

Primer agregacije

Copy

let (response, httpResponse) = client.aggregate(
  tenantId = "my-tenant-123",
  aggregationRequest = AggregationRequest(groupBy = @["articleId"], metrics = @["commentCount"], filters = @[], limit = 0),
  parentTenantId = "",
  includeStats = false
)
if response.isSome:
  let agg = response.get()
  discard agg

getAuditLogs

Parametri

Name	Type	Required
tenantId	string	Da
limit	float64	Ne
skip	float64	Ne
order	SORTDIR	Ne
after	float64	Ne
before	float64	Ne

Odgovor

Vrne: Option[GetAuditLogsResponse]

Primer

Primer getAuditLogs

Copy

let (response, httpResponse) = client.getAuditLogs(
  tenantId = "my-tenant-123",
  limit = 50.0,
  skip = 0.0,
  order = SORTDIR.DESC,
  after = 1622505600.0,
  before = 1625097600.0
)
if response.isSome:
  let logs = response.get()
  echo logs
else:
  echo "No audit logs returned"

logoutPublic

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

logoutPublic Primer

Copy

let (response, httpResponse) = client.logoutPublic(tenantId = "my-tenant-123", sessionId = "sess-9a8b7c6d", userId = "editor-87", revokeAll = false, ipAddress = "")
if response.isSome:
  let emptyResp = response.get()
  echo "Logout successful for user: ", "editor-87"
else:
  echo "Logout failed"

blockFromCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ne
sso	string	Ne

Odgovor

Vrne: Option[BlockSuccess]

Primer

Primer blockFromCommentPublic

Copy

let publicParams = PublicBlockFromCommentParams(
  reason = "Repeated spam links",
  durationMinutes = 1440,
  blockAll = true,
  notifyUser = false,
  tags = @["spam", "auto-block"]
)
let (response, httpResponse) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  publicBlockFromCommentParams = publicParams,
  sso = ""
)
if response.isSome:
  let blockResult = response.get()
  echo "Block succeeded: ", $blockResult
else:
  echo "Block failed, HTTP status: ", $httpResponse.status

unBlockCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ne
sso	string	Ne

Odgovor

Vrne: Option[UnblockSuccess]

Primer

unBlockCommentPublic Primer

Copy

let (response, httpResponse) = client.unBlockCommentPublic(tenantId = "my-tenant-123", commentId = "cmt-987654321", publicBlockFromCommentParams = PublicBlockFromCommentParams(), sso = "")
if response.isSome:
  let unblockResult = response.get()
  discard unblockResult
else:
  discard httpResponse

checkedCommentsForBlocked

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentIds	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[CheckBlockedCommentsResponse]

Primer

Primer checkedCommentsForBlocked

Copy

let (response, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "",
  sso = ""
)
if response.isSome:
  let blockedResp = response.get()
  echo "Received blocked comments response: ", blockedResp
else:
  echo "No response body; HTTP status: ", $httpResponse.status

blockUserFromComment

Parametri

Name	Type	Required
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Odgovor

Vrača: Option[BlockSuccess]

Primer

Primer uporabe blockUserFromComment

Copy

let (response, httpResponse) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "cmt-7890",
  blockFromCommentParams = BlockFromCommentParams(
    reason = "Repeated abusive language",
    durationMinutes = 1440,
    notifyUser = true,
    tags = @["abuse", "automated"]
  ),
  userId = "user-456",
  anonUserId = ""
)
if response.isSome:
  let result = response.get()
  discard result
else:
  discard httpResponse

createCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
broadcastId	string	Ne
commentData	CommentData	Ne
sessionId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[SaveCommentsResponseWithPresence]

Primer

Primer createCommentPublic

Copy

let commentPayload = CommentData(
  text = "Great write-up on serverless architectures.",
  authorName = "Jane Doe",
  authorEmail = "jane.doe@example.com",
  isPublic = true,
  tags = @["tech", "serverless"]
)
let (response, httpResponse) = client.createCommentPublic(
  tenantId = "my-tenant-123",
  urlId = "news/2026/06/fastcomments-sdk-update",
  broadcastId = "broadcast-2026-06-19",
  commentData = commentPayload,
  sessionId = "sess-8a7b6c",
  sso = "sso-jwt-abc123"
)
if response.isSome:
  let saved = response.get()
  discard saved

deleteComment

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
contextUserId	string	Ne
isLive	bool	Ne

Odgovor

Vrne: Option[DeleteCommentResult]

Primer

Primer deleteComment

Copy

let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "cmt-98765", contextUserId = "user-456", isLive = true)
if response.isSome:
  let result = response.get()
  echo "DeleteCommentResult received"
else:
  echo "No result, HTTP status: ", httpResponse.status

deleteCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[PublicAPIDeleteCommentResponse]

Primer

Primer deleteCommentPublic

Copy

let (response, httpResponse) = client.deleteCommentPublic(tenantId = "my-tenant-123", commentId = "cmt-987654321", broadcastId = "", editKey = "", sso = "")
if response.isSome:
  let deleted = response.get()
  echo "Delete acknowledged, HTTP status: ", httpResponse.status

deleteCommentVote

Parametri

Name	Type	Obvezno
tenantId	string	Da
commentId	string	Da
voteId	string	Ne
urlId	string	Da
broadcastId	string	Ne
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[VoteDeleteResponse]

Primer

Primer deleteCommentVote

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "comment-456",
  voteId = "vote-789",
  urlId = "news/article-title",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  echo "Vote delete response:", voteResp
else:
  echo "No response body, HTTP response:", httpResponse

flagComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrača: Option[FlagCommentResponse]

Primer

flagComment Primer

Copy

let (response, httpResponse) = client.flagComment(
  tenantId = "my-tenant-123",
  id = "cmt-98765",
  userId = "user-12345",
  anonUserId = ""
)
if response.isSome:
  let flagResp = response.get()
  echo "Flag response received"
else:
  echo "No flag response returned"

getComment

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIGetCommentResponse]

Primer

Primer getComment

Copy

let (response, httpResponse) = client.getComment(tenantId = "my-tenant-123", id = "cmt-7890")
if response.isSome:
  let comment = response.get()
  discard comment
else:
  echo "Comment not found"

getComments

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
page	int	Ne
limit	int	Ne
skip	int	Ne
asTree	bool	Ne
skipChildren	int	Ne
limitChildren	int	Ne
maxTreeDepth	int	Ne
urlId	string	Da
userId	string	Ne
anonUserId	string	Ne
contextUserId	string	Ne
hashTag	string	Ne
parentId	string	Ne
direction	SortDirections	Ne
fromDate	int64	Ne
toDate	int64	Ne

Odgovor

Vrača: Option[APIGetCommentsResponse]

Primer

Primer getComments

Copy

let (response, httpResponse) = client.getComments(
  tenantId = "my-tenant-123",
  page = 1,
  limit = 25,
  skip = 0,
  asTree = true,
  skipChildren = 0,
  limitChildren = 5,
  maxTreeDepth = 3,
  urlId = "news/2026-global-economy",
  userId = "user-789",
  anonUserId = "",
  contextUserId = "",
  hashTag = "economy",
  parentId = "",
  direction = SortDirections.Desc,
  fromDate = 1710000000000'i64,
  toDate = 1710100000000'i64
)
if response.isSome:
  let commentsResp = response.get()
  discard commentsResp

getCommentsPublic

req tenantId urlId

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
urlId	string	Da
page	int	Ne
direction	SortDirections	Ne
sso	string	Ne
skip	int	Ne
skipChildren	int	Ne
limit	int	Ne
limitChildren	int	Ne
countChildren	bool	Ne
fetchPageForCommentId	string	Ne
includeConfig	bool	Ne
countAll	bool	Ne
includei10n	bool	Ne
locale	string	Ne
modules	string	Ne
isCrawler	bool	Ne
includeNotificationCount	bool	Ne
asTree	bool	Ne
maxTreeDepth	int	Ne
useFullTranslationIds	bool	Ne
parentId	string	Ne
searchText	string	Ne
hashTags	seq[string]	Ne
userId	string	Ne
customConfigStr	string	Ne
afterCommentId	string	Ne
beforeCommentId	string	Ne

Odgovor

Vrne: Option[GetCommentsResponseWithPresencePublicComment]

Primer

Primer getCommentsPublic

Copy

let (response, httpResponse) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  page = 2,
  direction = SortDirections.Descending,
  sso = "",
  skip = 0,
  skipChildren = 0,
  limit = 25,
  limitChildren = 5,
  countChildren = false,
  fetchPageForCommentId = "",
  includeConfig = true,
  countAll = false,
  includei10n = true,
  locale = "en-US",
  modules = "reactions,moderation",
  isCrawler = false,
  includeNotificationCount = true,
  asTree = true,
  maxTreeDepth = 3,
  useFullTranslationIds = false,
  parentId = "",
  searchText = "climate change",
  hashTags = @["climate", "research"],
  userId = "user-789",
  customConfigStr = "",
  afterCommentId = "",
  beforeCommentId = ""
)
if response.isSome:
  let commentsResp = response.get()
  echo "Received comments response:"
  echo commentsResp
else:
  echo "No comments returned. HTTP status:", httpResponse.status

getCommentText

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[PublicAPIGetCommentTextResponse]

Primer

Primer getCommentText

Copy

let (response, httpResponse) = client.getCommentText(tenantId = "my-tenant-123", commentId = "cmt-987654321", editKey = "", sso = "")
if response.isSome:
  let commentTextResp = response.get()
  echo commentTextResp
else:
  echo "No comment text returned"

getCommentVoteUserNames

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
dir	int	Ne
sso	string	Ne

Odgovor

Vrne: Option[GetCommentVoteUserNamesSuccessResponse]

Primer

Primer getCommentVoteUserNames

Copy

let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "cmt-987654", dir = 0, sso = "")
if response.isSome:
  let success: GetCommentVoteUserNamesSuccessResponse = response.get()
  discard success

lockComment

Parameters

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer uporabe lockComment

Copy

let (response, httpResponse) = client.lockComment(tenantId = "news-tenant-42", commentId = "cmt-8f3a2b9d", broadcastId = "", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Locked comment successfully for tenant news-tenant-42"
else:
  echo "Failed to lock comment, HTTP status: ", $httpResponse.status

pinComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Odziv

Vrne: Option[ChangeCommentPinStatusResponse]

Primer

Primer pinComment

Copy

let (response, httpResponse) = client.pinComment(tenantId = "my-tenant-123", commentId = "cmt-98765", broadcastId = "", sso = "")
if response.isSome:
  let pinnedResp = response.get()
  echo "Pin status updated for comment cmt-98765"
else:
  echo "No response received"

saveComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createCommentParams	CreateCommentParams	Ne
isLive	bool	Ne
doSpamCheck	bool	Ne
sendEmails	bool	Ne
populateNotifications	bool	Ne

Odgovor

Vrne: Option[APISaveCommentResponse]

Primer

Primer saveComment

Copy

let createCommentParams = CreateCommentParams(
  urlId = "news/2026/major-policy-change",
  content = "This is a thoughtful comment on the policy change and its potential impacts.",
  authorName = "Morgan Lee",
  authorEmail = "morgan.lee@example.org",
  tags = @["policy","analysis"],
  extraData = @[])
let (response, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = createCommentParams,
  isLive = true,
  doSpamCheck = true,
  sendEmails = false,
  populateNotifications = true)
if response.isSome:
  let saved = response.get()
  discard saved

saveCommentsBulk

Parametri

Ime	Type	Obvezno
tenantId	string	Da
createCommentParams	seq[CreateCommentParams]	Ne
isLive	bool	Ne
doSpamCheck	bool	Ne
sendEmails	bool	Ne
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	Ne
id	string	Ne
fromName	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer saveCommentsBulk

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  isLive = false,
  doSpamCheck = false,
  sendEmails = false,
  populateNotifications = false,
  id = "",
  fromName = ""
)
if response.isSome:
  let apiResp = response.get()
  echo "Bulk save succeeded, tenant:", " my-tenant-123"
else:
  echo "Bulk save returned no API response"

setCommentText

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
commentTextUpdateRequest	CommentTextUpdateRequest	Ne
editKey	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[PublicAPISetCommentTextResponse]

Primer

Primer setCommentText

Copy

let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  broadcastId = "",
  commentTextUpdateRequest = CommentTextUpdateRequest(text: "Updated comment text to fix a typo and clarify meaning."),
  editKey = "",
  sso = ""
)
if response.isSome:
  let result = response.get()
  discard result

unBlockUserFromComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
unBlockFromCommentParams	UnBlockFromCommentParams	Ne
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: Option[UnblockSuccess]

Primer

unBlockUserFromComment Primer

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-9f3b2a",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-1024",
  anonUserId = "anon-77b"
)
if response.isSome:
  let unblockResult = response.get()
  echo unblockResult
else:
  echo "Unblock failed"

unFlagComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: Option[FlagCommentResponse]

Primer

unFlagComment Primer

Copy

let (response, httpResponse) = client.unFlagComment(tenantId = "my-tenant-123",
  id = "comment-98765",
  userId = "user-12345",
  anonUserId = "")
if response.isSome:
  let flagResp = response.get()
  echo "Unflagged comment response:", flagResp
else:
  echo "Unflag failed, HTTP status:", httpResponse.status

unLockComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrača: Option[APIEmptyResponse]

Primer

Primer unLockComment

Copy

let tenantId = "my-tenant-123"
let commentId = "cmt-987654321"
let (response, httpResponse) = client.unLockComment(
  tenantId = tenantId,
  commentId = commentId,
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let apiResp = response.get()
  echo "Unlocked comment ", commentId, " for tenant ", tenantId
else:
  echo "Unlock failed, HTTP status: ", $httpResponse.status

unPinComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[ChangeCommentPinStatusResponse]

Primer

Primer unPinComment

Copy

let (response, httpResponse) = client.unPinComment(tenantId = "my-tenant-123", commentId = "cmt-987654321", broadcastId = "", sso = "")
if response.isSome:
  let result = response.get()
  echo "Unpinned comment:", $result
else:
  echo "Unpin failed, HTTP status:", $httpResponse.status

updateComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updatableCommentParams	UpdatableCommentParams	Ne
contextUserId	string	Ne
doSpamCheck	bool	Ne
isLive	bool	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateComment

Copy

let (response, httpResponse) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "cmt-987654",
  updatableCommentParams = UpdatableCommentParams(
    text = "Updated comment: corrected facts and clarified wording.",
    isApproved = true,
    tags = @["news", "update"]
  ),
  contextUserId = "user-456",
  doSpamCheck = true,
  isLive = true
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp

voteComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
urlId	string	Da
broadcastId	string	Ne
voteBodyParams	VoteBodyParams	Ne
sessionId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[VoteResponse]

Primer

voteComment Primer

Copy

let (response, httpResponse) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654321",
  urlId = "news/article-2026-inflation",
  broadcastId = "",
  voteBodyParams = VoteBodyParams(),
  sessionId = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  discard voteResp
else:
  discard httpResponse

getCommentsForUser

Parametri

Name	Type	Obvezno
userId	string	Ne
direction	SortDirections	Ne
repliesToUserId	string	Ne
page	float64	Ne
includei10n	bool	Ne
locale	string	Ne
isCrawler	bool	Ne

Odgovor

Vrne: Option[GetCommentsForUserResponse]

Primer

Primer getCommentsForUser

Copy

let (response, httpResponse) = client.getCommentsForUser(
  userId = "user-8421",
  direction = SortDirections.Newest,
  repliesToUserId = "",
  page = 1.0,
  includei10n = true,
  locale = "en-US",
  isCrawler = false
)
if response.isSome:
  let comments = response.get()
  discard comments

addDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
addDomainConfigParams	AddDomainConfigParams	Ne

Odgovor

Vrača: Option[AddDomainConfigResponse]

Primer

Primer addDomainConfig

Copy

let config = AddDomainConfigParams(
  domain: "comments.example-news.com",
  enabled: true,
  allowedOrigins: @["https://www.example-news.com", "https://m.example-news.com"],
  commentsPath: "/news/world/election-coverage",
  priority: 5
)
let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = config)
if response.isSome:
  let created = response.get()
  echo "Created domain config:", created
else:
  echo "Failed to create domain config, HTTP status:", httpResponse.status.code

deleteDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
domain	string	Ne

Odgovor

Vrača: Option[DeleteDomainConfigResponse]

Primer

Primer deleteDomainConfig

Copy

let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let deleted = response.get()
  echo "DeleteDomainConfig succeeded for tenant ", "my-tenant-123"
else:
  echo "DeleteDomainConfig failed. HTTP status: ", $httpResponse.status

getDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
domain	string	Ne

Odgovor

Vrne: Option[GetDomainConfigResponse]

Primer

Primer getDomainConfig

Copy

let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news/top-story-2026")
if response.isSome:
  let cfg = response.get()
  discard cfg
else:
  discard httpResponse

getDomainConfigs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrača: Option[GetDomainConfigsResponse]

Primer

Primer getDomainConfigs

Copy

let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if response.isSome:
  let domainConfigs = response.get()
  echo "Received domain configs for tenant my-tenant-123"
  echo domainConfigs
else:
  echo "No domain configs returned"

patchDomainConfig

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
domainToUpdate	string	Ne
patchDomainConfigParams	PatchDomainConfigParams	Ne

Odgovor

Vrne: Option[PatchDomainConfigResponse]

Primer

Primer patchDomainConfig

Copy

let patchParams: PatchDomainConfigParams = PatchDomainConfigParams(
  allowedOrigins = @["https://news.example.com", "https://cdn.news.com"],
  enableComments = true,
  moderationRequired = false,
  maxCommentLength = 2000,
  primaryDomain = "comments.news-site.com"
)
let (response, httpResponse) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "comments.news-site.com",
  patchDomainConfigParams = patchParams
)
if response.isSome:
  let cfg = response.get()
  echo "Patched domain config received:", cfg
else:
  echo "No response body, HTTP status:", httpResponse.statusCode

putDomainConfig

Parametri

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

Odgovor

Vrne: Option[PutDomainConfigResponse]

Primer

Primer putDomainConfig

Copy

let (response, httpResponse) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "blog.example.com",
  updateDomainConfigParams = UpdateDomainConfigParams(
    allowAnonymous = false,
    moderationEnabled = true,
    maxCommentLength = 800,
    allowedOrigins = @["https://blog.example.com", "https://cdn.blog.example.com"],
    enableThreadedComments = true
  )
)
if response.isSome:
  let cfg = response.get()
  echo cfg
else:
  echo "Failed to update domain config, HTTP status: ", httpResponse.status

createEmailTemplate

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createEmailTemplateBody	CreateEmailTemplateBody	Ne

Odgovor

Vrača: Option[CreateEmailTemplateResponse]

Primer

Primer createEmailTemplate

Copy

let (response, httpResponse) = client.createEmailTemplate(tenantId = "my-tenant-123",
  createEmailTemplateBody = CreateEmailTemplateBody(
    name = "Weekly Newsletter",
    subject = "This Week on NewsSite",
    html = "<h1>Latest updates</h1><p>Read our latest article.</p>",
    fromAddress = "no-reply@newssite.com",
    isDefault = false,
    tags = @["news", "weekly"]
  )
)
if response.isSome:
  let template = response.get()
  echo "Created email template id: ", template.id

deleteEmailTemplate

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Response

Vrača: Option[APIEmptyResponse]

Primer

Primer deleteEmailTemplate

Copy

let (response, httpResponse) = client.deleteEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-email-template-001"
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty
  echo "Email template deleted successfully"
else:
  echo "No response body"

deleteEmailTemplateRenderError

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
errorId	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteEmailTemplateRenderError

Copy

let (response, httpResponse) = client.deleteEmailTemplateRenderError(tenantId = "my-tenant-123", id = "welcome-email-template", errorId = "err-20250615-01")
if response.isSome:
  let emptyResp = response.get()
  echo "Deleted render error, tenant:", "my-tenant-123"
  echo "HTTP status:", httpResponse.status
else:
  echo "No body returned, HTTP status:", httpResponse.status

getEmailTemplate

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetEmailTemplateResponse]

Primer

Primer getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrača: Option[GetEmailTemplateDefinitionsResponse]

Primer

Primer getEmailTemplateDefinitions

Copy

let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if response.isSome:
  let definitions = response.get()
  echo "Email template definitions for my-tenant-123: ", definitions
else:
  echo "Failed to retrieve templates, HTTP status: ", httpResponse.status

getEmailTemplateRenderErrors

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
skip	float64	Ne

Odgovor

Vrne: Option[GetEmailTemplateRenderErrorsResponse]

Primer

Primer getEmailTemplateRenderErrors

Copy

let (response, httpResponse) = client.getEmailTemplateRenderErrors(tenantId = "my-tenant-123", id = "", skip = 0.0)
if response.isSome:
  let templateErrors = response.get()
  discard templateErrors
else:
  discard httpResponse

getEmailTemplates

Parametri

Name	Type	Required	Description
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrne: Option[GetEmailTemplatesResponse]

Primer

getEmailTemplates Primer

Copy

let (response, httpResponse) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let templates = response.get()
  echo templates
else:
  echo "No email templates available"

renderEmailTemplate

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
renderEmailTemplateBody	RenderEmailTemplateBody	Ne
locale	string	Ne

Odgovor

Vrne: Option[RenderEmailTemplateResponse]

Primer

renderEmailTemplate Primer

Copy

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

updateEmailTemplate

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
updateEmailTemplateBody	UpdateEmailTemplateBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateEmailTemplate

Copy

let updateBody = UpdateEmailTemplateBody(
  subject = "Welcome to Newsly",
  html = "<p>Thanks for joining Newsly! Visit https://newsly.example to get started.</p>",
  fromAddress = "no-reply@newsly.example",
  fromName = "Newsly Team",
  enabled = true
)
let (response, httpResponse) = client.updateEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email", updateEmailTemplateBody = updateBody)
if response.isSome:
  let result = response.get()
  discard result
else:
  discard httpResponse.statusCode

getEventLog

req tenantId urlId userIdWS

Parametri

Name	Type	Required
tenantId	string	Da
urlId	string	Da
userIdWS	string	Ne
startTime	int64	Ne
endTime	int64	Ne

Odziv

Vrne: Option[GetEventLogResponse]

Primer

Primer getEventLog

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-2026-solar-panels",
  userIdWS = "user-456",
  startTime = 1688000000'i64,
  endTime = 1688086400'i64
)
if response.isSome:
  let eventLog = response.get()
  discard eventLog

getGlobalEventLog

req tenantId urlId userIdWS

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
userIdWS	string	Ne
startTime	int64	Ne
endTime	int64	Ne

Odgovor

Vrne: Option[GetEventLogResponse]

Primer

Primer getGlobalEventLog

Copy

let (response, httpResponse) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-2026-06-19",
  userIdWS = "user-987",
  startTime = int64(1622505600),
  endTime = int64(1625097600)
)
if response.isSome:
  let eventLog = response.get()
  echo eventLog, httpResponse.statusCode

createFeedPost

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createFeedPostParams	CreateFeedPostParams	Ne
broadcastId	string	Ne
isLive	bool	Ne
doSpamCheck	bool	Ne
skipDupCheck	bool	Ne

Odgovor

Vrne: Option[CreateFeedPostsResponse]

Primer

Primer createFeedPost

Copy

let postParams = CreateFeedPostParams(
  title = "Major Acquisition by TechCorp",
  content = "TechCorp has acquired SoftWorks in a deal valued at $1.2B, creating a new market leader.",
  url = "news/tech/major-acquisition",
  tags = @["business", "technology"],
  authorId = "journalist-321"
)
let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = postParams,
  broadcastId = "",
  isLive = false,
  doSpamCheck = false,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  discard created

createFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createFeedPostParams	CreateFeedPostParams	Ne
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[CreateFeedPostResponse]

Primer

Primer createFeedPostPublic

Copy

let params = CreateFeedPostParams(
  title = "Breaking: Major Update on Product X",
  content = "Today we released Product X v2.0 with performance improvements and bug fixes.",
  author = "jane.doe",
  tags = @["product", "release", "v2"],
  isPinned = false
)
let (response, httpResponse) = client.createFeedPostPublic(tenantId = "my-tenant-123", createFeedPostParams = params, broadcastId = "", sso = "")
if response.isSome:
  let created = response.get()
  echo "Created feed post:", created
else:
  echo "Failed to create feed post; HTTP status:", httpResponse.status

deleteFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Ne
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrača: Option[DeleteFeedPostPublicResponse]

Primer

Primer deleteFeedPostPublic

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(tenantId = "my-tenant-123", postId = "", broadcastId = "", sso = "")
if response.isSome:
  let deleted = response.get()
  echo "Delete successful"
else:
  echo "Delete failed"

getFeedPosts

req tenantId afterId

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
afterId	string	Ne
limit	int	Ne
tags	seq[string]	Ne

Odziv

Vrne: Option[GetFeedPostsResponse]

Primer

Primer getFeedPosts

Copy

let (response, httpResponse) = client.getFeedPosts(
  tenantId = "my-tenant-123",
  afterId = "",
  limit = 0,
  tags = @[]
)
if response.isSome:
  let feed = response.get()
  echo "Feed retrieved for tenant my-tenant-123"

getFeedPostsPublic

req tenantId afterId

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
afterId	string	Ne
limit	int	Ne
tags	seq[string]	Ne
sso	string	Ne
isCrawler	bool	Ne
includeUserInfo	bool	Ne

Odgovor

Vrne: Option[PublicFeedPostsResponse]

Primer

Primer getFeedPostsPublic

Copy

let (response, httpResponse) = client.getFeedPostsPublic(
  tenantId = "my-tenant-123",
  afterId = "",
  limit = 0,
  tags = @[],
  sso = "",
  isCrawler = false,
  includeUserInfo = false
)
if response.isSome:
  let feed = response.get()
  discard feed

getFeedPostsStats

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postIds	seq[string]	Ne
sso	string	Ne

Odgovor

Vrne: Option[FeedPostsStatsResponse]

Primer

Primer getFeedPostsStats

Copy

let (response, httpResponse) = client.getFeedPostsStats(tenantId = "my-tenant-123", postIds = @["news/article-2026", "opinion/market-trends"], sso = "")
if response.isSome:
  let stats = response.get()
  echo "Received feed posts stats for tenant:", " my-tenant-123"
  discard stats

getUserReactsPublic

Parametri

Name	Type	Required
tenantId	string	Da
postIds	seq[string]	Ne
sso	string	Ne

Odgovor

Vrne: Option[UserReactsResponse]

Primer

Primer getUserReactsPublic

Copy

let (response, httpResponse) = client.getUserReactsPublic(
  tenantId = "my-tenant-123",
  postIds = @["news/article-2026", "blog/opinion-987"],
  sso = ""
)
if response.isSome:
  let reacts = response.get()
  echo "Received user reacts for tenant: ", "my-tenant-123"

reactFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Ne
reactBodyParams	ReactBodyParams	Ne
isUndo	bool	Ne
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrača: Option[ReactFeedPostResponse]

Primer

reactFeedPostPublic Primer

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-2026-06-19",
  reactBodyParams = ReactBodyParams(reactType = "heart", tags = @["breaking", "editorial"]),
  isUndo = false,
  broadcastId = "broadcast-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let react = response.get()
  echo react
else:
  echo "No response from reactFeedPostPublic, HTTP status:", httpResponse.statusCode

updateFeedPost

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
feedPost	FeedPost	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

updateFeedPost Primer

Copy

let feedPost: FeedPost = FeedPost(title: "City Council Approves New Waterfront Park",
  content: "The council voted 5-2 to approve funding and a timeline for construction.",
  tags: @["local", "parks", "city"],
  published: true)
let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)
if response.isSome:
  let apiResp = response.get()
  echo "Feed post updated successfully"
  echo apiResp
else:
  echo "Failed to update feed post"
  echo httpResponse

updateFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Ne
updateFeedPostParams	UpdateFeedPostParams	Ne
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[CreateFeedPostResponse]

Primer

Primer uporabe updateFeedPostPublic

Copy

let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  updateFeedPostParams = UpdateFeedPostParams(title = "Weekly Product Update", content = "Released bug fixes and performance improvements in v2.1.", tags = @["release", "product"], pinned = false),
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let created = response.get()
  echo "Updated feed post id: ", created.postId
else:
  echo "Update failed with HTTP status: ", httpResponse.status

flagCommentPublic

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
isFlagged	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer uporabe flagCommentPublic

Copy

let (response, httpResponse) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  isFlagged = true,
  sso = ""
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp
else:
  discard httpResponse

getGifLarge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
largeInternalURLSanitized	string	Ne

Odgovor

Vrne: Option[GifGetLargeResponse]

Primer

Primer getGifLarge

Copy

let (response, httpResponse) = client.getGifLarge(tenantId = "news-tenant-42", largeInternalURLSanitized = "")
if response.isSome:
  let gif = response.get()
  echo "Received GifGetLargeResponse"
  discard gif
else:
  echo "No gif returned, HTTP status: " & $httpResponse.status

getGifsSearch

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
search	string	Ne
locale	string	Ne
rating	string	Ne
page	float64	Ne

Odgovor

Vrne: Option[GetGifsSearchResponse]

Primer

Primer getGifsSearch

Copy

let (response, httpResponse) = client.getGifsSearch(
  tenantId = "my-tenant-123",
  search = "funny cat",
  locale = "en-US",
  rating = "PG",
  page = 1.0
)
if response.isSome:
  let gifs = response.get()
  echo "Fetched GIFs response:", gifs

getGifsTrending

Parametri

Name	Type	Required
tenantId	string	Da
locale	string	Ne
rating	string	Ne
page	float64	Ne

Odziv

Vrne: Option[GetGifsTrendingResponse]

Primer

Primer getGifsTrending

Copy

let (response, httpResponse) = client.getGifsTrending(tenantId = "my-tenant-123",
  locale = "en-US",
  rating = "pg-13",
  page = 1.0)
if response.isSome:
  let trending = response.get()

addHashTag

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
createHashTagBody	CreateHashTagBody	Ne

Odgovor

Vrne: Option[CreateHashTagResponse]

Primer

Primer addHashTag

Copy

let (response, httpResponse) = client.addHashTag(tenantId = "my-tenant-123",
  createHashTagBody = CreateHashTagBody(name = "Breaking News",
    slug = "breaking-news",
    description = "Major breaking news items",
    color = "#ff0000",
    isTrending = true,
    aliases = @["breaking", "news"]))
if response.isSome:
  let created = response.get()
  echo created

addHashTagsBulk

Parametri

Name	Type	Required	Description
tenantId	string	Da
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Ne

Odgovor

Vrne: Option[BulkCreateHashTagsResponse]

Primer

Primer addHashTagsBulk

Copy

let (response, httpResponse) = client.addHashTagsBulk(tenantId = "my-tenant-123", bulkCreateHashTagsBody = BulkCreateHashTagsBody(hashTags = @["news", "breaking", "politics"], replaceExisting = false))
if response.isSome:
  let result = response.get()
  echo "Bulk tags response:", result
else:
  echo "No response body, HTTP status:", httpResponse.statusCode

deleteHashTag

Parametri

Ime	Tip	Zahtevano
tag	string	Ne
tenantId	string	Da
deleteHashTagRequestBody	DeleteHashTagRequestBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteHashTag

Copy

let (response, httpResponse) = client.deleteHashTag(
  tag = "",
  tenantId = "my-tenant-123",
  deleteHashTagRequestBody = DeleteHashTagRequestBody()
)
if response.isSome:
  let emptyResp = response.get()
  echo "Deleted hashtag for tenant my-tenant-123; response:", $emptyResp, " status:", $httpResponse.status
else:
  echo "No response body; status:", $httpResponse.status

getHashTags

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
page	float64	Ne

Odgovor

Vrne: Option[GetHashTagsResponse]

Primer

Primer getHashTags

Copy

let (response, httpResponse) = client.getHashTags(tenantId = "news-portal-987", page = 2.0)
if response.isSome:
  let tagsResp = response.get()
  echo "Received hashtags response"
else:
  echo "No hashtags returned"

patchHashTag

Parametri

Ime	Tip	Obvezno
tag	string	Ne
tenantId	string	Da
updateHashTagBody	UpdateHashTagBody	Ne

Odziv

Vrne: Option[UpdateHashTagResponse]

Primer

Primer patchHashTag

Copy

let (response, httpResponse) = client.patchHashTag(tag = "breaking-news", tenantId = "my-tenant-123", updateHashTagBody = UpdateHashTagBody())
if response.isSome:
  let updatedHashTag = response.get()
  echo updatedHashTag

deleteModerationVote

Parametri

Ime	Tip	Obvezno
commentId	string	Da
voteId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[VoteDeleteResponse]

Primer

deleteModerationVote Primer

Copy

let (response, httpResponse) = client.deleteModerationVote(commentId = "my-tenant-123/news/article-title/comment-987", voteId = "vote-456", sso = "sso-token-abc")
if response.isSome:
  let voteResp = response.get()
  echo "Vote deleted:", voteResp
else:
  echo "Delete failed:", httpResponse

getApiComments

Parametri

Ime	Tip	Obvezno
page	float64	Ne
count	float64	Ne
textSearch	string	Ne
byIPFromComment	string	Ne
filters	string	Ne
searchFilters	string	Ne
sorts	string	Ne
demo	bool	Ne
sso	string	Ne

Odgovor

Vrača: Option[ModerationAPIGetCommentsResponse]

Primer

Primer getApiComments

Copy

let (response, httpResponse) = client.getApiComments(
  page = 1.0,
  count = 25.0,
  textSearch = "opinion on climate summit",
  byIPFromComment = "198.51.100.23",
  filters = "status:approved",
  searchFilters = "section:world",
  sorts = "-createdAt",
  demo = false,
  sso = "sso-user-982bf"
)
if response.isSome:
  let commentsResp = response.get()
  echo "Retrieved comments response"
else:
  echo "No comments returned, HTTP status: ", httpResponse.status

getApiExportStatus

Parametri

Ime	Tip	Zahtevano	Opis
batchJobId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationExportStatusResponse]

Primer

getApiExportStatus Primer

Copy

let (response, httpResponse) = client.getApiExportStatus(batchJobId = "export-job-2026-06-01", sso = "sso-abc123token")
if response.isSome:
  let exportStatus = response.get()
  echo repr(exportStatus)
else:
  echo "No export status available, HTTP code: ", httpResponse.statusCode

getApiIds

Parametri

Ime	Tip	Obvezno
textSearch	string	Ne
byIPFromComment	string	Ne
filters	string	Ne
searchFilters	string	Ne
afterId	string	Ne
demo	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationAPIGetCommentIdsResponse]

Primer

Primer getApiIds

Copy

let (response, httpResponse) = client.getApiIds(
  textSearch = "urgent moderation review",
  byIPFromComment = "203.0.113.45",
  filters = "status:pending,flagged",
  searchFilters = "author:jane.doe@example.com",
  afterId = "cmt_9f8e7d6a",
  demo = false,
  sso = "sso-token-6b7f9a"
)
if response.isSome:
  let idsResp = response.get()
  echo idsResp

getBanUsersFromComment

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrača: Option[GetBannedUsersFromCommentResponse]

Primer

Primer getBanUsersFromComment

Copy

let (response, httpResponse) = client.getBanUsersFromComment(commentId = "comment-98765", sso = "")
if response.isSome:
  let bannedResp = response.get()
  discard bannedResp
else:
  echo "No banned users found or request failed"

getCommentBanStatus

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odziv

Vrne: Option[GetCommentBanStatusResponse]

Primer

Primer getCommentBanStatus

Copy

let (response, httpResponse) = client.getCommentBanStatus(commentId = "cmt-987654321", sso = "")
if response.isSome:
  let banStatus = response.get()
  echo "Ban status for comment cmt-987654321: ", banStatus
else:
  echo "No ban status returned for comment cmt-987654321"

getCommentChildren

Parametri

Ime	Tip	Zahtevano	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[ModerationAPIChildCommentsResponse]

Primer

getCommentChildren Primer

Copy

let (response, httpResponse) = client.getCommentChildren(commentId = "comment-98765", sso = "")
if response.isSome:
  let childResp = response.get()
  discard childResp

getCount

Parametri

Ime	Tip	Obvezno
textSearch	string	Ne
byIPFromComment	string	Ne
filter	string	Ne
searchFilters	string	Ne
demo	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationAPICountCommentsResponse]

Primer

Primer getCount

Copy

let (response, httpResponse) = client.getCount(
  textSearch = "climate change",
  byIPFromComment = "203.0.113.5",
  filter = "status:approved",
  searchFilters = "author:john.doe@example.com;tag:opinion",
  demo = false,
  sso = "sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
)
if response.isSome:
  let countResp = response.get()
  discard countResp
  echo "Count response received"
else:
  echo "No count data returned"

getCounts

Parametri

Name	Type	Required	Description
sso	string	Ne

Odgovor

Vrne: Option[GetBannedUsersCountResponse]

Primer

Primer getCounts

Copy

let (response, httpResponse) = client.getCounts(sso = "sso_my-tenant-123_token_AbCdEf123456")
if response.isSome:
  let counts = response.get()
  echo counts
else:
  echo "Request failed with status:", httpResponse.status

getLogs

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[ModerationAPIGetLogsResponse]

Primer

Primer getLogs

Copy

let (response, httpResponse) = client.getLogs(commentId = "cmt-8471f2d3", sso = "")
if response.isSome:
  let logs = response.get()
  echo "Fetched logs:", logs

getManualBadges

Parametri

Ime	Tip	Obvezno	Opis
sso	string	Ne

Odgovor

Vrne: Option[GetTenantManualBadgesResponse]

Primer

Primer getManualBadges

Copy

let (response, httpResponse) = client.getManualBadges(sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9")
if response.isSome:
  let badges = response.get()
  echo "Manual badges received:"
  echo badges
else:
  echo "No manual badges returned."
  echo httpResponse

getManualBadgesForUser

Parametri

Name	Type	Required
badgesUserId	string	Ne
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[GetUserManualBadgesResponse]

Primer

Primer getManualBadgesForUser

Copy

let (response, httpResponse) = client.getManualBadgesForUser(
  badgesUserId = "user-98765",
  commentId = "comment-0a1b2c3d",
  sso = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
)
if response.isSome:
  let badges = response.get()
  echo "Received manual badges for user"
  echo "HTTP status: ", httpResponse.status

getModerationComment

Parametri

Ime	Tip	Obvezno
commentId	string	Da
includeEmail	bool	Ne
includeIP	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationAPICommentResponse]

Primer

Primer getModerationComment

Copy

let (response, httpResponse) = client.getModerationComment(commentId = "cmt-8f3b2a9d", includeEmail = false, includeIP = false, sso = "")
if response.isSome:
  let comment = response.get()
  discard comment
else:
  echo "No moderation comment returned"

getModerationCommentText

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[GetCommentTextResponse]

Primer

Primer getModerationCommentText

Copy

let (response, httpResponse) = client.getModerationCommentText(commentId = "comment-9f8b7a6c", sso = "")
if response.isSome:
  let commentData = response.get()
  echo "Moderation comment text retrieved"
else:
  echo "No moderation comment text available"

getPreBanSummary

Parametri

Ime	Tip	Obvezno
commentId	string	Da
includeByUserIdAndEmail	bool	Ne
includeByIP	bool	Ne
includeByEmailDomain	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[PreBanSummary]

Primer

Primer getPreBanSummary

Copy

let commentId = "cmt-7423"
let (response, httpResponse) = client.getPreBanSummary(
  commentId = commentId,
  includeByUserIdAndEmail = false,
  includeByIP = false,
  includeByEmailDomain = false,
  sso = ""
)
if response.isSome:
  let preBanSummary = response.get()
  discard preBanSummary
else:
  discard httpResponse

getSearchCommentsSummary

Parametri

Ime	Tip	Obvezno
value	string	Ne
filters	string	Ne
searchFilters	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationCommentSearchResponse]

Primer

getSearchCommentsSummary Primer

Copy

let (response, httpResponse) = client.getSearchCommentsSummary(
  value = "news/climate-change-2026",
  filters = "{\"tenantId\":\"my-tenant-123\",\"siteId\":\"main-site\",\"status\":\"approved\"}",
  searchFilters = "author:journalist@news.com OR content:climate",
  sso = "sso-xyz-7890"
)
if response.isSome:
  let summary = response.get()
  echo "Received summary: ", $summary
else:
  echo "No summary returned, HTTP response: ", $httpResponse

getSearchPages

Parametri

Ime	Tip	Obvezno	Opis
value	string	Ne
sso	string	Ne

Odgovor

Vrača: Option[ModerationPageSearchResponse]

Primer

Primer getSearchPages

Copy

let (response, httpResponse) = client.getSearchPages(value = "news/politics/election-2024", sso = "sso-user-7f3b9c")
if response.isSome:
  let pageSearch = response.get()
  echo "Moderation page search returned"
else:
  echo "No moderation pages found"

getSearchSites

Parametri

Ime	Tip	Obvezno	Opis
value	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationSiteSearchResponse]

Primer

Primer getSearchSites

Copy

let (response, httpResponse) = client.getSearchSites(value = "news/2026-olympics", sso = "sso-user-9876-token")
if response.isSome:
  let searchResponse: ModerationSiteSearchResponse = response.get()
  echo "Found sites for search:", searchResponse

getSearchSuggest

Parametri

Ime	Tip	Obvezno	Opis
textSearch	string	Ne
sso	string	Ne

Odgovor

Vrača: Option[ModerationSuggestResponse]

Primer

Primer getSearchSuggest

Copy

let (response, httpResponse) = client.getSearchSuggest(textSearch = "suspicious comment with spammy links", sso = "sso-user-789")
if response.isSome:
  let suggest = response.get()
  echo "ModerationSuggestResponse:"
  echo suggest
else:
  echo "No moderation suggestions returned. HTTP status: ", httpResponse.status

getSearchUsers

Parametri

Ime	Tip	Obvezno	Opis
value	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationUserSearchResponse]

Primer

getSearchUsers Primer

Copy

let (response, httpResponse) = client.getSearchUsers(value = "john.doe@example.com", sso = "sso-acme-789")
if response.isSome:
  let searchRes = response.get()
  echo "Search result:", searchRes
else:
  echo "No users found"

getTrustFactor

Parametri

Ime	Vrsta	Obvezno	Opis
userId	string	Ne
sso	string	Ne

Odgovor

Vrača: Option[GetUserTrustFactorResponse]

Primer

Primer getTrustFactor

Copy

let (response, httpResponse) = client.getTrustFactor(userId = "user-1001", sso = "sso-token-6f7d9c")
if response.isSome:
  let trust = response.get()
  echo "Received trust factor for user-1001"
else:
  echo "No trust factor returned, HTTP status: ", $httpResponse.status

getUserBanPreference

Parametri

Ime	Tip	Obvezno	Opis
sso	string	Ne

Odgovor

Vrne: Option[APIModerateGetUserBanPreferencesResponse]

Primer

Primer getUserBanPreference

Copy

let (response, httpResponse) = client.getUserBanPreference(sso = "sso-jwt-7f3a9b")
if response.isSome:
  let prefs = response.get()
  echo "User ban preferences:", prefs
else:
  echo "No ban preference found"

getUserInternalProfile

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[GetUserInternalProfileResponse]

Primer

Primer getUserInternalProfile

Copy

let (response, httpResponse) = client.getUserInternalProfile(commentId = "cmt-2026-00042", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoibXl1c2VyIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
if response.isSome:
  let profile = response.get()
  discard profile

postAdjustCommentVotes

Parametri

Ime	Tip	Zahtevano
commentId	string	Da
adjustCommentVotesParams	AdjustCommentVotesParams	Ne
sso	string	Ne

Odziv

Vrača: Option[AdjustVotesResponse]

Primer

Primer postAdjustCommentVotes

Copy

let (response, httpResponse) = client.postAdjustCommentVotes(commentId = "cmt-987654", adjustCommentVotesParams = nil, sso = "sso-token-abc123")
if response.isSome:
  let adjusted = response.get()
  discard adjusted

postApiExport

Parametri

Ime	Tip	Zahtevano
textSearch	string	Ne
byIPFromComment	string	Ne
filters	string	Ne
searchFilters	string	Ne
sorts	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[ModerationExportResponse]

Primer

Primer postApiExport

Copy

let (response, httpResponse) = client.postApiExport(
  textSearch = "offensive language and spam",
  byIPFromComment = "203.0.113.45",
  filters = "{\"status\":\"pending\",\"severity\":\"high\"}",
  searchFilters = "authorEmail:editor@news-site.com",
  sorts = "-createdAt",
  sso = "sso-session-token-9f8b7c"
)
if response.isSome:
  let exportResp = response.get()
  echo "Moderation export received:", exportResp
else:
  echo "No export returned, HTTP status:", httpResponse.status.code

postBanUserFromComment

Parameters

Ime	Tip	Obvezno
commentId	string	Da
banEmail	bool	Ne
banEmailDomain	bool	Ne
banIP	bool	Ne
deleteAllUsersComments	bool	Ne
bannedUntil	string	Ne
isShadowBan	bool	Ne
updateId	string	Ne
banReason	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[BanUserFromCommentResult]

Primer

Primer postBanUserFromComment

Copy

let (response, httpResponse) = client.postBanUserFromComment(
  commentId = "cmt-8f3a1b",
  banEmail = false,
  banEmailDomain = false,
  banIP = false,
  deleteAllUsersComments = false,
  bannedUntil = "",
  isShadowBan = false,
  updateId = "",
  banReason = "",
  sso = ""
)
if response.isSome:
  let banResult = response.get()
  discard banResult
else:
  echo "No ban result returned"

postBanUserUndo

Parametri

Name	Type	Required	Description
banUserUndoParams	BanUserUndoParams	Ne
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer postBanUserUndo

Copy

let banParams = BanUserUndoParams(
  tenantId = "my-tenant-123",
  userId = "user-987",
  undoneBy = "moderator-42",
  reason = "Reinstated after manual review"
)
let (response, httpResponse) = client.postBanUserUndo(banUserUndoParams = banParams, sso = "sso-jwt-abc123")
if response.isSome:
  let apiResp = response.get()
  echo "Ban undo succeeded, http status: " & $httpResponse.status
else:
  echo "Ban undo failed, http status: " & $httpResponse.status

postBulkPreBanSummary

Parametri

Ime	Tip	Obvezno
bulkPreBanParams	BulkPreBanParams	Ne
includeByUserIdAndEmail	bool	Ne
includeByIP	bool	Ne
includeByEmailDomain	bool	Ne
sso	string	Ne

Odgovor

Vrača: Option[BulkPreBanSummary]

Primer

Primer za postBulkPreBanSummary

Copy

let bulkParams = BulkPreBanParams(
  tenantId = "my-tenant-123",
  userIds = @["user-456", "user-789"],
  emails = @["spammer@example.com", "bot@malicious.org"],
  ipAddresses = @["203.0.113.5", "198.51.100.42"],
  emailDomains = @["malicious.org"]
)
let (response, httpResponse) = client.postBulkPreBanSummary(
  bulkPreBanParams = bulkParams,
  includeByUserIdAndEmail = true,
  includeByIP = true,
  includeByEmailDomain = false,
  sso = "sso-token-abc123"
)
if response.isSome:
  let summary = response.get()
  echo "Pre-ban summary:", summary

postCommentsByIds

Parametri

Ime	Tip	Obvezno	Opis
commentsByIdsParams	CommentsByIdsParams	Ne
sso	string	Ne

Odziv

Vrne: Option[ModerationAPIChildCommentsResponse]

Primer

Primer postCommentsByIds

Copy

let commentsParams = CommentsByIdsParams(ids = @["cmt-1001", "cmt-1002"], includeReplies = true, maxDepth = 2)
let (response, httpResponse) = client.postCommentsByIds(commentsByIdsParams = commentsParams, sso = "sso-user-7f3a9b")
if response.isSome:
  let result = response.get()
  echo "Received child comments response: ", result

postFlagComment

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer postFlagComment

Copy

let (response, httpResponse) = client.postFlagComment(commentId = "comment-742", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Comment flagged successfully"
else:
  echo "Failed to flag comment"

postRemoveComment

Parametri

Name	Type	Required	Description
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[PostRemoveCommentResponse]

Primer

Primer postRemoveComment

Copy

let (response, httpResponse) = client.postRemoveComment(commentId = "cmt-987654321", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123.signature")
if response.isSome:
  let removed = response.get()
  echo "Comment removed:", removed
else:
  echo "Failed to remove comment, HTTP response:", httpResponse

postRestoreDeletedComment

Parametri

Name	Type	Required	Description
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer postRestoreDeletedComment

Copy

let (response, httpResponse) = client.postRestoreDeletedComment(commentId = "comment-8a7b6c5d", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.SAMPLE_SIGNATURE")
if response.isSome:
  let apiResp = response.get()
  echo "Comment restored:", apiResp
else:
  echo "Restore request failed"

postSetCommentApprovalStatus

Parametri

Ime	Tip	Obvezno
commentId	string	Yes
approved	bool	No
sso	string	No

Odgovor

Vrne: Option[SetCommentApprovedResponse]

Primer

Primer postSetCommentApprovalStatus

Copy

let (response, httpResponse) = client.postSetCommentApprovalStatus(commentId = "cmt-7890", approved = false, sso = "")
if response.isSome:
  let setResp = response.get()
  discard setResp

postSetCommentReviewStatus

Parametri

Ime	Tip	Obvezno
commentId	string	Da
reviewed	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer uporabe postSetCommentReviewStatus

Copy

let (response, httpResponse) = client.postSetCommentReviewStatus(
  commentId = "cmt-98765-news-article",
  reviewed = false,
  sso = ""
)
if response.isSome:
  let apiResp = response.get()
  echo "Review status updated"
else:
  echo "Failed to update review status: " & $httpResponse.status

postSetCommentSpamStatus

Parametri

Ime	Tip	Obvezno
commentId	string	Da
spam	bool	Ne
permNotSpam	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer postSetCommentSpamStatus

Copy

let (response, httpResponse) = client.postSetCommentSpamStatus(
  commentId = "cmt-20250619-842",
  spam = false,
  permNotSpam = false,
  sso = ""
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

postSetCommentText

Parametri

Ime	Tip	Obvezno
commentId	string	Da
setCommentTextParams	SetCommentTextParams	Ne
sso	string	Ne

Odgovor

Vrne: Option[SetCommentTextResponse]

Primer

Primer postSetCommentText

Copy

let (response, httpResponse) = client.postSetCommentText(commentId = "comment-4821",
  setCommentTextParams = SetCommentTextParams(text = "Updated comment to clarify the main point and fix a typo."),
  sso = "sso-user-8f3b9c")
if response.isSome:
  let setCommentResp = response.get()
  echo "Received SetCommentTextResponse"

postUnFlagComment

Parametri

Ime	Tip	Obvezno	Opis
commentId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer postUnFlagComment

Copy

let (response, httpResponse) = client.postUnFlagComment(commentId = "comment-8f3a2b4e", sso = "")
if response.isSome:
  let apiEmpty = response.get()
  echo "Comment unflagged successfully, response: ", apiEmpty
else:
  echo "Failed to unflag comment. HTTP response: ", httpResponse

postVote

Parametri

Ime	Tip	Zahtevano
commentId	string	Da
direction	string	Ne
sso	string	Ne

Odziv

Vrne: Option[VoteResponse]

Primer

Primer postVote

Copy

let (response, httpResponse) = client.postVote(commentId = "comment-4f3a9e", direction = "up", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoidXNlci0xMjMifQ.signedPart")
if response.isSome:
  let vote = response.get()
  echo "Vote recorded:", vote
else:
  echo "No vote returned"

putAwardBadge

Parametri

Ime	Tip	Obvezno
badgeId	string	Ne
userId	string	Ne
commentId	string	Da
broadcastId	string	Ne
sso	string	Ne

Odziv

Vrne: Option[AwardUserBadgeResponse]

Primer

putAwardBadge Primer

Copy

let (response, httpResponse) = client.putAwardBadge(
  badgeId = "gold-contributor",
  userId = "user-8723",
  commentId = "cmt-54a3b2",
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let award = response.get()
  echo "Awarded badge received"
else:
  echo "No award response"

putCloseThread

Parametri

Ime	Tip	Obvezno	Opis
urlId	string	Da
sso	string	Ne

Odgovor

Vrača: Option[APIEmptyResponse]

Primer

putCloseThread Primer

Copy

let (response, httpResponse) = client.putCloseThread(urlId = "news/article-title", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Thread closed successfully:", $apiResp
else:
  echo "Failed to close thread, HTTP response:", $httpResponse

putRemoveBadge

Parametri

Ime	Tip	Obvezno
badgeId	string	Ne
userId	string	Ne
commentId	string	Da
broadcastId	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[RemoveUserBadgeResponse]

Primer

Primer putRemoveBadge

Copy

let (response, httpResponse) = client.putRemoveBadge(badgeId = "verified-journalist",
  userId = "user-7890",
  commentId = "comment-98765",
  broadcastId = "",
  sso = "")
if response.isSome:
  let removeResp = response.get()
  discard removeResp
else:
  discard httpResponse

putReopenThread

Parametri

Ime	Tip	Obvezno	Opis
urlId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer putReopenThread

Copy

let (response, httpResponse) = client.putReopenThread(urlId = "news/2026-election-analysis", sso = "")
if response.isSome:
  let apiResp = response.get()
  echo "Reopen succeeded, response: ", apiResp
else:
  echo "Reopen failed, HTTP status: ", httpResponse.status

setTrustFactor

Parametri

Name	Type	Required
userId	string	Ne
trustFactor	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[SetUserTrustFactorResponse]

Primer

Primer setTrustFactor

Copy

let (response, httpResponse) = client.setTrustFactor(userId = "user-9876", trustFactor = "high", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLTk4NzYiLCJpYXQiOjE2MjQwMDAwMDB9.signature")
if response.isSome:
  let resultObj = response.get()
  echo resultObj
else:
  echo "No response received"

createModerator

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
createModeratorBody	CreateModeratorBody	Ne

Odgovor

Vrne: Option[CreateModeratorResponse]

Primer

Primer createModerator

Copy

var body: CreateModeratorBody
body.username = "alice.moderator"
body.displayName = "Alice Moderator"
body.email = "alice@news-site.com"
body.enabled = true
body.roles = @["moderator"]
body.notes = ""
let (response, httpResponse) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = body)
if response.isSome:
  let created = response.get()
  echo "Created moderator ID: ", created.id

deleteModerator

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
sendEmail	string	Ne

Odgovor

Vrača: Option[APIEmptyResponse]

Primer

deleteModerator Primer

Copy

let (response, httpResponse) = client.deleteModerator(tenantId = "my-tenant-123", id = "", sendEmail = "")
if response.isSome:
  let apiEmpty = response.get()
  echo "Moderator deleted successfully for tenant my-tenant-123"
else:
  echo "No response returned; inspect httpResponse"

getModerator

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetModeratorResponse]

Primer

Primer getModerator

Copy

let (response, httpResponse) = client.getModerator(tenantId = "my-tenant-123", id = "mod-456")
if response.isSome:
  let moderator = response.get()
  echo moderator
else:
  echo "Moderator not found, HTTP status: ", $httpResponse.status

getModerators

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrne: Option[GetModeratorsResponse]

Primer

Primer getModerators

Copy

let (response, httpResponse) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let moderators = response.get()
  echo "Received moderators response:", moderators
else:
  echo "No moderators returned"

updateModerator

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateModeratorBody	UpdateModeratorBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateModerator

Copy

let modBody: UpdateModeratorBody = UpdateModeratorBody(
  displayName = "Alice Moderator",
  email = "alice@newsdaily.com",
  isActive = true,
  permissions = @["delete_comments", "ban_users"]
)
let (response, httpResponse) = client.updateModerator(tenantId = "news-tenant-456", id = "moderator-789", updateModeratorBody = modBody)
if response.isSome:
  let apiEmpty = response.get()
  echo "Moderator updated successfully. HTTP status: ", httpResponse.status
else:
  echo "Failed to update moderator. HTTP status: ", httpResponse.status

deleteNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteNotificationCount

Copy

let (response, httpResponse) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notification-789")
if response.isSome:
  let emptyResp = response.get()
  echo "Notification count deleted for tenant: ", "my-tenant-123"
else:
  echo "Failed to delete notification count, status: ", $httpResponse.statusCode

getCachedNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetCachedNotificationCountResponse]

Primer

Primer getCachedNotificationCount

Copy

let (response, httpResponse) = client.getCachedNotificationCount(tenantId = "my-tenant-123", id = "notification-789")
if response.isSome:
  let cached = response.get()
  echo "Cached notification count: ", $cached
else:
  echo "No cached notification count"

getNotificationCount

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
urlId	string	Da
fromCommentId	string	Ne
viewed	bool	Ne

Odgovor

Vrne: Option[GetNotificationCountResponse]

Primer

Primer getNotificationCount

Copy

let (response, httpResponse) = client.getNotificationCount(tenantId = "my-tenant-123", userId = "user-987", urlId = "news/2026/06/election-results", fromCommentId = "", viewed = false)
if response.isSome:
  let notifyData = response.get()
  echo notifyData

getNotifications

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
userId	string	Ne
urlId	string	Da
fromCommentId	string	Ne
viewed	bool	Ne
skip	float64	Ne

Odgovor

Vrne: Option[GetNotificationsResponse]

Primer

Primer getNotifications

Copy

let (response, httpResponse) = client.getNotifications(tenantId = "my-tenant-123", userId = "user-456", urlId = "news/article-title", fromCommentId = "cmt-789", viewed = false, skip = 0.0)
if response.isSome:
  let notifications = response.get()
  echo notifications

updateNotification

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateNotificationBody	UpdateNotificationBody	Ne
userId	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateNotification

Copy

let (response, httpResponse) = client.updateNotification(
  tenantId = "my-tenant-123",
  id = "notif-456",
  updateNotificationBody = UpdateNotificationBody(
    enabled = true,
    channels = @["email", "push"],
    frequency = "immediate"
  ),
  userId = "user-789"
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

createV1PageReact

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
title	string	Ne

Odgovor

Vrne: Option[CreateV1PageReact]

Primer

Primer createV1PageReact

Copy

let (response, httpResponse) = client.createV1PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/2026/market-rally",
  title = "Breaking News: Markets Rally Today"
)
if response.isSome:
  let pageReact = response.get()
  echo "Page react created: ", pageReact
else:
  echo "Failed to create page react: ", httpResponse

createV2PageReact

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
id	string	Ne
title	string	Ne

Odgovor

Vrne: Option[CreateV1PageReact]

Primer

Primer createV2PageReact

Copy

let (response, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/2026/06/fastcomments-release",
  id = "",
  title = ""
)
if response.isSome:
  let react = response.get()
  echo "Created page react: ", $react
else:
  echo "No react returned, HTTP status: ", $httpResponse.statusCode

deleteV1PageReact

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[CreateV1PageReact]

Primer

deleteV1PageReact Primer

Copy

let (response, httpResponse) = client.deleteV1PageReact(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let deletedReact = response.get()
  echo "Deleted react:", deletedReact
else:
  echo "No react returned for tenant: my-tenant-123, url: news/article-title"

deleteV2PageReact

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
urlId	string	Da
id	string	Ne

Odgovor

Vrača: Option[CreateV1PageReact]

Primer

deleteV2PageReact Primer

Copy

let (response, httpResponse) = client.deleteV2PageReact(tenantId = "my-tenant-123", urlId = "news/2026/politics-election", id = "react-456")
if response.isSome:
  let react = response.get()
  echo react
else:
  echo "No reaction returned, status: ", httpResponse.status

getV1PageLikes

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[GetV1PageLikes]

Primer

Primer getV1PageLikes

Copy

let (response, httpResponse) = client.getV1PageLikes(tenantId = "my-tenant-123", urlId = "news/how-to-train-your-dragon")
if response.isSome:
  let pageLikes = response.get()
  echo "Fetched page likes for url:", "news/how-to-train-your-dragon"
else:
  echo "No likes returned for url:", "news/how-to-train-your-dragon"

getV2PageReacts

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[GetV2PageReacts]

Primer

Primer getV2PageReacts

Copy

let (response, httpResponse) = client.getV2PageReacts(tenantId = "my-tenant-123", urlId = "news/elections/2026/us-primary-results")
if response.isSome:
  let reacts = response.get()
  echo "Received reacts: ", $reacts
else:
  echo "No reacts available"

getV2PageReactUsers

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetV2PageReactUsersResponse]

Primer

Primer getV2PageReactUsers

Copy

let (response, httpResponse) = client.getV2PageReactUsers(tenantId = "my-tenant-123", urlId = "news/article-title", id = "")
if response.isSome:
  let usersResp = response.get()
  echo repr(usersResp)
else:
  echo "No page react users returned. HTTP response: ", repr(httpResponse)

addPage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPIPageData	CreateAPIPageData	Ne

Odgovor

Vrača: Option[AddPageAPIResponse]

Primer

Primer addPage

Copy

var createData: CreateAPIPageData
createData.url = "news/nim-4-release"
createData.title = "Nim 4 Release Coverage"
createData.path = "/news/nim-4-release"
createData.isEnabled = true
createData.tags = @["nim", "release"]
createData.description = "Coverage of Nim 4 release"
let (response, httpResponse) = client.addPage(tenantId = "my-tenant-123", createAPIPageData = createData)
if response.isSome:
  let pageResp = response.get()
  echo pageResp

deletePage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrača: Option[DeletePageAPIResponse]

Primer

Primer deletePage

Copy

let (response, httpResponse) = client.deletePage(tenantId = "site-tenant-456", id = "news/winter-updates-2025")
if response.isSome:
  let deleted = response.get()
  echo "DeletePageAPIResponse:", deleted
else:
  echo "Delete failed, HTTP response:", httpResponse

getOfflineUsers

Prejšnji komentatorji na strani, ki trenutno niso online. Razvrščeno po displayName. Uporabite to po izčrpanju /users/online, da prikažete razdelek "Člani". Straničenje z kurzorjem po commenterName: strežnik prehaja parcialni indeks {tenantId, urlId, commenterName} od afterName naprej z uporabo $gt, brez stroška $skip.

Parameters

Ime	Tip	Zahtevano
tenantId	string	Da
urlId	string	Da
afterName	string	Ne
afterUserId	string	Ne

Odziv

Vrne: Option[PageUsersOfflineResponse]

Primer

Primer getOfflineUsers

Copy

let (response, httpResponse) = client.getOfflineUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-how-to-code",
  afterName = "",
  afterUserId = ""
)
if response.isSome:
  let offlinePage = response.get()
  echo "Received offline users page"
  discard httpResponse.statusCode

getOnlineUsers

Trenutno prisotni gledalci strani: osebe, katerih websocket seja je trenutno naročena na stran. Vrača anonCount + totalCount (naročniki v celotni sobi, vključno z anonimnimi gledalci, ki jih ne navajamo).

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Odgovor

Vrača: Option[PageUsersOnlineResponse]

Primer

Primer getOnlineUsers

Copy

let (response, httpResponse) = client.getOnlineUsers(tenantId = "my-tenant-123", urlId = "news/politics/top-story", afterName = "", afterUserId = "")
if response.isSome:
  let page = response.get()
  echo "Received online users page:"
  echo page
else:
  echo "No online users returned. HTTP status: ", httpResponse.statusCode

getPageByURLId

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[GetPageByURLIdAPIResponse]

Primer

getPageByURLId Primer

Copy

let (response, httpResponse) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let page = response.get()
  echo "Page ID: ", page.id
  echo "Title: ", page.title
  echo "URL: ", page.url
  echo "Published: ", $page.published
  echo "Tags: ", $page.tags
else:
  echo "No page found. HTTP status: ", httpResponse.statusCode

getPages

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrne: Option[GetPagesAPIResponse]

Primer

Primer getPages

Copy

let (response, httpResponse) = client.getPages(tenantId = "news-site-456")
if response.isSome:
  let pages = response.get()
  echo "Received pages response: ", pages
else:
  echo "No pages returned. HTTP response: ", httpResponse

getPagesPublic

Seznam strani za najemnika. Uporablja ga namizni odjemalec FChat za napolnitev svojega seznama sob. Zahteva, da ima enableFChat vrednost true v razrešeni prilagojeni konfiguraciji za vsako stran. Strani, ki zahtevajo SSO, so filtrirane glede na dostop skupin uporabnika, ki poizveduje.

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
cursor	string	Ne
limit	int	Ne
q	string	Ne
sortBy	PagesSortBy	Ne
hasComments	bool	Ne

Odgovor

Vrne: Option[GetPublicPagesResponse]

Primer

Primer getPagesPublic

Copy

let (response, httpResponse) = client.getPagesPublic(
  tenantId = "my-tenant-123",
  cursor = "",
  limit = 0,
  q = "",
  sortBy = PagesSortBy(0),
  hasComments = false
)
if response.isSome:
  let pages = response.get()
  echo "Retrieved public pages: ", $pages
else:
  echo "No pages returned, HTTP status: ", $httpResponse.status

getUsersInfo

Paketne informacije o uporabnikih za najemnika. Glede na userIds vrne prikazne informacije iz User / SSOUser. Uporablja se v widgetu za komentarje za obogatitev uporabnikov, ki so se pravkar pojavili preko dogodka prisotnosti. Brez konteksta strani: zasebnost je dosledno uveljavljena (zasebni profili so zamaskirani).

Parametri

Name	Type	Required	Description
tenantId	string	Da
ids	string	Ne

Odgovor

Vrne: Option[PageUsersInfoResponse]

Primer

Primer getUsersInfo

Copy

let (response, httpResponse) = client.getUsersInfo(tenantId = "my-tenant-123", ids = "user-42,user-87")
if response.isSome:
  let usersInfo = response.get()
  echo "Retrieved users info:", usersInfo
else:
  echo "No users info returned. HTTP status:", httpResponse.status

patchPage

Parametri

Name	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateAPIPageData	UpdateAPIPageData	Ne

Odgovor

Vrača: Option[PatchPageAPIResponse]

Primer

patchPage Primer

Copy

let updateData = UpdateAPIPageData(
  title = "Breaking: Major Event Update",
  urlId = "news/major-event-update",
  visible = true,
  tags = @["breaking", "headline"],
  sortOrder = 5
)
let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/major-event-update",
  updateAPIPageData = updateData
)
if response.isSome:
  let page = response.get()
  discard page

deletePendingWebhookEvent

Parametri

Name	Tip	Zahtevano	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrača: Option[APIEmptyResponse]

Primer

deletePendingWebhookEvent Primer

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "wh_evt_9f8b7a6c")
if response.isSome:
  let apiEmpty = response.get()
  echo "Pending webhook event deleted for tenant my-tenant-123"
else:
  echo "Failed to delete pending webhook event"

getPendingWebhookEventCount

Parametri

Name	Type	Required
tenantId	string	Da
commentId	string	Da
externalId	string	Ne
eventType	string	Ne
domain	string	Ne
attemptCountGT	float64	Ne

Odziv

Vrača: Option[GetPendingWebhookEventCountResponse]

Primer

Primer getPendingWebhookEventCount

Copy

let (response, httpResponse) = client.getPendingWebhookEventCount(
  tenantId = "my-tenant-123",
  commentId = "cmt-456abc",
  externalId = "ext-7890",
  eventType = "comment_created",
  domain = "news.example.com",
  attemptCountGT = 2.0
)
if response.isSome:
  let pending = response.get()
  echo pending
else:
  echo "No pending webhook event count returned; HTTP status: ", httpResponse.status

getPendingWebhookEvents

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
externalId	string	Ne
eventType	string	Ne
domain	string	Ne
attemptCountGT	float64	Ne
skip	float64	Ne

Odgovor

Vrne: Option[GetPendingWebhookEventsResponse]

Primer

Primer getPendingWebhookEvents

Copy

let (response, httpResponse) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0,
  skip = 0.0
)
if response.isSome:
  let pending = response.get()
  discard pending

createQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createQuestionConfigBody	CreateQuestionConfigBody	Ne

Odgovor

Vrne: Option[CreateQuestionConfigResponse]

Primer

Primer createQuestionConfig

Copy

let (response, httpResponse) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = CreateQuestionConfigBody(
    label = "Article Question",
    required = true,
    minLength = 20,
    maxLength = 1000,
    allowedTags = @["comment","question","feedback"],
    notifyModerators = false
  )
)
if response.isSome:
  let cfg = response.get()
  echo "Created question config id: ", cfg.id

deleteQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteQuestionConfig

Copy

let (response, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let deleted = response.get()
  echo "Question config deleted for tenant: ", "my-tenant-123"
else:
  echo "Failed to delete question config"

getQuestionConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetQuestionConfigResponse]

Primer

Primer getQuestionConfig

Copy

let (response, httpResponse) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "qst-456")
if response.isSome:
  let cfg = response.get()
  discard cfg

getQuestionConfigs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrne: 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 "Received question configs for tenant my-tenant-123"
  echo configs
else:
  echo "No question configs returned"

updateQuestionConfig

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
updateQuestionConfigBody	UpdateQuestionConfigBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateQuestionConfig

Copy

let (response, httpResponse) = client.updateQuestionConfig(tenantId = "my-tenant-123", id = "question-config-456", updateQuestionConfigBody = default(UpdateQuestionConfigBody))
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

createQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createQuestionResultBody	CreateQuestionResultBody	Ne

Odgovor

Vrne: Option[CreateQuestionResultResponse]

Primer

Primer createQuestionResult

Copy

let (response, httpResponse) = client.createQuestionResult(
  tenantId = "my-tenant-123",
  createQuestionResultBody = CreateQuestionResultBody(
    questionId = "q-2026-001",
    userId = "user-42",
    correct = true,
    score = 95,
    tags = @["news","reader-question"]
  )
)
if response.isSome:
  let result = response.get()
  echo "Created question result id: ", result.id
  echo "HTTP status: ", httpResponse.status.code

deleteQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteQuestionResult

Copy

let tenantId = "my-tenant-123"
let resultId = "question-result-456"
let (response, httpResponse) = client.deleteQuestionResult(tenantId = tenantId, id = resultId)
if response.isSome:
  let emptyResp = response.get()
  echo "Deleted question result:", resultId

getQuestionResult

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetQuestionResultResponse]

Primer

Primer getQuestionResult

Copy

let (response, httpResponse) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if response.isSome:
  let result = response.get()
  echo "Question result received:"
  echo result
else:
  echo "No question result returned, HTTP status: ", $httpResponse.status

getQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
userId	string	Ne
startDate	string	Ne
questionId	string	Ne
questionIds	string	Ne
skip	float64	Ne

Odgovor

Vrne: Option[GetQuestionResultsResponse]

Primer

Primer getQuestionResults

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  urlId = "news/2026/election-analysis",
  userId = "user-42",
  startDate = "2026-06-01T00:00:00Z",
  questionId = "q-6789",
  questionIds = @["q-6789", "q-6790"],
  skip = 0.0
)
if response.isSome:
  let results = response.get()
  echo "Received question results"
else:
  echo "No results returned"

updateQuestionResult

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
updateQuestionResultBody	UpdateQuestionResultBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateQuestionResult

Copy

let (response, httpResponse) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-result-456",
  updateQuestionResultBody = UpdateQuestionResultBody(
    questionId: "q-789",
    userId: "user-42",
    score: 92,
    passed: true,
    tags: @["quiz", "math"]
  )
)
if response.isSome:
  let apiResp = response.get()
  echo "Question result updated successfully"
else:
  echo "No response body; HTTP status: ", httpResponse.status.code

aggregateQuestionResults

Parametri

Name	Tip	Zahtevano
tenantId	string	Da
questionId	string	Ne
questionIds	seq[string]	Ne
urlId	string	Da
timeBucket	AggregateTimeBucket	Ne
startDate	string	Ne
forceRecalculate	bool	Ne

Odgovor

Vrne: Option[AggregateQuestionResultsResponse]

Primer

aggregateQuestionResults Primer

Copy

let (response, httpResponse) = client.aggregateQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "",
  questionIds = @[],
  urlId = "news/article-title",
  timeBucket = AggregateTimeBucket(0),
  startDate = "",
  forceRecalculate = false
)
if response.isSome:
  let results = response.get()
  discard results

bulkAggregateQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Ne
forceRecalculate	bool	Ne

Odgovor

Vrne: Option[BulkAggregateQuestionResultsResponse]

Primer

Primer bulkAggregateQuestionResults

Copy

let (response, httpResponse) = client.bulkAggregateQuestionResults(
  tenantId = "my-tenant-123",
  bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(),
  forceRecalculate = false
)
if response.isSome:
  let aggregated = response.get()
  echo "Aggregated question results received"

combineCommentsWithQuestionResults

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
questionId	string	Ne
questionIds	seq[string]	Ne
urlId	string	Da
startDate	string	Ne
forceRecalculate	bool	Ne
minValue	float64	Ne
maxValue	float64	Ne
limit	float64	Ne

Odgovor

Vrne: Option[CombineQuestionResultsWithCommentsResponse]

Primer

Primer combineCommentsWithQuestionResults

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "",
  questionIds = @[],
  urlId = "news/article-2026-climate-change",
  startDate = "",
  forceRecalculate = false,
  minValue = 0.0,
  maxValue = 0.0,
  limit = 0.0
)
if response.isSome:
  let combined = response.get()
  echo "Combined results received for tenant:", " my-tenant-123"
else:
  echo "No combined results returned"

addSSOUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPISSOUserData	CreateAPISSOUserData	Ne

Odgovor

Vrača: Option[AddSSOUserAPIResponse]

Primer

Primer addSSOUser

Copy

let (response, httpResponse) = client.addSSOUser(
  tenantId = "my-tenant-123",
  createAPISSOUserData = CreateAPISSOUserData(
    id = "sso-456",
    email = "alice.johnson@newsorg.com",
    name = "Alice Johnson",
    roles = @["editor", "contributor"],
    isActive = true,
    isAdmin = false
  )
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp
else:
  discard httpResponse

deleteSSOUser

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
deleteComments	bool	Ne
commentDeleteMode	string	Ne

Odgovor

Vrne: Option[DeleteSSOUserAPIResponse]

Primer

Primer deleteSSOUser

Copy

let (response, httpResponse) = client.deleteSSOUser(tenantId = "my-tenant-123", id = "sso-user-9876", deleteComments = true, commentDeleteMode = "hard")
if response.isSome:
  let deleted = response.get()
  discard deleted
else:
  discard httpResponse

getSSOUserByEmail

Parametri

Name	Type	Required	Description
tenantId	string	Da
email	string	Ne

Odgovor

Vrne: Option[GetSSOUserByEmailAPIResponse]

Primer

Primer getSSOUserByEmail

Copy

let (response, httpResponse) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "alice@newsco.com")
if response.isSome:
  let ssoUser = response.get()
  echo "SSO user found: ", ssoUser.email
else:
  echo "No SSO user found. HTTP status: ", httpResponse.status

getSSOUserById

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetSSOUserByIdAPIResponse]

Primer

Primer getSSOUserById

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "user-789")
if response.isSome:
  let ssoUser: GetSSOUserByIdAPIResponse = response.get()
  echo "SSO user retrieved: ", $ssoUser
else:
  echo "No SSO user found, HTTP status: ", httpResponse.statusCode

getSSOUsers

Parametri

Ime	Type	Obvezno	Opis
tenantId	string	Da
skip	int	Ne

Odgovor

Vrne: Option[GetSSOUsersResponse]

Primer

getSSOUsers Primer

Copy

let (response, httpResponse) = client.getSSOUsers(tenantId = "my-tenant-123", skip = 0)
if response.isSome:
  let ssoUsers = response.get()
  echo ssoUsers
else:
  echo "No SSO users returned; HTTP response:", httpResponse

patchSSOUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateAPISSOUserData	UpdateAPISSOUserData	Ne
updateComments	bool	Ne

Odgovor

Vrne: Option[PatchSSOUserAPIResponse]

Primer

patchSSOUser Primer

Copy

let (response, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-987",
    username = "j.smith",
    email = "j.smith@news.example.com",
    displayName = "John Smith",
    roles = @["author", "editor"],
    avatarUrl = "https://cdn.news.example.com/avatars/j.smith.png"
  ),
  updateComments = true
)
if response.isSome:
  let patched = response.get()
  echo patched

putSSOUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateAPISSOUserData	UpdateAPISSOUserData	Ne
updateComments	bool	Ne

Odgovor

Vrača: Option[PutSSOUserAPIResponse]

Primer

Primer putSSOUser

Copy

let (response, httpResponse) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-789",
    displayName = "Jane Doe",
    email = "jane.doe@example.com",
    avatarUrl = "https://cdn.news-site.com/avatars/jane.jpg",
    roles = @["member", "subscriber"]
  ),
  updateComments = true
)
if response.isSome:
  let result = response.get()
  echo "SSO user updated:", result

createSubscription

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ne

Odziv

Vrača: Option[CreateSubscriptionAPIResponse]

Primer

createSubscription Primer

Copy

let createData = CreateAPIUserSubscriptionData(
  subscriberId = "user-987",
  email = "jane.doe@newsreader.com",
  urlId = "news/local-weather",
  active = true,
  tags = @["weather", "local"],
  frequency = "immediate"
)
let (response, httpResponse) = client.createSubscription(tenantId = "my-tenant-123", createAPIUserSubscriptionData = createData)
if response.isSome:
  let created = response.get()
  echo "Created subscription id: ", created.id

deleteSubscription

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
userId	string	Ne

Odgovor

Vrne: Option[DeleteSubscriptionAPIResponse]

Primer

Primer deleteSubscription

Copy

let (response, httpResponse) = client.deleteSubscription(tenantId = "my-tenant-123", id = "sub-98765", userId = "user-456")
if response.isSome:
  let deleteResp = response.get()
  echo "Delete subscription response received"
else:
  echo "No subscription response"

getSubscriptions

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
userId	string	Ne

Odgovor

Vrne: Option[GetSubscriptionsAPIResponse]

Primer

Primer getSubscriptions

Copy

let (response, httpResponse) = client.getSubscriptions(tenantId = "my-tenant-123", userId = "")
if response.isSome:
  let subscriptions = response.get()
  discard subscriptions

updateSubscription

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Ne
userId	string	Ne

Odgovor

Vrne: Option[UpdateSubscriptionAPIResponse]

Primer

Primer updateSubscription

Copy

let (response, httpResponse) = client.updateSubscription(
  tenantId = "my-tenant-123",
  id = "sub-456",
  updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(
    subscribed = true,
    channels = @["email", "push"]
  ),
  userId = "user-789"
)
if response.isSome:
  let updated = response.get()
  echo "Subscription updated:", updated
else:
  echo "Update failed, HTTP response:", httpResponse

getTenantDailyUsages

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
yearNumber	float64	Ne
monthNumber	float64	Ne
dayNumber	float64	Ne
skip	float64	Ne

Odgovor

Vrne: Option[GetTenantDailyUsagesResponse]

Primer

Primer getTenantDailyUsages

Copy

let (response, httpResponse) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  yearNumber = 2026.0,
  monthNumber = 6.0,
  dayNumber = 19.0,
  skip = 0.0
)
if response.isSome:
  let usage = response.get()
  discard usage

createTenantPackage

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
createTenantPackageBody	CreateTenantPackageBody	Ne

Odziv

Vrača: Option[CreateTenantPackageResponse]

Primer

Primer createTenantPackage

Copy

let (response, httpResponse) = client.createTenantPackage(tenantId = "my-tenant-123", createTenantPackageBody = CreateTenantPackageBody())
if response.isSome:
  let pkg = response.get()
  echo "Created tenant package: ", $pkg
else:
  echo "Failed to create tenant package, HTTP response: ", $httpResponse

deleteTenantPackage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteTenantPackage

Copy

let (response, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "package-987")
if response.isSome:
  let emptyResp = response.get()
  echo emptyResp
else:
  echo "Failed to delete tenant package"

getTenantPackage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrača: Option[GetTenantPackageResponse]

Primer

Primer getTenantPackage

Copy

let (response, httpResponse) = client.getTenantPackage(tenantId = "my-tenant-123", id = "premium-2026")
if response.isSome:
  let pkg = response.get()
  echo "Retrieved tenant package:"
  echo pkg
else:
  echo "Tenant package not found"

getTenantPackages

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrača: Option[GetTenantPackagesResponse]

Primer

getTenantPackages Primer

Copy

let (response, httpResponse) = client.getTenantPackages(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let packages = response.get()
  echo "Received tenant packages:"
  echo packages
else:
  echo "No packages found for tenant 'my-tenant-123'"

replaceTenantPackage

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
replaceTenantPackageBody	ReplaceTenantPackageBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer replaceTenantPackage

Copy

let (response, httpResponse) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-987",
  replaceTenantPackageBody = ReplaceTenantPackageBody(
    name = "Premium Plan",
    priceCents = 999,
    seats = 50,
    enabled = true,
    features = @["moderation", "analytics", "priority-support"]
  )
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

updateTenantPackage

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
updateTenantPackageBody	UpdateTenantPackageBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateTenantPackage

Copy

let packageBody = UpdateTenantPackageBody(
  name: "Pro Plan",
  priceCents: 1999,
  active: true,
  features: @["priority-support", "advanced-moderation"]
)
let (response, httpResponse) = client.updateTenantPackage(
  tenantId = "my-tenant-123",
  id = "pkg-789",
  updateTenantPackageBody = packageBody
)
if response.isSome:
  let apiEmpty = response.get()
  echo "Tenant package updated successfully, HTTP status: " & $httpResponse.status

createTenantUser

Parametri

Name	Type	Required	Description
tenantId	string	Da
createTenantUserBody	CreateTenantUserBody	Ne

Odziv

Vrne: Option[CreateTenantUserResponse]

Primer

createTenantUser Primer

Copy

let (response, httpResponse) = client.createTenantUser(tenantId = "my-tenant-123",
  createTenantUserBody = CreateTenantUserBody(userId = "user-456",
    email = "jane.doe@example.com",
    displayName = "Jane Doe",
    roles = @["editor"],
    isAdmin = false))
if response.isSome:
  let created = response.get()
  discard created

deleteTenantUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
deleteComments	string	Ne
commentDeleteMode	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteTenantUser

Copy

let (response, httpResponse) = client.deleteTenantUser(tenantId = "my-tenant-123", id = "user-789", deleteComments = "true", commentDeleteMode = "soft")
if response.isSome:
  let apiResp = response.get()
  echo "Tenant user deleted, response: ", apiResp
else:
  echo "Failed to delete tenant user, HTTP status: ", $httpResponse.status

getTenantUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetTenantUserResponse]

Primer

Primer uporabe getTenantUser

Copy

let (response, httpResponse) = client.getTenantUser(tenantId = "my-tenant-123", id = "user-789")
if response.isSome:
  let tenantUser = response.get()
  echo "User fetched:", tenantUser
else:
  echo "No user found, HTTP status:", httpResponse.status

getTenantUsers

Parametri

Name	Type	Required	Description
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrača: Option[GetTenantUsersResponse]

Primer

Primer getTenantUsers

Copy

let (response, httpResponse) = client.getTenantUsers(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let tenantUsers = response.get()
  echo "Retrieved tenant users"
else:
  echo "No tenant users returned"

replaceTenantUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
replaceTenantUserBody	ReplaceTenantUserBody	Ne
updateComments	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer replaceTenantUser

Copy

let body = ReplaceTenantUserBody(
  displayName = "Jane Doe",
  email = "jane.doe@example.com",
  externalId = "jdoe-789",
  admin = false,
  enabled = true,
  tags = @["editor", "subscriber"]
)
let (response, httpResponse) = client.replaceTenantUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  replaceTenantUserBody = body,
  updateComments = "true"
)
if response.isSome:
  let apiEmpty = response.get()
  echo "ReplaceTenantUser succeeded, http status:", httpResponse.status

sendLoginLink

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
redirectURL	string	Ne

Odgovor

Vrača: Option[APIEmptyResponse]

Primer

Primer sendLoginLink

Copy

let (response, httpResponse) = client.sendLoginLink(tenantId = "my-tenant-123", id = "user-456", redirectURL = "https://app.newsportal.com/welcome")
if response.isSome:
  let apiResp = response.get()
  echo "Login link sent successfully"
else:
  echo "Failed to send login link, HTTP status: ", $httpResponse.status

updateTenantUser

Parametri

Name	Type	Required
tenantId	string	Da
id	string	Ne
updateTenantUserBody	UpdateTenantUserBody	Ne
updateComments	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateTenantUser

Copy

let (response, httpResponse) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-987",
  updateTenantUserBody = UpdateTenantUserBody(
    displayName = "Jane Doe",
    email = "jane.doe@example.com",
    roles = @["moderator", "editor"],
    isActive = true
  ),
  updateComments = "true"
)
if response.isSome:
  let apiEmpty = response.get()
  discard apiEmpty

createTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantBody	CreateTenantBody	Ne

Odgovor

Vrne: Option[CreateTenantResponse]

Primer

Primer createTenant

Copy

let (response, httpResponse) = client.createTenant(
  tenantId = "my-tenant-123",
  createTenantBody = CreateTenantBody(
    name = "My Tenant 123",
    domain = "news.example.com",
    allowAnonymous = false,
    allowedOrigins = @["https://news.example.com", "https://api.news.example.com"],
    description = "Comments for News Example"
  )
)
if response.isSome:
  let created = response.get()
  echo "Created tenant: ", created.tenantId
else:
  echo "Failed to create tenant, status: ", httpResponse.status

deleteTenant

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
sure	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer deleteTenant

Copy

let (response, httpResponse) = client.deleteTenant(tenantId = "my-tenant-123", id = "", sure = "")
if response.isSome:
  let emptyResp = response.get()
else:
  discard httpResponse

getTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetTenantResponse]

Primer

Primer getTenant

Copy

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

getTenants

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
meta	string	Ne
skip	float64	Ne

Odgovor

Vrne: Option[GetTenantsResponse]

Primer

Primer getTenants

Copy

let (response, httpResponse) = client.getTenants(tenantId = "my-tenant-123", meta = "env=production", skip = 0.0)
if response.isSome:
  let tenantsResp = response.get()
  discard tenantsResp
  echo "Tenants fetched successfully"
else:
  echo "Request failed with status ", httpResponse.status

updateTenant

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateTenantBody	UpdateTenantBody	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateTenant

Copy

let (response, httpResponse) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "settings",
  updateTenantBody = UpdateTenantBody(
    name = "My Tenant 123",
    enableModeration = true,
    allowedDomains = @["news.example.com", "blog.example.org"],
    maxCommentLength = 1000
  )
)
if response.isSome:
  let apiResp = response.get()
  echo "Tenant updated successfully: ", apiResp
else:
  echo "Failed to update tenant, HTTP status: ", httpResponse.status

changeTicketState

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
id	string	Ne
changeTicketStateBody	ChangeTicketStateBody	Ne

Odgovor

Vrne: Option[ChangeTicketStateResponse]

Primer

Primer changeTicketState

Copy

let body = ChangeTicketStateBody()
let (response, httpResponse) = client.changeTicketState(tenantId = "my-tenant-123", userId = "user-456", id = "ticket-789", changeTicketStateBody = body)
if response.isSome:
  let ticketResp = response.get()
  echo "Ticket state changed:", ticketResp

createTicket

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
createTicketBody	CreateTicketBody	Ne

Odgovor

Vrne: Option[CreateTicketResponse]

Primer

Primer createTicket

Copy

let body = CreateTicketBody(
  subject = "Comment moderation issue",
  message = "Several abusive comments reported on article, please review and moderate.",
  tags = @["moderation", "abuse", "urgent"],
  url = "https://news.example.com/world/2026-election",
  priority = "high"
)
let (response, httpResponse) = client.createTicket(tenantId = "my-tenant-123", userId = "user-789", createTicketBody = body)
if response.isSome:
  let ticket = response.get()
  echo "Created ticket ID: ", ticket.id

getTicket

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
userId	string	Ne

Odgovor

Vrača: Option[GetTicketResponse]

Primer

Primer getTicket

Copy

let (response, httpResponse) = client.getTicket(tenantId = "my-tenant-123", id = "ticket-456", userId = "user-789")
if response.isSome:
  let ticket = response.get()
  echo "Got ticket:", ticket
else:
  echo "No ticket returned; HTTP response:", httpResponse

getTickets

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
userId	string	Ne
state	float64	Ne
skip	float64	Ne
limit	float64	Ne

Odgovor

Vrne: Option[GetTicketsResponse]

Primer

Primer getTickets

Copy

let (response, httpResponse) = client.getTickets(tenantId = "my-tenant-123", userId = "user-789", state = 1.0, skip = 0.0, limit = 50.0)
if response.isSome:
  let tickets = response.get()
  echo tickets

getTranslations

Parametri

Ime	Tip	Obvezno
namespace	string	Ne
component	string	Ne
locale	string	Ne
useFullTranslationIds	bool	Ne

Odgovor

Vrača: Option[GetTranslationsResponse]

Primer

Primer getTranslations

Copy

let (response, httpResponse) = client.getTranslations(
  namespace = "news-site",
  component = "article-comments",
  locale = "en-US",
  useFullTranslationIds = false
)
if response.isSome:
  let translations = response.get()
  discard translations
else:
  echo "No translations available"

uploadImage

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
file	string	Ne
sizePreset	SizePreset	Ne
urlId	string	Da

Odgovor

Vrne: Option[UploadImageResponse]

Primer

Primer uploadImage

Copy

let (response, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "assets/images/comment-avatar.jpg",
  sizePreset = SizePreset.small,
  urlId = "news/article-2025-11-22"
)
if response.isSome:
  let upload = response.get()
  echo "Uploaded image id: ", upload.id
  echo "Uploaded image url: ", upload.url

getUserBadgeProgressById

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Odgovor

Vrača: Option[APIGetUserBadgeProgressResponse]

Primer

getUserBadgeProgressById Primer

Copy

let (response, httpResponse) = client.getUserBadgeProgressById(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let badgeProgress = response.get()
  echo badgeProgress
else:
  echo "No badge progress found"

getUserBadgeProgressByUserId

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
userId	string	Ne

Odgovor

Vrne: Option[APIGetUserBadgeProgressResponse]

Primer

getUserBadgeProgressByUserId Primer

Copy

let tenantId = "my-tenant-123"
let userId = "user-456"
let (response, httpResponse) = client.getUserBadgeProgressByUserId(tenantId = tenantId, userId = userId)
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress retrieved for ", userId
  discard badgeProgress

getUserBadgeProgressList

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
userId	string	Ne
limit	float64	Ne
skip	float64	Ne

Odgovor

Vrne: Option[APIGetUserBadgeProgressListResponse]

Primer

Primer getUserBadgeProgressList

Copy

let (response, httpResponse) = client.getUserBadgeProgressList(
  tenantId = "my-tenant-123",
  userId = "user-789",
  limit = 25.0,
  skip = 0.0
)
if response.isSome:
  let badgeProgress = response.get()
  echo "Received badge progress:", badgeProgress
else:
  echo "No badge progress; HTTP status: ", $httpResponse.status

createUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createUserBadgeParams	CreateUserBadgeParams	Ne

Odgovor

Vrne: Option[APICreateUserBadgeResponse]

Primer

Primer createUserBadge

Copy

let (response, httpResponse) = client.createUserBadge(
  tenantId = "my-tenant-123",
  createUserBadgeParams = CreateUserBadgeParams(
    userId = "user-456",
    badgeId = "top-commenter",
    reason = "Top commenter for June 2026",
    awardedBy = "mod-team",
    metadata = @["news","engagement"]
  )
)
if response.isSome:
  let badgeResp = response.get()
  discard badgeResp

deleteUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptySuccessResponse]

Primer

Primer deleteUserBadge

Copy

let tenantId = "my-tenant-123"
let badgeId = "badge-456"
let (response, httpResponse) = client.deleteUserBadge(tenantId = tenantId, id = badgeId)
if response.isSome:
  let success = response.get()
  echo "Badge deleted successfully for tenant: ", tenantId, " id: ", badgeId
else:
  echo "Failed to delete badge. HTTP status: ", $httpResponse.status

getUserBadge

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIGetUserBadgeResponse]

Primer

Primer getUserBadge

Copy

let (response, httpResponse) = client.getUserBadge(tenantId = "my-tenant-123", id = "badge-9876")
if response.isSome:
  let badge = response.get()
  echo "Fetched badge:"
  echo badge
else:
  echo "No badge found"
  echo httpResponse

getUserBadges

Parametri

Name	Type	Obvezno
tenantId	string	Da
userId	string	Ne
badgeId	string	Ne
displayedOnComments	bool	Ne
limit	float64	Ne
skip	float64	Ne

Odgovor

Vrne: Option[APIGetUserBadgesResponse]

Primer

Primer getUserBadges

Copy

let (response, httpResponse) = client.getUserBadges(
  tenantId = "my-tenant-123",
  userId = "user-9876",
  badgeId = "top-commenter",
  displayedOnComments = true,
  limit = 20.0,
  skip = 0.0
)
if response.isSome:
  let badges = response.get()
  echo "Badges response:", badges
else:
  echo "No badges found (HTTP status: ", httpResponse.status, ")"

updateUserBadge

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateUserBadgeParams	UpdateUserBadgeParams	Ne

Odgovor

Vrne: Option[APIEmptySuccessResponse]

Primer

Primer updateUserBadge

Copy

let (response, httpResponse) = client.updateUserBadge(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateUserBadgeParams = UpdateUserBadgeParams()
)
if response.isSome:
  let success = response.get()
  echo "Badge updated successfully"
else:
  echo "Badge update failed"

getUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string	Ne

Odziv

Vrne: Option[GetUserNotificationCountResponse]

Primer

Primer getUserNotificationCount

Copy

let (response, httpResponse) = client.getUserNotificationCount(tenantId = "news-tenant-123", sso = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLTI0NyIsImlhdCI6MTYw945600fQ.sflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c")
if response.isSome:
  let countResp = response.get()
  echo "Received user notification count response: ", countResp
else:
  echo "No notification count returned"

getUserNotifications

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
pageSize	int	Ne
afterId	string	Ne
includeContext	bool	Ne
afterCreatedAt	int64	Ne
unreadOnly	bool	Ne
dmOnly	bool	Ne
noDm	bool	Ne
includeTranslations	bool	Ne
includeTenantNotifications	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[GetMyNotificationsResponse]

Primer

Primer getUserNotifications

Copy

let (response, httpResponse) = client.getUserNotifications(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  pageSize = 0,
  afterId = "",
  includeContext = false,
  afterCreatedAt = 0,
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  includeTranslations = false,
  includeTenantNotifications = false,
  sso = ""
)
if response.isSome:
  let notifications = response.get()
  echo notifications

resetUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string	Ne

Odgovor

Vrne: Option[ResetUserNotificationsResponse]

Primer

Primer uporabe resetUserNotificationCount

Copy

let (response, httpResponse) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "user-sso-token-456")
if response.isSome:
  let result = response.get()
  echo "ResetUserNotificationsResponse:", result
else:
  echo "Reset failed, HTTP response:", httpResponse

resetUserNotifications

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
afterId	string	Ne
afterCreatedAt	int64	Ne
unreadOnly	bool	Ne
dmOnly	bool	Ne
noDm	bool	Ne
sso	string	Ne

Odgovor

Vrne: Option[ResetUserNotificationsResponse]

Primer

Primer resetUserNotifications

Copy

let (response, httpResponse) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  afterId = "",
  afterCreatedAt = 0'i64,
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  sso = ""
)
if response.isSome:
  let resetResp = response.get()
  echo "ResetUserNotificationsResponse received"
else:
  echo "No ResetUserNotificationsResponse"

updateUserNotificationCommentSubscriptionStatus

Omogočite ali onemogočite obvestila za določen komentar.

Parametri

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

Odgovor

Vrača: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Primer

updateUserNotificationCommentSubscriptionStatus Primer

Copy

let (response, httpResponse) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "",
  optedInOrOut = "",
  commentId = "cmt-789",
  sso = ""
)
if response.isSome:
  let updateResp = response.get()
  echo "Subscription update response: ", updateResp

updateUserNotificationPageSubscriptionStatus

Omogočite ali onemogočite obvestila za stran. Ko so uporabniki naročeni na stran, se ustvarijo obvestila za nove vrhnje komentarje, in tudi

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
url	string	Ne
pageTitle	string	Ne
subscribedOrUnsubscribed	string	Ne
sso	string	Ne

Odgovor

Vrne: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Primer

Primer updateUserNotificationPageSubscriptionStatus

Copy

let (response, httpResponse) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/economy/market-rally-2026-06-19",
  url = "",
  pageTitle = "",
  subscribedOrUnsubscribed = "",
  sso = ""
)
if response.isSome:
  let updateResp = response.get()
  echo "Subscription update received: ", updateResp
else:
  echo "No subscription update returned."

updateUserNotificationStatus

Parametri

Name	Type	Required
tenantId	string	Da
notificationId	string	Ne
newStatus	string	Ne
sso	string	Ne

Odziv

Vrača: Option[UpdateUserNotificationStatusResponse]

Primer

Primer updateUserNotificationStatus

Copy

let (response, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = "sso-token-abc123"
)
if response.isSome:
  let updated = response.get()
  echo "Notification status updated successfully"
else:
  echo "No update response received"

getUserPresenceStatuses

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlIdWS	string	Ne
userIds	string	Ne

Odgovor

Vrne: Option[GetUserPresenceStatusesResponse]

Primer

Primer getUserPresenceStatuses

Copy

let (response, httpResponse) = client.getUserPresenceStatuses(tenantId = "my-tenant-123", urlIdWS = "news/article-title", userIds = "user-123,user-456")
if response.isSome:
  let presenceStatuses = response.get()
  echo presenceStatuses
else:
  echo "No presence data"

searchUsers

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
usernameStartsWith	string	Ne
mentionGroupIds	seq[string]	Ne
sso	string	Ne
searchSection	string	Ne

Odgovor

Vrne: Option[SearchUsersResult]

Primer

Primer uporabe searchUsers

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/top-story",
  usernameStartsWith = "",
  mentionGroupIds = @[],
  sso = "",
  searchSection = ""
)
if response.isSome:
  let searchResult = response.get()
  echo "SearchUsersResult:", searchResult
else:
  echo "No result or error. HTTP response:", httpResponse

getUser

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetUserResponse]

Primer

Primer getUser

Copy

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

createVote

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
commentId	string	Da
direction	string	Ne
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: Option[VoteResponse]

Primer

Primer createVote

Copy

let (response, httpResponse) = client.createVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  direction = "up",
  userId = "user-42",
  anonUserId = ""
)
if response.isSome:
  let vote = response.get()
  echo "Vote created:", vote
else:
  echo "No vote returned"

deleteVote

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
editKey	string	Ne

Odgovor

Vrne: Option[VoteDeleteResponse]

Primer

deleteVote Primer

Copy

let (response, httpResponse) = client.deleteVote(tenantId = "my-tenant-123", id = "vote-7f3b2a", editKey = "")
if response.isSome:
  let voteDelete = response.get()
  echo "Vote deleted successfully"
else:
  echo "Failed to delete vote"

getVotes

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[GetVotesResponse]

Primer

Primer getVotes

Copy

let (response, httpResponse) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/breaking-article-456")
if response.isSome:
  let votesResp = response.get()
  echo "Received votes response:", $votesResp
else:
  echo "No votes returned, HTTP response:", $httpResponse

getVotesForUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
userId	string	Ne
anonUserId	string	Ne

Odgovor

Vrne: Option[GetVotesForUserResponse]

Primer

getVotesForUser Primer

Copy

let (response, httpResponse) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userId = "user-789",
  anonUserId = ""
)
if response.isSome:
  let votes = response.get()
  echo "User votes retrieved"
else:
  echo "No votes found"

Potrebujete pomoč?

Če naletite na težave ali imate vprašanja v zvezi z Nim SDK, prosimo:

Prispevanje

Prispevki so dobrodošli! Prosimo, obiščite GitHub repozitorij za smernice o prispevanju.

Jezik 🇸🇮 Slovenščina

Dokumentacija

Začetek

API referenca

Uporaba

Agregiranje

Revizijski zapisi

Avtentikacija

Blokiranje pri komentiranju

Preveri blokirane komentarje

Komentarji

Komentarji za uporabnika

Konfiguracije domene

E-poštne predloge

Dnevnik dogodkov

Objave

Prijavi komentar

GIFi

Hashtagi

Moderacija

Moderatorji

Število obvestil

Obvestila

Reakcije strani

Strani

Čakajoči Webhook dogodki

Konfiguracije vprašanj

Rezultati vprašanj

Agregacija rezultatov vprašanj

SSO uporabniki

Naročnine

Dnevna uporaba najemnika

Paketi najemnika

Uporabniki najemnika

Najemniki

Vstopnice

Prevodi

Naloži sliko

Napredek značke uporabnika

Uporabniške značke

Uporabniška obvestila

Status prisotnosti uporabnika

Iskanje uporabnikov

Uporabniki

Glasovi

FastComments Nim SDK

Repozitorij

Zahteve

Namestitev

Uporaba Nimble

Gradnja iz izvorne kode

Vsebina knjižnice

Javni in zavarovani API-ji

Hiter začetek

Uporaba avtenticiranih API-jev (DefaultAPI)

Uporaba javnih API-jev (PublicAPI)

Uporaba moderacijskih API-jev (ModerationAPI)

Pogoste težave

Klicanje API-ja

Primer: Pridobivanje komentarjev

Opombe

ID-ji oddaj

SSO (Enkratna prijava)

Uporaba SSO

Enostaven SSO

Varen SSO

Dokumentacija za fastcomments

Dokumentacija za API končne točke

Dokumentacija za modele

aggregate

Parametri

Odgovor

Primer

getAuditLogs

Parametri

Odgovor

Primer

logoutPublic

Odgovor

Primer