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

Using Nimble

nimble install fastcomments

Building from Source

nimble build

Library Contents

Ta knjižnica vsebuje ustvarjen API odjemalec in SSO pripomočke, ki olajšajo delo z API-jem.

API Client Library Docs

Public vs Secured APIs

Za API odjemalca obstajajo trije API moduli, api_default, api_public in api_moderation. api_default vsebuje metode, ki zahtevajo vaš API ključ, api_public vsebuje klice API, ki jih je mogoče izvesti neposredno iz brskalnika/mobilne naprave/ipd. brez avtentikacije. Modul api_moderation vsebuje metode za nadzorno ploščo moderatorjev.

Modul api_moderation ponuja obsežen nabor API-jev za živo in hitro moderiranje. Vsaka metoda api_moderation sprejme parameter sso in lahko overi prek SSO ali piškotka seje FastComments.com.

Hiter začetek

Uporaba avtenticiranih API-jev (DefaultAPI)

Pomembno: Avtenticirani končni naslovi 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"

# Naredi avtenticirane klice API-ja.
# Zahtevani parametri (in telo zahteve) so položajni; neobvezni
# parametri se posredujejo prek objekt options operacije.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Uporaba javnih API-jev (PublicAPI)

Javni končni naslovi ne zahtevajo avtentikacije:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Naredi javne klice API-ja.
# tenantId in urlId sta obvezna (položajna); vse ostalo je neobvezno.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Uporaba moderacijskih API-jev (ModerationAPI)

Moderacijski končni naslovi poganjajo nadzorno ploščo moderatorja in so avtenticirani z SSO žetonom za delujočega moderatorja:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Izpiši komentarje v moderacijski nadzorni plošči.
# Ta operacija nima zahtevanih parametrov, zato je vse neobvezno.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Pogoste težave

Napaka 401 pri avtentikaciji: Prepričajte se, da ste nastavili glavo x-api-key na vašem HttpClient-u pred pošiljanjem zahtevanj DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Napačen API razred: Uporabite api_default za strežniške avtenticirane zahteve, api_public za odjemalske/javne zahteve in api_moderation za zahteve moderacijske nadzorne plošče.

Klicanje API-ja

All API metode v tem SDK-ju vrnejo nizek (Option[ResponseType], Response). Prvi element vsebuje razčlenjen odgovor, če je uspešen, drugi element pa je surov HTTP odziv.

Obvezni parametri in telo zahteve se posredujejo pozicijsko. Preostali neobvezni parametri se zberejo v en sam objekt Api<Operation>Options, ki je zadnji argument. Operacije brez neobveznih parametrov ne uporabljajo objekta možnosti.

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",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

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

aggregate

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

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Odgovor

Vrne: Option[AggregateResponse]

Primer

Primer agregacije

Copy

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

getAuditLogs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetAuditLogsOptions	Ne

Odziv

Vrne: Option[GetAuditLogsResponse]

Primer

getAuditLogs Primer

Copy

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

logoutPublic

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

logoutPublic Primer

Copy

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

blockFromCommentPublic

Parametri

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

Odgovor

Vrne: Option[BlockSuccess]

Primer

blockFromCommentPublic Primer

Copy

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

unBlockCommentPublic

Parameters

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

Response

Vrne: Option[UnblockSuccess]

Example

unBlockCommentPublic Primer

Copy

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

checkedCommentsForBlocked

Parameters

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

Response

Vrne: Option[CheckBlockedCommentsResponse]

Primer

checkedCommentsForBlocked Primer

Copy

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

blockUserFromComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
blockFromCommentParams	BlockFromCommentParams	Ne
options	BlockUserFromCommentOptions	Ne

Odgovor

Vrne: Option[BlockSuccess]

Primer

blockUserFromComment Primer

Copy

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

createCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Odgovor

Vrne: Option[SaveCommentsResponseWithPresence]

Primer

createCommentPublic Primer

Copy

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

deleteComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
options	DeleteCommentOptions	Ne

Odgovor

Vrne: Option[DeleteCommentResult]

Primer

Primer deleteComment

Copy

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

deleteCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Odgovor

Vrne: Option[PublicAPIDeleteCommentResponse]

Primer

Primer deleteCommentPublic

Copy

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

deleteCommentVote

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
options	DeleteCommentVoteOptions	No

Odgovor

Vrne: Option[VoteDeleteResponse]

Primer

Primer deleteCommentVote

Copy

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

flagComment

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
options	FlagCommentOptions	Ne

Odgovor

Vrne: Option[FlagCommentResponse]

Primer

Primer flagComment

Copy

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

getComment

Parameters

Ime	Tip	Obvezno	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-789")
if response.isSome:
  let comment = response.get()
  discard comment

getComments

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetCommentsOptions	Ne

Odgovor

Returns: Option[APIGetCommentsResponse]

Primer

Primer getComments

Copy

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

getCommentsPublic

req tenantId urlId

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
options	GetCommentsPublicOptions	Ne

Odgovor

Vrne: Option[GetCommentsResponseWithPresencePublicComment]

Primer

Primer getCommentsPublic

Copy

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

getCommentText

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
options	GetCommentTextOptions	Ne

Odgovor

Vrne: Option[PublicAPIGetCommentTextResponse]

Primer

Primer getCommentText

Copy

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

getCommentVoteUserNames

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

Odziv

Vrne: Option[GetCommentVoteUserNamesSuccessResponse]

Primer

Primer getCommentVoteUserNames

Copy

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

lockComment

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

lockComment Primer

Copy

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

pinComment

Parametri

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

Odgovor

Vrne: Option[ChangeCommentPinStatusResponse]

Primer

pinComment Primer

Copy

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

saveComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

Odgovor

Vrne: Option[APISaveCommentResponse]

Primer

saveComment Primer

Copy

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

saveCommentsBulk

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createCommentParams	seq[CreateCommentParams]	Ne
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Ne
id	string	Ne
fromName	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

saveCommentsBulk Primer

Copy

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

setCommentText

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
commentTextUpdateRequest	CommentTextUpdateRequest	Ne
options	SetCommentTextOptions	Ne

Odziv

Vrne: Option[PublicAPISetCommentTextResponse]

Primer

Primer setCommentText

Copy

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

unBlockUserFromComment

Parameteri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

Odgovor

Vrne: Option[UnblockSuccess]

Primer

unBlockUserFromComment Primer

Copy

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

unFlagComment

Parametri

Ime	Tip	Zahtevano
tenantId	string	Da
id	string	Ne
options	UnFlagCommentOptions	Ne

Odgovor

Vrne: Option[FlagCommentResponse]

Primer

Primer unFlagComment

Copy

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

unLockComment

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
sso	string = ""	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

unLockComment Primer

Copy

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

unPinComment

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
broadcastId	string	Ne
sso	string = ""	Ne

Odgovor

Vrne: Option[ChangeCommentPinStatusResponse]

Primer

Primer unPinComment

Copy

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

updateComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Odziv

Vrne: Option[APIEmptyResponse]

Primer

updateComment Primer

Copy

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

voteComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
urlId	string	Da
broadcastId	string	Ne
voteBodyParams	VoteBodyParams	Ne
options	VoteCommentOptions	Ne

Odgovor

Vrne: Option[VoteResponse]

Primer

voteComment Primer

Copy

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

getCommentsForUser

Parametri

Ime	Tip	Obvezno	Opis
options	GetCommentsForUserOptions	Ne

Odgovor

Vrne: Option[GetCommentsForUserResponse]

Primer

getCommentsForUser Primer

Copy

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

addDomainConfig

Parametri

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Odgovor

Vrne: Option[AddDomainConfigResponse]

Primer

addDomainConfig Primer

Copy

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

deleteDomainConfig

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Da
domain	string	Ne

Odziv

Returns: Option[DeleteDomainConfigResponse]

Primer

deleteDomainConfig Primer

Copy

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

getDomainConfig

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
domain	string	No

Odgovor

Vrne: Option[GetDomainConfigResponse]

Primer

Primer getDomainConfig

Copy

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

getDomainConfigs

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrne: Option[GetDomainConfigsResponse]

Primer

Primer getDomainConfigs

Copy

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

patchDomainConfig

Parametri

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

Odgovor

Vrne: Option[PatchDomainConfigResponse]

Primer

patchDomainConfig Primer

Copy

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

putDomainConfig

Parametri

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

Odgovor

Vrne: Option[PutDomainConfigResponse]

Primer

Primer putDomainConfig

Copy

let (optResp, httpResp) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "example.com",
  updateDomainConfigParams = UpdateDomainConfigParams()
)
if optResp.isSome:
  let resp = optResp.get()
  echo resp

createEmailTemplate

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Odziv

Vrne: Option[CreateEmailTemplateResponse]

Primer

createEmailTemplate Primer

Copy

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

deleteEmailTemplate

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteEmailTemplate Primer

Copy

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

deleteEmailTemplateRenderError

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	No
errorId	string	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteEmailTemplateRenderError Primer

Copy

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

getEmailTemplate

Parametri

Ime	Vrsta	Obvezno	Opis
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")
if response.isSome:
  let tmpl = response.get()

getEmailTemplateDefinitions

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da

Odgovor

Vrne: Option[GetEmailTemplateDefinitionsResponse]

Primer

Primer getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	No
skip	float64	No

Odgovor

Vrne: Option[GetEmailTemplateRenderErrorsResponse]

Primer

getEmailTemplateRenderErrors Primer

Copy

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

getEmailTemplates

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrne: Option[GetEmailTemplatesResponse]

Primer

getEmailTemplates Primer

Copy

let (emailTemplatesOpt, httpResp) = client.getEmailTemplates(tenantId = "my-tenant-123", skip = 0.0)
if emailTemplatesOpt.isSome:
  let templates = emailTemplatesOpt.get()
  echo templates

renderEmailTemplate

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
renderEmailTemplateBody	RenderEmailTemplateBody	Ne
locale	string = ""	Ne

Odgovor

Vrne: Option[RenderEmailTemplateResponse]

Primer

Primer renderEmailTemplate

Copy

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

updateEmailTemplate

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

updateEmailTemplate Primer

Copy

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

getEventLog

req tenantId urlId userIdWS

Parametri

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

Odgovor

Vrne: Option[GetEventLogResponse]

Primer

Primer getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Odgovor

Vrne: Option[GetEventLogResponse]

Primer

Primer getGlobalEventLog

Copy

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

createFeedPost

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
createFeedPostParams	CreateFeedPostParams	Ne
options	CreateFeedPostOptions	Ne

Odgovor

Vrne: Option[CreateFeedPostsResponse]

Primer

createFeedPost Primer

Copy

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

createFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

Odgovor

Vrne: Option[CreateFeedPostResponse]

Primer

createFeedPostPublic Primer

Copy

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

deleteFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Ne
options	DeleteFeedPostPublicOptions	Ne

Odgovor

Vrne: Option[DeleteFeedPostPublicResponse]

Primer

deleteFeedPostPublic Primer

Copy

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

getFeedPosts

req tenantId afterId

Parametri

Name	Type	Required	Description
tenantId	string	Da
options	GetFeedPostsOptions	Ne

Odgovor

Vrne: Option[GetFeedPostsResponse]

Primer

getFeedPosts Primer

Copy

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

getFeedPostsPublic

req tenantId afterId

Parametri

Ime	Tip	Potrebno	Opis
tenantId	string	Da
options	GetFeedPostsPublicOptions	Ne

Odgovor

Vrača: Option[PublicFeedPostsResponse]

Primer

Primer getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

Odgovor

Returns: Option[FeedPostsStatsResponse]

Primer

Primer getFeedPostsStats

Copy

let (statsOpt, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["post-abc", "post-def"],
  sso = "sso-token",
)
if statsOpt.isSome:
  let stats = statsOpt.get()
  # uporabi stats po potrebi

getUserReactsPublic

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
options	GetUserReactsPublicOptions	No

Odgovor

Vrne: Option[UserReactsResponse]

Primer

Primer getUserReactsPublic

Copy

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

reactFeedPostPublic

Parameters

Ime	Tip	Obvezno
tenantId	string	Da
postId	string	Ne
reactBodyParams	ReactBodyParams	Ne
options	ReactFeedPostPublicOptions	Ne

Response

Vrne: Option[ReactFeedPostResponse]

Primer

reactFeedPostPublic Primer

Copy

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

updateFeedPost

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
feedPost	FeedPost	Ne

Odziv

Vrne: Option[APIEmptyResponse]

Primer

updateFeedPost Primer

Copy

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

updateFeedPostPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Odgovor

Vrne: Option[CreateFeedPostResponse]

Primer

Primer updateFeedPostPublic

Copy

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

flagCommentPublic

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string = ""	No

Odgovor

Returns: Option[APIEmptyResponse]

Primer

Primer flagCommentPublic

Copy

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

getGifLarge

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
largeInternalURLSanitized	string	No

Odgovor

Vrne: Option[GifGetLargeResponse]

Primer

Primer getGifLarge

Copy

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

getGifsSearch

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
search	string	Ne
options	GetGifsSearchOptions	Ne

Odgovor

Vrne: Option[GetGifsSearchResponse]

Primer

Primer getGifsSearch

Copy

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

getGifsTrending

Parametri

Ime	Vrsta	Potrebno	Opis
tenantId	string	Da
options	GetGifsTrendingOptions	Ne

Odziv

Vrne: Option[GetGifsTrendingResponse]

Primer

getGifsTrending Primer

Copy

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

addHashTag

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
createHashTagBody	CreateHashTagBody	Ne

Odgovor

Vrne: Option[CreateHashTagResponse]

Primer

addHashTag Primer

Copy

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

addHashTagsBulk

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Ne

Odgovor

Vrne: Option[BulkCreateHashTagsResponse]

Primer

addHashTagsBulk Primer

Copy

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

deleteHashTag

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
tag	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteHashTag Primer

Copy

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

getHashTags

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
page	float64	No

Odgovor

Vrne: Option[GetHashTagsResponse]

Primer

getHashTags Primer

Copy

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

patchHashTag

Parametri

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

Odgovor

Vrne: Option[UpdateHashTagResponse]

Primer

patchHashTag Primer

Copy

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

deleteModerationVote

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
voteId	string	Ne
options	DeleteModerationVoteOptions	Ne

Odziv

Vrne: Option[VoteDeleteResponse]

Primer

deleteModerationVote Primer

Copy

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

getApiComments

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetApiCommentsOptions	Ne

Odgovor

Returns: Option[ModerationAPIGetCommentsResponse]

Primer

getApiComments Primer

Copy

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

getApiExportStatus

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
options	GetApiExportStatusOptions	No

Odziv

Vrne: Option[ModerationExportStatusResponse]

Primer

Primer getApiExportStatus

Copy

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

getApiIds

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetApiIdsOptions	Ne

Odgovor

Vrne: Option[ModerationAPIGetCommentIdsResponse]

Primer

Primer getApiIds

Copy

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

getBanUsersFromComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
sso	string = ""	Ne

Odgovor

Vrne: Option[GetBannedUsersFromCommentResponse]

Primer

getBanUsersFromComment Primer

Copy

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

getCommentBanStatus

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
sso	string = ""	Ne

Odgovor

Vrne: Option[GetCommentBanStatusResponse]

Primer

Primer getCommentBanStatus

Copy

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

getCommentChildren

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Odgovor

Vrne: Option[ModerationAPIChildCommentsResponse]

Primer

getCommentChildren Primer

Copy

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

getCount

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetCountOptions	Ne

Odgovor

Vrne: Option[ModerationAPICountCommentsResponse]

Primer

Primer getCount

Copy

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

getCounts

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
sso	string = ""	Ne

Odgovor

Vrne: Option[GetBannedUsersCountResponse]

Primer

getCounts Primer

Copy

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

getLogs

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
sso	string = ""	Ne

Odgovor

Vrne: Option[ModerationAPIGetLogsResponse]

Primer

Primer getLogs

Copy

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

getManualBadges

Parametri

Ime	Tip	Potrebno	Opis
tenantId	string	Da
sso	string = ""	Ne

Odgovor

Vrne: Option[GetTenantManualBadgesResponse]

Primer

Primer getManualBadges

Copy

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

getManualBadgesForUser

Parametri

Name	Type	Required	Description
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

Odgovor

Vrne: Option[GetUserManualBadgesResponse]

Primer

Primer getManualBadgesForUser

Copy

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

getModerationComment

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
options	GetModerationCommentOptions	Ne

Odziv

Vrne: Option[ModerationAPICommentResponse]

Primer

getModerationComment Primer

Copy

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

getModerationCommentText

Parametri

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

Odgovor

Vrne: Option[GetCommentTextResponse]

Primer

getModerationCommentText Primer

Copy

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

getPreBanSummary

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
options	GetPreBanSummaryOptions	Ne

Odgovor

Vrne: Option[PreBanSummary]

Primer

getPreBanSummary Primer

Copy

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

getSearchCommentsSummary

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

Odgovor

Vrne: Option[ModerationCommentSearchResponse]

Primer

getSearchCommentsSummary Primer

Copy

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

getSearchPages

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetSearchPagesOptions	Ne

Odgovor

Vrne: Option[ModerationPageSearchResponse]

Primer

Primer getSearchPages

Copy

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

getSearchSites

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetSearchSitesOptions	Ne

Odgovor

Vrne: Option[ModerationSiteSearchResponse]

Primer

Primer getSearchSites

Copy

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

getSearchSuggest

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetSearchSuggestOptions	Ne

Odgovor

Vrne: Option[ModerationSuggestResponse]

Primer

getSearchSuggest Primer

Copy

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

getSearchUsers

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetSearchUsersOptions	Ne

Odgovor

Vrne: Option[ModerationUserSearchResponse]

Primer

getSearchUsers Primer

Copy

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

getTrustFactor

Parametri

Name	Type	Required	Description
tenantId	string	Da
options	GetTrustFactorOptions	Ne

Odziv

Vrne: Option[GetUserTrustFactorResponse]

Primer

Primer getTrustFactor

Copy

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

getUserBanPreference

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string = ""	Ne

Odgovor

Vrne: Option[APIModerateGetUserBanPreferencesResponse]

Primer

getUserBanPreference Primer

Copy

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

getUserInternalProfile

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

Odgovor

Vrne: Option[GetUserInternalProfileResponse]

Primer

Primer getUserInternalProfile

Copy

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

postAdjustCommentVotes

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

Odgovor

Vrne: Option[AdjustVotesResponse]

Primer

Primer postAdjustCommentVotes

Copy

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

postApiExport

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	PostApiExportOptions	Ne

Odgovor

Vrne: Option[ModerationExportResponse]

Primer

postApiExport Primer

Copy

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

postBanUserFromComment

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
options	PostBanUserFromCommentOptions	Ne

Odgovor

Vrne: Option[BanUserFromCommentResult]

Primer

postBanUserFromComment Primer

Copy

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

postBanUserUndo

Parametri

Ime	Vrsta	Required
tenantId	string	Yes
banUserUndoParams	BanUserUndoParams	No
sso	string = ""	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

postBanUserUndo Primer

Copy

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

postBulkPreBanSummary

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Odgovor

Vrne: Option[BulkPreBanSummary]

Primer

postBulkPreBanSummary Primer

Copy

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

postCommentsByIds

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentsByIdsParams	CommentsByIdsParams	Ne
sso	string = ""	Ne

Odgovor

Vrne: Option[ModerationAPIChildCommentsResponse]

Primer

postCommentsByIds Primer

Copy

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

postFlagComment

Parameters

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
options	PostFlagCommentOptions	Ne

Response

Vrne: Option[APIEmptyResponse]

Example

postFlagComment Primer

Copy

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

postRemoveComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
options	PostRemoveCommentOptions	Ne

Odgovor

Vrne: Option[PostRemoveCommentApiResponse]

Primer

postRemoveComment Primer

Copy

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

postRestoreDeletedComment

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

postRestoreDeletedComment Primer

Copy

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

postSetCommentApprovalStatus

Parametri

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

Odgovor

Vrne: Option[SetCommentApprovedResponse]

Primer

postSetCommentApprovalStatus Primer

Copy

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

postSetCommentReviewStatus

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
commentId	string	Da
options	PostSetCommentReviewStatusOptions	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

postSetCommentReviewStatus Primer

Copy

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

postSetCommentSpamStatus

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

postSetCommentSpamStatus Primer

Copy

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

postSetCommentText

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

Odgovor

Vrne: Option[SetCommentTextResponse]

Primer

postSetCommentText Primer

Copy

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

postUnFlagComment

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
commentId	string	Yes
options	PostUnFlagCommentOptions	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

postUnFlagComment Primer

Copy

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

postVote

Parametri

Ime	Tip	Zahtevano
tenantId	string	Yes
commentId	string	Yes
options	PostVoteOptions	No

Odgovor

Vrne: Option[VoteResponse]

Primer

postVote Primer

Copy

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

putAwardBadge

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
badgeId	string	Ne
options	PutAwardBadgeOptions	Ne

Odgovor

Vrne: Option[AwardUserBadgeResponse]

Primer

putAwardBadge Primer

Copy

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

putCloseThread

Parametri

Ime	Tip	Potrebno
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Odziv

Vrne: Option[APIEmptyResponse]

Primer

putCloseThread Primer

Copy

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

putRemoveBadge

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
badgeId	string	Ne
options	PutRemoveBadgeOptions	Ne

Odgovor

Vrne: Option[RemoveUserBadgeResponse]

Primer

putRemoveBadge Primer

Copy

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

putReopenThread

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

putReopenThread Primer

Copy

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

setTrustFactor

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	SetTrustFactorOptions	Ne

Odgovor

Returns: Option[SetUserTrustFactorResponse]

Primer

setTrustFactor Primer

Copy

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

createModerator

Parametri

Name	Type	Required	Description
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	No

Odziv

Vrne: Option[CreateModeratorResponse]

Primer

createModerator Primer

Copy

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

deleteModerator

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
id	string	Ne
sendEmail	string = ""	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteModerator Primer

Copy

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

getModerator

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetModeratorResponse]

Primer

getModerator Primer

Copy

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

getModerators

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrne: Option[GetModeratorsResponse]

Primer

Primer getModerators

Copy

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

updateModerator

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateModerator

Copy

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

deleteNotificationCount

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteNotificationCount Primer

Copy

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

getCachedNotificationCount

Parametri

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Odgovor

Vrne: Option[GetCachedNotificationCountResponse]

Primer

getCachedNotificationCount Primer

Copy

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

getNotificationCount

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetNotificationCountOptions	Ne

Odgovor

Vrne: Option[GetNotificationCountResponse]

Primer

getNotificationCount Primer

Copy

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

getNotifications

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
options	GetNotificationsOptions	No

Odgovor

Vrne: Option[GetNotificationsResponse]

Primer

Primer getNotifications

Copy

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

updateNotification

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

updateNotification Primer

Copy

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

createV1PageReact

Parameters

Ime	Tip	Obvezno
tenantId	string	Yes
urlId	string	Yes
title	string = ""	No

Odziv

Vrne: Option[CreateV1PageReact]

Primer

createV1PageReact Primer

Copy

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

createV2PageReact

Parametri

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

Odgovor

Returns: Option[CreateV1PageReact]

Primer

createV2PageReact Primer

Copy

let (pageResult, httpResponse) = client.createV2PageReact(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  id = "page-456",
  title = "Breaking News",
)
if pageResult.isSome:
  let page = pageResult.get()
  # uporabite `page` po potrebi

deleteV1PageReact

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[CreateV1PageReact]

Primer

deleteV1PageReact Primer

Copy

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

deleteV2PageReact

Parametri

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

Odgovor

Vrne: Option[CreateV1PageReact]

Primer

Primer deleteV2PageReact

Copy

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

getV1PageLikes

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Vrne: Option[GetV1PageLikes]

Primer

Primer getV1PageLikes

Copy

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

getV2PageReacts

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[GetV2PageReacts]

Primer

getV2PageReacts Primer

Copy

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

getV2PageReactUsers

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
urlId	string	Yes
id	string	No

Odziv

Vrne: Option[GetV2PageReactUsersResponse]

Primer

getV2PageReactUsers Primer

Copy

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

addPage

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Odgovor

Vrne: Option[AddPageAPIResponse]

Primer

addPage Primer

Copy

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

deletePage

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[DeletePageAPIResponse]

Primer

deletePage Primer

Copy

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

getOfflineUsers

Prejšnji komentatorji na strani, ki NI trenutno v povezavi. Razvrščeni po displayName.
Uporabite to po izčrpavanju /users/online za prikaz odseka "Members".
Cursor paginacija po commenterName: strežnik prehaja delni {tenantId, urlId, commenterName} indeks od afterName naprej prek $gt, brez stroška $skip.

Parameters

Ime	Vrsta	Obvezno
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Response

Vrne: Option[PageUsersOfflineResponse]

Primer

Primer getOfflineUsers

Copy

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

getOnlineUsers

Trenutno povezana gledalci strani: ljudje, katerih websocket seja je trenutno naročena na stran.
Vrne anonCount + totalCount (pretplatnike po celotnem prostoru, vključno z anonimnimi gledalci, ki jih ne naštejemo).

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
options	GetOnlineUsersOptions	Ne

Odgovor

Vrne: Option[PageUsersOnlineResponse]

Primer

getOnlineUsers Primer

Copy

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

getPageByURLId

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
urlId	string	Da

Odgovor

Vrne: Option[GetPageByURLIdAPIResponse]

Primer

getPageByURLId Primer

Copy

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

getPages

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes

Odziv

Vrne: Option[GetPagesAPIResponse]

Primer

Primer getPages

Copy

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

getPagesPublic

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

Seznam strani za najemnika. Uporablja ga namizni odjemalec FChat za napolnitev seznama sob.
Zahteva, da je enableFChat nastavljen na true v razrešenih prilagojenih nastavitvah za vsako stran.
Strani, ki zahtevajo SSO, so filtrirane glede na dostop do skupine zahtevajočega uporabnika.

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetPagesPublicOptions	No

Response

Returns: Option[GetPublicPagesResponse]

Example

Primer getPagesPublic

Copy

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

getUsersInfo

Masovne informacije o uporabniku za najemnika. Glede na userIds vrne prikazne informacije iz User / SSOUser.
Uporablja se v pripomočku za komentarje za obogatitev uporabnikov, ki se pojavijo preko dogodka prisotnosti.
Ni konteksta strani: zasebnost je enotno uveljavljena (zasebni profili so maskirani).

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
ids	string	Ne

Odgovor

Vrne: Option[PageUsersInfoResponse]

Primer

Primer getUsersInfo

Copy

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

patchPage

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Odgovor

Vrne: Option[PatchPageAPIResponse]

Primer

patchPage Primer

Copy

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

deletePendingWebhookEvent

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odziv

Vrne: Option[APIEmptyResponse]

Primer

Primer deletePendingWebhookEvent

Copy

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

getPendingWebhookEventCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetPendingWebhookEventCountOptions	Ne

Odgovor

Vrne: Option[GetPendingWebhookEventCountResponse]

Primer

Primer getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
options	GetPendingWebhookEventsOptions	Ne

Odgovor

Vrne: Option[GetPendingWebhookEventsResponse]

Primer

Primer getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	No

Odziv

Vrne: Option[CreateQuestionConfigResponse]

Primer

createQuestionConfig Primer

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # uporabite resp po potrebi

deleteQuestionConfig

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteQuestionConfig Primer

Copy

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

getQuestionConfig

Parametri

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetQuestionConfigResponse]

Primer

Primer getQuestionConfig

Copy

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

getQuestionConfigs

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
skip	float64	Ne

Odgovor

Vrne: Option[GetQuestionConfigsResponse]

Primer

getQuestionConfigs Primer

Copy

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

updateQuestionConfig

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

updateQuestionConfig Primer

Copy

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

createQuestionResult

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
createQuestionResultBody	CreateQuestionResultBody	Ne

Odziv

Vrne: Option[CreateQuestionResultResponse]

Primer

createQuestionResult Primer

Copy

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

deleteQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Da
id	string	Ne

Response

Returns: Option[APIEmptyResponse]

Example

deleteQuestionResult Primer

Copy

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

getQuestionResult

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vrne: Option[GetQuestionResultResponse]

Primer

Primer getQuestionResult

Copy

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

getQuestionResults

Parametri

Ime	Tip	Zahtevano	Opis
tenantId	string	Yes
options	GetQuestionResultsOptions	No

Odgovor

Vrne: Option[GetQuestionResultsResponse]

Primer

Primer getQuestionResults

Copy

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

updateQuestionResult

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

updateQuestionResult Primer

Copy

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

aggregateQuestionResults

Parametri

Ime	Tip	Potrebno	Opis
tenantId	string	Da
options	AggregateQuestionResultsOptions	Ne

Odziv

Vrne: Option[AggregateQuestionResultsResponse]

Primer

aggregateQuestionResults Primer

Copy

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

bulkAggregateQuestionResults

Parametri

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

Odgovor

Vrne: Option[BulkAggregateQuestionResultsResponse]

Primer

bulkAggregateQuestionResults Primer

Copy

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

combineCommentsWithQuestionResults

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	CombineCommentsWithQuestionResultsOptions	Ne

Odgovor

Vrne: Option[CombineQuestionResultsWithCommentsResponse]

Primer

combineCommentsWithQuestionResults Primer

Copy

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

addSSOUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createAPISSOUserData	CreateAPISSOUserData	Ne

Odgovor

Vrne: Option[AddSSOUserAPIResponse]

Primer

addSSOUser Primer

Copy

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

deleteSSOUser

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
id	string	Ne
options	DeleteSSOUserOptions	Ne

Odziv

Vrne: Option[DeleteSSOUserAPIResponse]

Primer

Primer deleteSSOUser

Copy

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

getSSOUserByEmail

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
email	string	Ne

Odgovor

Returns: Option[GetSSOUserByEmailAPIResponse]

Primer

Primer getSSOUserByEmail

Copy

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

getSSOUserById

Parametri

Ime	Tip	Potrebno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vrne: Option[GetSSOUserByIdAPIResponse]

Primer

Primer getSSOUserById

Copy

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

getSSOUsers

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
skip	int	Ne

Odziv

Vrne: Option[GetSSOUsersResponse]

Primer

Primer getSSOUsers

Copy

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

patchSSOUser

Parametri

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

Odgovor

Vrne: Option[PatchSSOUserAPIResponse]

Primer

patchSSOUser Primer

Copy

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

putSSOUser

Parametri

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

Odgovor

Vrne: Option[PutSSOUserAPIResponse]

Primer

Primer putSSOUser

Copy

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

createSubscription

Parameters

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Odgovor

Vrne: Option[CreateSubscriptionAPIResponse]

Primer

Primer createSubscription

Copy

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

deleteSubscription

Parametri

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

Odgovor

Vrne: Option[DeleteSubscriptionAPIResponse]

Primer

deleteSubscription Primer

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # uporabi apiResult po potrebi

getSubscriptions

Parametri

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

Odgovor

Vrne: Option[GetSubscriptionsAPIResponse]

Primer

getSubscriptions Primer

Copy

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

updateSubscription

Parametri

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

Odgovor

Vrne: Option[UpdateSubscriptionAPIResponse]

Primer

updateSubscription Primer

Copy

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

getTenantDailyUsages

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetTenantDailyUsagesOptions	Ne

Odgovor

Vrne: Option[GetTenantDailyUsagesResponse]

Primer

getTenantDailyUsages Primer

Copy

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

createTenantPackage

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantPackageBody	CreateTenantPackageBody	Ne

Odgovor

Vrne: Option[CreateTenantPackageResponse]

Primer

createTenantPackage Primer

Copy

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

deleteTenantPackage

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteTenantPackage Primer

Copy

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

getTenantPackage

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetTenantPackageResponse]

Primer

Primer getTenantPackage

Copy

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

getTenantPackages

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
skip	float64	No

Odgovor

Vrne: Option[GetTenantPackagesResponse]

Primer

getTenantPackages Primer

Copy

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

replaceTenantPackage

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

replaceTenantPackage Primer

Copy

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

updateTenantPackage

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

updateTenantPackage Primer

Copy

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

createTenantUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

Odgovor

Vrne: Option[CreateTenantUserResponse]

Primer

createTenantUser Primer

Copy

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

deleteTenantUser

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
id	string	Ne
options	DeleteTenantUserOptions	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteTenantUser Primer

Copy

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

getTenantUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Returns: Option[GetTenantUserResponse]

Primer

Primer getTenantUser

Copy

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

getTenantUsers

Parametri

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Odgovor

Vrne: Option[GetTenantUsersResponse]

Primer

Primer getTenantUsers

Copy

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

replaceTenantUser

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

replaceTenantUser Primer

Copy

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

sendLoginLink

Parametri

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

sendLoginLink Primer

Copy

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

updateTenantUser

Parametri

Ime	Tip	Obvezno
tenantId	string	Da
id	string	Ne
updateTenantUserBody	UpdateTenantUserBody	Ne
updateComments	string = ""	Ne

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateTenantUser

Copy

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

createTenant

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createTenantBody	CreateTenantBody	Ne

Odgovor

Vrne: Option[CreateTenantResponse]

Primer

Primer createTenant

Copy

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

deleteTenant

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
id	string	No
sure	string = ""	No

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

deleteTenant Primer

Copy

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

getTenant

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetTenantResponse]

Primer

getTenant Primer

Copy

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

getTenants

Parameters

Name	Type	Required	Description
tenantId	string	Da
options	GetTenantsOptions	Ne

Response

Vrne: Option[GetTenantsResponse]

Example

Primer getTenants

Copy

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

updateTenant

Parameters

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

Odgovor

Vrne: Option[APIEmptyResponse]

Primer

Primer updateTenant

Copy

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

changeTicketState

Parametri

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

Odgovor

Vrne: Option[ChangeTicketStateResponse]

Primer

changeTicketState Primer

Copy

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

createTicket

Parametri

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

Odgovor

Vrne: Option[CreateTicketResponse]

Primer

Primer createTicket

Copy

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

getTicket

Parametri

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

Odgovor

Vrne: Option[GetTicketResponse]

Primer

Primer getTicket

Copy

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

getTickets

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetTicketsOptions	Ne

Odziv

Vrne: Option[GetTicketsResponse]

Primer

Primer getTickets

Copy

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

getTranslations

Parametri

Ime	Vrsta	Obvezno
namespace	string	Ne
component	string	Ne
options	GetTranslationsOptions	Ne

Odgovor

Vrne: Option[GetTranslationsResponse]

Primer

getTranslations Primer

Copy

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

uploadImage

Naloži in spremeni velikost slike

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
file	string	Ne
options	UploadImageOptions	Ne

Odgovor

Vrne: Option[UploadImageResponse]

Primer

uploadImage Primer

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # uporabi rezultat po potrebi

getUserBadgeProgressById

Parametri

Ime	Vrsta	Obvezno	Opis
tenantId	string	Yes
id	string	No

Odgovor

Vrne: Option[APIGetUserBadgeProgressResponse]

Primer

Primer getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
userId	string	No

Odgovor

Vrne: Option[APIGetUserBadgeProgressResponse]

Primer

Primer getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetUserBadgeProgressListOptions	Ne

Odgovor

Vrne: Option[APIGetUserBadgeProgressListResponse]

Primer

Primer getUserBadgeProgressList

Copy

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

createUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
createUserBadgeParams	CreateUserBadgeParams	Ne

Odgovor

Vrne: Option[APICreateUserBadgeResponse]

Primer

Primer createUserBadge

Copy

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

deleteUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIEmptySuccessResponse]

Primer

deleteUserBadge Primer

Copy

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

getUserBadge

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[APIGetUserBadgeResponse]

Primer

getUserBadge Primer

Copy

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

getUserBadges

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
options	GetUserBadgesOptions	No

Odgovor

Vrne: Option[APIGetUserBadgesResponse]

Primer

getUserBadges Primer

Copy

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

updateUserBadge

Parametri

Ime	Tip	Obvezno
tenantId	string	Yes
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Odgovor

Vrne: Option[APIEmptySuccessResponse]

Primer

Primer updateUserBadge

Copy

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

getUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string = ""	Ne

Odziv

Vrne: Option[GetUserNotificationCountResponse]

Primer

Primer getUserNotificationCount

Copy

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

getUserNotifications

Parameters

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	GetUserNotificationsOptions	Ne

Response

Vrne: Option[GetMyNotificationsResponse]

Primer

Primer getUserNotifications

Copy

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

resetUserNotificationCount

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
sso	string = ""	Ne

Odgovor

Returns: Option[ResetUserNotificationsResponse]

Primer

Primer resetUserNotificationCount

Copy

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

resetUserNotifications

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
options	ResetUserNotificationsOptions	Ne

Odgovor

Vrne: Option[ResetUserNotificationsResponse]

Primer

resetUserNotifications Primer

Copy

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

updateUserNotificationCommentSubscriptionStatus

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

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string = ""	No

Odgovor

Vrne: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Primer

updateUserNotificationCommentSubscriptionStatus Primer

Copy

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

updateUserNotificationPageSubscriptionStatus

Omogoči ali onemogoči obvestila za stran. Ko so uporabniki naročeni na stran, se ustvarijo obvestila za nove korenske 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

Returns: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Primer

Primer updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parameters

Ime	Tip	Obvezno
tenantId	string	Da
notificationId	string	Ne
newStatus	string	Ne
sso	string = ""	Ne

Odgovor

Vrne: Option[UpdateUserNotificationStatusResponse]

Primer

Primer updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parametri

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

Odziv

Vrne: Option[GetUserPresenceStatusesResponse]

Primer

Primer getUserPresenceStatuses

Copy

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

searchUsers

Parameters

Ime	Tip	Obvezno
tenantId	string	Da
urlId	string	Da
options	SearchUsersOptions	Ne

Response

Vrne: Option[SearchUsersResult]

Primer

searchUsers Primer

Copy

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

getUser

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Da
id	string	Ne

Odgovor

Vrne: Option[GetUserResponse]

Primer

Primer getUser

Copy

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

createVote

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
commentId	string	Da
direction	string	Ne
options	CreateVoteOptions	Ne

Odgovor

Vrne: Option[VoteResponse]

Primer

createVote Primer

Copy

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

deleteVote

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Da
id	string	Ne
editKey	string = ""	Ne

Odgovor

Vrne: Option[VoteDeleteResponse]

Primer

deleteVote Primer

Copy

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

getVotes

Parametri

Ime	Tip	Obvezno	Opis
tenantId	string	Yes
urlId	string	Yes

Odgovor

Vrne: Option[GetVotesResponse]

Primer

Primer getVotes

Copy

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

getVotesForUser

Parametri

Ime	Vrsta	Obvezno
tenantId	string	Yes
urlId	string	Yes
options	GetVotesForUserOptions	No

Odgovor

Vrne: Option[GetVotesForUserResponse]

Primer

Primer getVotesForUser

Copy

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

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

Using Nimble

Building from Source

Library Contents

Public vs Secured APIs

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

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

aggregate

Parametri

Odgovor

Primer

getAuditLogs

Parametri

Odziv

Primer

logoutPublic