FastComments Nim SDK

Dette er den officielle Nim SDK til FastComments.

Officiel Nim SDK til FastComments API

Repository

Krav

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installation

Brug af Nimble

nimble install fastcomments

Byg fra kilde

nimble build

Biblioteksindhold

Dette bibliotek indeholder den genererede API-klient og SSO‑værktøjerne, så det bliver nemmere at arbejde med API'en.

API‑klientbiblioteksdokumentation

Offentlige vs sikrede API'er

For API-klienten er der tre API-moduler, api_default, api_public og api_moderation. api_default indeholder metoder, der kræver din API-nøgle, og api_public indeholder API-kald, som kan foretages direkte fra en browser/mobil enhed osv. uden autentificering. api_moderation-modulet indeholder metoder til moderator-dashboardet.

api_moderation-modulet leverer et omfattende sæt af live- og hurtige moderations‑API'er. Hver api_moderation-metode accepterer en sso‑parameter og kan autentificere via SSO eller en FastComments.com sessions‑cookie.

Hurtig start

Brug af autentificerede API'er (DefaultAPI)

Vigtigt: Autentificerede slutpunkter kræver, at din API-nøgle er angivet som x-api-key headeren.

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"

# Foretag autentificerede API‑kald.
# Påkrævede parametre (og anmodnings‑kroppen) er positions‑baserede; valgfrie
# parametre sendes via operationens options‑objekt.
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"

Brug af offentlige API'er (PublicAPI)

Offentlige slutpunkter kræver ikke autentificering:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Foretag offentlige API‑kald.
# tenantId og urlId er påkrævet (positions‑baseret); alt andet er valgfrit.
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"

Brug af moderations‑API'er (ModerationAPI)

Moderations‑endepunkter driver moderator‑dashboardet og er autentificerede med en SSO‑token for den agerende moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# List kommentarer i moderations‑dashboardet.
# Denne operation har ingen påkrævede parametre, så alt er valgfrit.
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"

Almindelige problemer

401 autentificeringsfejl: Sørg for at du angiver x-api-key headeren på din HttpClient, før du foretager DefaultAPI‑anmodninger: client.headers["x-api-key"] = "your-api-key"
Forkert API‑klasse: Brug api_default til server‑side autentificerede anmodninger, api_public til klient‑side/offentlige anmodninger, og api_moderation til moderator‑dashboard‑anmodninger.

Foretage API-opkald

Alle API‑metoder i dette SDK returnerer tupler af (Option[ResponseType], Response). Det første element indeholder det parsede svar, hvis succesfuldt, og det andet element er den rå HTTP‑respons.

Påkrævede parametre og request‑body overføres positionsmæssigt. De resterende valgfrie parametre samles i et enkelt Api<Operation>Options‑objekt, som er det sidste argument. Operationer uden valgfrie parametre tager ikke et options‑objekt.

Eksempel: Hentning af kommentarer

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"

Noter

Broadcast-id'er

Du vil se, at du skal sende en broadcastId i nogle API-kald. Når du modtager begivenheder, får du dette ID tilbage, så du ved, at du skal ignorere begivenheden, hvis du planlægger at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være unikt nok til ikke at forekomme to gange i en browsersession.

SSO (Single Sign-On)

For SSO-eksempler, se nedenfor.

SSO-brug

Simpel 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

Sikker 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

Dokumentation for fastcomments

Dokumentation for API-endepunkter

Alle URI'er er relative til https://fastcomments.com

Klasse	Metode	HTTP-anmodning	Beskrivelse
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	Aggregere dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.
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	Tidligere kommentatorer på siden, som IKKE er online nu. Sorteret efter displayName. Brug dette efter at have udtømt /users/online for at gengive en "Members"-sektion. Cursor-baseret sideinddeling på commenterName: serveren går gennem den delvise {tenantId, urlId, commenterName} indeks fra afterName fremad via $gt, uden $skip-omkostning.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Aktuelt online seere af en side: personer, hvis websocket-session er abonneret på siden lige nu. Returnerer anonCount + totalCount (rum-omfattende abonnenter, inklusive anonyme seere, som vi ikke lister).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List sider for en lejer. Bruges af FChat desktop-klienten til at udfylde sin rumliste. Kræver at `enableFChat` er sand på den løste brugerdefinerede konfiguration for hver side. Sider der kræver SSO filtreres i forhold til den anmodende brugers gruppeadgang.
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 brugerinfo for en lejer. Givet userIds, returneres displayinfo fra User / SSOUser. Bruges af kommentarfunktionen til at berige brugere, der lige er dukket op via en tilstedeværelseshændelse. Ingen sidekontekst: privatliv håndteres ensartet (private profiler maskeres).
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}	Aktiver eller deaktiver notifikationer for en specifik kommentar.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Aktiver eller deaktiver notifikationer for en side. Når brugere er abonnenter på en side, oprettes notifikationer for nye rodkommentarer, og også
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload og skaler et billede
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentation for modeller

aggregate

Aggregere dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.

Parameters

Navn	Type	Påkrævet
tenantId	string	Ja
aggregationRequest	AggregationRequest	Nej
options	AggregateOptions	Nej

Response

Returns: Option[AggregateResponse]

Example

aggregat Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetAuditLogsOptions	Nej

Svar

Returnerer: Option[GetAuditLogsResponse]

Eksempel

getAuditLogs Eksempel

Copy

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

logoutPublic

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

logoutPublic Eksempel

Copy

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

blockFromCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[BlockSuccess]

Eksempel

blockFromCommentPublic Eksempel

Copy

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

unBlockCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Svar

Returnerer: Option[UnblockSuccess]

Eksempel

unBlockCommentPublic Eksempel

Copy

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

checkedCommentsForBlocked

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

Svar

Returnerer: Option[CheckBlockedCommentsResponse]

Eksempel

checkedCommentsForBlocked Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
blockFromCommentParams	BlockFromCommentParams	Nej
options	BlockUserFromCommentOptions	Nej

Svar

Returnerer: Option[BlockSuccess]

Eksempel

blockUserFromComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Respons

Returnerer: Option[SaveCommentsResponseWithPresence]

Eksempel

createCommentPublic Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
options	DeleteCommentOptions	Nej

Svar

Returnerer: Option[DeleteCommentResult]

Eksempel

deleteComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Svar

Returnerer: Option[PublicAPIDeleteCommentResponse]

Eksempel

deleteCommentPublic Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
voteId	string	Nej
urlId	string	Ja
broadcastId	string	Nej
options	DeleteCommentVoteOptions	Nej

Svar

Returnerer: Option[VoteDeleteResponse]

Eksempel

deleteCommentVote Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
options	FlagCommentOptions	No

Respons

Returnerer: Option[FlagCommentResponse]

Eksempel

flagComment Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIGetCommentResponse]

Eksempel

getComment Eksempel

Copy

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

getComments

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetCommentsOptions	Nej

Svar

Returnerer: Option[APIGetCommentsResponse]

Eksempel

getComments Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
options	GetCommentsPublicOptions	Nej

Svar

Returnerer: Option[GetCommentsResponseWithPresencePublicComment]

Eksempel

getCommentsPublic Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
options	GetCommentTextOptions	Nej

Svar

Returnerer: Option[PublicAPIGetCommentTextResponse]

Eksempel

getCommentText Eksempel

Copy

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

getCommentVoteUserNames

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
dir	int	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[GetCommentVoteUserNamesSuccessResponse]

Eksempel

getCommentVoteUserNames Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

lockComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[ChangeCommentPinStatusResponse]

Eksempel

pinComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createCommentParams	CreateCommentParams	Nej
options	SaveCommentOptions	Nej

Svar

Returnerer: Option[APISaveCommentResponse]

Eksempel

saveComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nej
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Nej
id	string	Nej
fromName	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

saveCommentsBulk Eksempel

Copy

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

setCommentText

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

Svar

Returnerer: Option[PublicAPISetCommentTextResponse]

Eksempel

setCommentText Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

Response

Returnerer: Option[UnblockSuccess]

Eksempel

unBlockUserFromComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
options	UnFlagCommentOptions	No

Svar

Returnerer: Option[FlagCommentResponse]

Eksempel

unFlagComment Eksempel

Copy

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

unLockComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Svar

Returns: Option[APIEmptyResponse]

Eksempel

unLockComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[ChangeCommentPinStatusResponse]

Eksempel

unPinComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Nej
voteBodyParams	VoteBodyParams	Nej
options	VoteCommentOptions	Nej

Svar

Returnerer: Option[VoteResponse]

Eksempel

voteComment Eksempel

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

Parametre

Navn	Typ	Påkrævet	Beskrivelse
options	GetCommentsForUserOptions	No

Respons

Returnerer: Option[GetCommentsForUserResponse]

Eksempel

getCommentsForUser Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Svar

Returnerer: Option[AddDomainConfigResponse]

Eksempel

addDomainConfig Eksempel

Copy

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

deleteDomainConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
domain	string	Nej

Svar

Returnerer: Option[DeleteDomainConfigResponse]

Eksempel

deleteDomainConfig Eksempel

Copy

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

getDomainConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
domain	string	Nej

Svar

Returnerer: Option[GetDomainConfigResponse]

Eksempel

getDomainConfig Eksempel

Copy

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

getDomainConfigs

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: Option[GetDomainConfigsResponse]

Eksempel

getDomainConfigs Eksempel

Copy

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

patchDomainConfig

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
domainToUpdate	string	Nej
patchDomainConfigParams	PatchDomainConfigParams	Nej

Svar

Returnerer: Option[PatchDomainConfigResponse]

Eksempel

patchDomainConfig Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
domainToUpdate	string	Nej
updateDomainConfigParams	UpdateDomainConfigParams	Nej

Svar

Returnerer: Option[PutDomainConfigResponse]

Eksempel

putDomainConfig Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Svar

Returnerer: Option[CreateEmailTemplateResponse]

Eksempel

createEmailTemplate Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteEmailTemplate Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
errorId	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteEmailTemplateRenderError Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetEmailTemplateResponse]

Eksempel

getEmailTemplate Eksempel

Copy

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

getEmailTemplateDefinitions

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: Option[GetEmailTemplateDefinitionsResponse]

Eksempel

getEmailTemplateDefinitions Eksempel

Copy

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

getEmailTemplateRenderErrors

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
skip	float64	Nej

Svar

Returnerer: Option[GetEmailTemplateRenderErrorsResponse]

Eksempel

getEmailTemplateRenderErrors Eksempel

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # brug responsen efter behov
else:
  # håndter manglende svar
  discard

getEmailTemplates

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
skip	float64	No

Svar

Returnerer: Option[GetEmailTemplatesResponse]

Eksempel

getEmailTemplates Eksempel

Copy

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

renderEmailTemplate

Parametre

Navn	Type	Obligatorisk
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Svar

Returnerer: Option[RenderEmailTemplateResponse]

Eksempel

renderEmailTemplate Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateEmailTemplate Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Nej
startTime	int64	Nej
endTime	int64	Nej

Svar

Returnerer: Option[GetEventLogResponse]

Eksempel

getEventLog Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Nej
startTime	int64	Nej
endTime	int64	Nej

Svar

Returnerer: Option[GetEventLogResponse]

Eksempel

getGlobalEventLog Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nej
options	CreateFeedPostOptions	Nej

Respons

Returnerer: Option[CreateFeedPostsResponse]

Eksempel

createFeedPost Eksempel

Copy

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

createFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nej
options	CreateFeedPostPublicOptions	Nej

Svar

Returnerer: Option[CreateFeedPostResponse]

Eksempel

createFeedPostPublic Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

Respons

Returnerer: Option[DeleteFeedPostPublicResponse]

Eksempel

deleteFeedPostPublic Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetFeedPostsOptions	Nej

Svar

Returnerer: Option[GetFeedPostsResponse]

Eksempel

getFeedPosts Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetFeedPostsPublicOptions	Nej

Svar

Returnerer: Option[PublicFeedPostsResponse]

Eksempel

getFeedPostsPublic Eksempel

Copy

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

getFeedPostsStats

Parametre

Navn	Type	Obligatorisk
tenantId	string	Ja
postIds	seq[string]	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[FeedPostsStatsResponse]

Eksempel

getFeedPostsStats Eksempel

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()
  # brug stats efter behov

getUserReactsPublic

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	GetUserReactsPublicOptions	No

Svar

Returnerer: Option[UserReactsResponse]

Eksempel

getUserReactsPublic Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Nej
reactBodyParams	ReactBodyParams	Nej
options	ReactFeedPostPublicOptions	Nej

Respons

Returnerer: Option[ReactFeedPostResponse]

Eksempel

reactFeedPostPublic Eksempel

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

Parameters

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
feedPost	FeedPost	Nej

Response

Returnerer: Option[APIEmptyResponse]

Example

updateFeedPost eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Svar

Returnerer: Option[CreateFeedPostResponse]

Eksempel

updateFeedPostPublic Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string = ""	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

flagCommentPublic Eksempel

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

Parametre

Navn	Type	Required	Description
tenantId	string	Yes
largeInternalURLSanitized	string	No

Svar

Returnerer: Option[GifGetLargeResponse]

Eksempel

getGifLarge Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

Svar

Returnerer: Option[GetGifsSearchResponse]

Eksempel

getGifsSearch Eksempel

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()
  # brug resp efter behov

getGifsTrending

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	GetGifsTrendingOptions	No

Svar

Returnerer: Option[GetGifsTrendingResponse]

Eksempel

getGifsTrending Eksempel

Copy

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

addHashTag

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Respons

Returnerer: Option[CreateHashTagResponse]

Eksempel

addHashTag Eksempel

Copy

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

addHashTagsBulk

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nej

Svar

Returnerer: Option[BulkCreateHashTagsResponse]

Eksempel

addHashTagsBulk Eksempel

Copy

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

deleteHashTag

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
tag	string	Nej
deleteHashTagRequestBody	DeleteHashTagRequestBody	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteHashTag Eksempel

Copy

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

getHashTags

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
page	float64	Nej

Svar

Returnerer: Option[GetHashTagsResponse]

Eksempel

getHashTags Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
tag	string	Nej
updateHashTagBody	UpdateHashTagBody	Nej

Svar

Returnerer: Option[UpdateHashTagResponse]

Eksempel

patchHashTag Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
voteId	string	Nej
options	DeleteModerationVoteOptions	Nej

Svar

Returnerer: Option[VoteDeleteResponse]

Eksempel

deleteModerationVote Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetApiCommentsOptions	Nej

Svar

Returnerer: Option[ModerationAPIGetCommentsResponse]

Eksempel

getApiComments Eksempel

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # yderligere behandling kan udføres med `resp`

getApiExportStatus

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetApiExportStatusOptions	Nej

Svar

Returnerer: Option[ModerationExportStatusResponse]

Eksempel

getApiExportStatus Eksempel

Copy

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

getApiIds

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetApiIdsOptions	Nej

Svar

Returnerer: Option[ModerationAPIGetCommentIdsResponse]

Eksempel

getApiIds Eksempel

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

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[GetBannedUsersFromCommentResponse]

Eksempel

getBanUsersFromComment Eksempel

Copy

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

getCommentBanStatus

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Svar

Returnerer: Option[GetCommentBanStatusResponse]

Eksempel

getCommentBanStatus Eksempel

Copy

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

getCommentChildren

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[ModerationAPIChildCommentsResponse]

Eksempel

getCommentChildren Eksempel

Copy

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

getCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetCountOptions	Nej

Svar

Returnerer: Option[ModerationAPICountCommentsResponse]

Eksempel

getCount Eksempel

Copy

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

getCounts

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[GetBannedUsersCountResponse]

Eksempel

getCounts Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[ModerationAPIGetLogsResponse]

Eksempel

getLogs Eksempel

Copy

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

getManualBadges

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
sso	string = ""	No

Svar

Returnerer: Option[GetTenantManualBadgesResponse]

Eksempel

getManualBadges Eksempel

Copy

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

getManualBadgesForUser

Parametre

Name	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetManualBadgesForUserOptions	Nej

Svar

Returnerer: Option[GetUserManualBadgesResponse]

Eksempel

getManualBadgesForUser Eksempel

Copy

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

getModerationComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
options	GetModerationCommentOptions	Nej

Svar

Returnerer: Option[ModerationAPICommentResponse]

Eksempel

getModerationComment Eksempel

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

Parameters

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nej

Response

Returnerer: Option[GetCommentTextResponse]

Eksempel

getModerationCommentText Eksempel

Copy

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

getPreBanSummary

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
options	GetPreBanSummaryOptions	Nej

Svar

Returnerer: Option[PreBanSummary]

Eksempel

getPreBanSummary Eksempel

Copy

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

getSearchCommentsSummary

Parametre

Navn	Type	Krævet	Beskrivelse
tenantId	string	Ja
options	GetSearchCommentsSummaryOptions	Nej

Svar

Returnerer: Option[ModerationCommentSearchResponse]

Eksempel

getSearchCommentsSummary Eksempel

Copy

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

getSearchPages

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetSearchPagesOptions	Nej

Svar

Returnerer: Option[ModerationPageSearchResponse]

Eksempel

getSearchPages Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	GetSearchSitesOptions	No

Svar

Returnerer: Option[ModerationSiteSearchResponse]

Eksempel

getSearchSites Eksempel

Copy

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

getSearchSuggest

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetSearchSuggestOptions	Nej

Svar

Returnerer: Option[ModerationSuggestResponse]

Eksempel

getSearchSuggest Eksempel

Copy

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

getSearchUsers

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetSearchUsersOptions	Nej

Svar

Returnerer: Option[ModerationUserSearchResponse]

Eksempel

getSearchUsers Eksempel

Copy

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

getTrustFactor

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetTrustFactorOptions	Nej

Svar

Returnerer: Option[GetUserTrustFactorResponse]

Eksempel

getTrustFactor Eksempel

Copy

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

getUserBanPreference

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
sso	string = ""	No

Svar

Returns: Option[APIModerateGetUserBanPreferencesResponse]

Eksempel

getUserBanPreference Eksempel

Copy

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

getUserInternalProfile

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

Svar

Returnerer: Option[GetUserInternalProfileResponse]

Eksempel

getUserInternalProfile Eksempel

Copy

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

postAdjustCommentVotes

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

Respons

Returns: Option[AdjustVotesResponse]

Eksempel

postAdjustCommentVotes Eksempel

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

Parameters

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
options	PostApiExportOptions	Nej

Response

Returnerer: Option[ModerationExportResponse]

Example

postApiExport Eksempel

Copy

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

postBanUserFromComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
options	PostBanUserFromCommentOptions	Nej

Svar

Returns: Option[BanUserFromCommentResult]

Eksempel

postBanUserFromComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
banUserUndoParams	BanUserUndoParams	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

postBanUserUndo Eksempel

Copy

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

postBulkPreBanSummary

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
bulkPreBanParams	BulkPreBanParams	Nej
options	PostBulkPreBanSummaryOptions	Nej

Svar

Returnerer: Option[BulkPreBanSummary]

Eksempel

postBulkPreBanSummary Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentsByIdsParams	CommentsByIdsParams	No
sso	string = ""	No

Svar

Returnerer: Option[ModerationAPIChildCommentsResponse]

Eksempel

postCommentsByIds Eksempel

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()
  # brug resp efter behov

postFlagComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
options	PostFlagCommentOptions	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

postFlagComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Svar

Returnerer: Option[PostRemoveCommentApiResponse]

Eksempel

postRemoveComment Eksempel

Copy

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

postRestoreDeletedComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
options	PostRestoreDeletedCommentOptions	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

postRestoreDeletedComment Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentApprovalStatusOptions	No

Svar

Returnerer: Option[SetCommentApprovedResponse]

Eksempel

postSetCommentApprovalStatus Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentReviewStatusOptions	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

postSetCommentReviewStatus Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

postSetCommentSpamStatus Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

Svar

Returnerer: Option[SetCommentTextResponse]

Eksempel

postSetCommentText Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
options	PostUnFlagCommentOptions	No

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

postUnFlagComment Eksempel

Copy

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

postVote

Parametre

Navn	Type	Krævet
tenantId	string	Ja
commentId	string	Ja
options	PostVoteOptions	Nej

Respons

Returnerer: Option[VoteResponse]

Eksempel

postVote Eksempel

Copy

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

putAwardBadge

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
badgeId	string	Nej
options	PutAwardBadgeOptions	Nej

Respons

Returnerer: Option[AwardUserBadgeResponse]

Eksempel

putAwardBadge Eksempel

Copy

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

putCloseThread

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

putCloseThread Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
badgeId	string	No
options	PutRemoveBadgeOptions	No

Svar

Returnerer: Option[RemoveUserBadgeResponse]

Eksempel

putRemoveBadge Eksempel

Copy

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

putReopenThread

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

putReopenThread Eksempel

Copy

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

setTrustFactor

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	SetTrustFactorOptions	No

Svar

Returnerer: Option[SetUserTrustFactorResponse]

Eksempel

setTrustFactor Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Nej

Svar

Returnerer: Option[CreateModeratorResponse]

Eksempel

createModerator Eksempel

Copy

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

deleteModerator

Parametre

Navn	Type	Obligatorisk
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteModerator Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetModeratorResponse]

Eksempel

getModerator Eksempel

Copy

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

getModerators

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	float64	Nej

Svar

Returnerer: Option[GetModeratorsResponse]

Eksempel

getModerators Eksempel

Copy

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

updateModerator

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateModeratorBody	UpdateModeratorBody	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateModerator Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteNotificationCount Eksempel

Copy

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

getCachedNotificationCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Svar

Returnerer: Option[GetCachedNotificationCountResponse]

Eksempel

getCachedNotificationCount Eksempel

Copy

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

getNotificationCount

Parameters

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetNotificationCountOptions	Nej

Response

Returnerer: Option[GetNotificationCountResponse]

Eksempel

getNotificationCount Eksempel

Copy

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

getNotifications

Parameters

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetNotificationsOptions	Nej

Response

Returnerer: Option[GetNotificationsResponse]

Eksempel

getNotifications Eksempel

Copy

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

updateNotification

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateNotification Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
title	string = ""	Nej

Svar

Returnerer: Option[CreateV1PageReact]

Eksempel

createV1PageReact Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
id	string	Nej
title	string = ""	Nej

Respons

Returnerer: Option[CreateV1PageReact]

Eksempel

createV2PageReact Eksempel

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()
  # brug `page` efter behov

deleteV1PageReact

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
urlId	string	Yes

Svar

Returnerer: Option[CreateV1PageReact]

Eksempel

deleteV1PageReact Eksempel

Copy

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

deleteV2PageReact

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
id	string	Nej

Respons

Returnerer: Option[CreateV1PageReact]

Eksempel

deleteV2PageReact Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
urlId	string	Yes

Svar

Returnerer: Option[GetV1PageLikes]

Eksempel

getV1PageLikes Eksempel

Copy

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

getV2PageReacts

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
urlId	string	Yes

Svar

Returnerer: Option[GetV2PageReacts]

Eksempel

getV2PageReacts Eksempel

Copy

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

getV2PageReactUsers

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
urlId	string	Yes
id	string	No

Svar

Returnerer: Option[GetV2PageReactUsersResponse]

Eksempel

getV2PageReactUsers Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Nej

Svar

Returnerer: Option[AddPageAPIResponse]

Eksempel

addPage Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[DeletePageAPIResponse]

Eksempel

deletePage Eksempel

Copy

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

getOfflineUsers

Past commenters on the page who are NOT currently online. Sorted by displayName.
Brug dette efter at have udtømt /users/online for at gengive en "Members" sektion.
Cursor-paginering på commenterName: serveren går igennem den delvise {tenantId, urlId, commenterName} indeks fra afterName fremad via $gt, ingen $skip-omkostning.

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
urlId	string	Yes
options	GetOfflineUsersOptions	No

Respons

Returnerer: Option[PageUsersOfflineResponse]

Eksempel

getOfflineUsers Eksempel

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

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

Parameters

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
options	GetOnlineUsersOptions	Nej

Response

Returns: Option[PageUsersOnlineResponse]

Example

getOnlineUsers Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
urlId	string	Ja

Svar

Returnerer: Option[GetPageByURLIdAPIResponse]

Eksempel

getPageByURLId Eksempel

Copy

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

getPages

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Response

Returnerer: Option[GetPagesAPIResponse]

Eksempel

getPages Eksempel

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

Liste sider for en lejer. Bruges af FChat skrivebordsklienten til at udfylde sin rumliste. Kræver, at enableFChat er sand på den løste brugerdefinerede konfiguration for hver side. Sider, der kræver SSO, filtreres i forhold til den anmodende brugers gruppeadgang.

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	GetPagesPublicOptions	No

Svar

Returnerer: Option[GetPublicPagesResponse]

Eksempel

getPagesPublic Eksempel

Copy

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

getUsersInfo

Bulk brugerinfo for en lejer. Givet bruger‑id'er, returnér display‑info fra User / SSOUser.
Brugt af kommentarfunktionen til at berige brugere, som lige er dukket op via en tilstedeværelseshændelse.
Ingen sidekontekst: privatliv håndhæves ensartet (private profiler maskeres).

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

Returns: Option[PageUsersInfoResponse]

Example

Eksempel på getUsersInfo

Copy

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

patchPage

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateAPIPageData	UpdateAPIPageData	Nej

Svar

Returnerer: Option[PatchPageAPIResponse]

Eksempel

patchPage Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deletePendingWebhookEvent Eksempel

Copy

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

getPendingWebhookEventCount

Parametre

Name	Type	Required	Description
tenantId	string	Yes
options	GetPendingWebhookEventCountOptions	No

Svar

Returnerer: Option[GetPendingWebhookEventCountResponse]

Eksempel

getPendingWebhookEventCount Eksempel

Copy

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

getPendingWebhookEvents

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	GetPendingWebhookEventsOptions	No

Svar

Returnerer: Option[GetPendingWebhookEventsResponse]

Eksempel

getPendingWebhookEvents Eksempel

Copy

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

createQuestionConfig

Parameters

Navn	Type	Krævet	Beskrivelse
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nej

Response

Returnerer: Option[CreateQuestionConfigResponse]

Example

createQuestionConfig Eksempel

Copy

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

deleteQuestionConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteQuestionConfig Eksempel

Copy

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

getQuestionConfig

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetQuestionConfigResponse]

Eksempel

getQuestionConfig Eksempel

Copy

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

getQuestionConfigs

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
skip	float64	No

Svar

Returnerer: Option[GetQuestionConfigsResponse]

Eksempel

getQuestionConfigs Eksempel

Copy

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

updateQuestionConfig

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateQuestionConfigBody	UpdateQuestionConfigBody	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

updateQuestionConfig Eksempel

Copy

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

createQuestionResult

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nej

Svar

Returnerer: Option[CreateQuestionResultResponse]

Eksempel

createQuestionResult Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteQuestionResult Eksempel

Copy

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

getQuestionResult

Parametre

Name	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returns: Option[GetQuestionResultResponse]

Eksempel

getQuestionResult Eksempel

Copy

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

getQuestionResults

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetQuestionResultsOptions	Nej

Response

Returnerer: Option[GetQuestionResultsResponse]

Eksempel

getQuestionResults Eksempel

Copy

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

updateQuestionResult

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateQuestionResult Eksempel

Copy

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

aggregateQuestionResults

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	AggregateQuestionResultsOptions	No

Svar

Returnerer: Option[AggregateQuestionResultsResponse]

Eksempel

aggregateQuestionResults Eksempel

Copy

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

bulkAggregateQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Nej
forceRecalculate	bool	Nej

Svar

Returnerer: Option[BulkAggregateQuestionResultsResponse]

Eksempel

bulkAggregateQuestionResults Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

Svar

Returnerer: Option[CombineQuestionResultsWithCommentsResponse]

Eksempel

combineCommentsWithQuestionResults Eksempel

Copy

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

addSSOUser

Parametre

Name	Type	Required	Description
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Nej

Svar

Returnerer: Option[AddSSOUserAPIResponse]

Eksempel

addSSOUser Eksempel

Copy

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

deleteSSOUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
options	DeleteSSOUserOptions	Nej

Svar

Returnerer: Option[DeleteSSOUserAPIResponse]

Eksempel

deleteSSOUser Eksempel

Copy

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

getSSOUserByEmail

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
email	string	No

Svar

Returnerer: Option[GetSSOUserByEmailAPIResponse]

Eksempel

getSSOUserByEmail Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Respons

Returnerer: Option[GetSSOUserByIdAPIResponse]

Eksempel

getSSOUserById Eksempel

Copy

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

getSSOUsers

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	int	Nej

Svar

Returnerer: Option[GetSSOUsersResponse]

Eksempel

getSSOUsers Eksempel

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

Parametre

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Svar

Returnerer: Option[PatchSSOUserAPIResponse]

Eksempel

patchSSOUser Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateAPISSOUserData	UpdateAPISSOUserData	Nej
updateComments	bool	Nej

Svar

Returnerer: Option[PutSSOUserAPIResponse]

Eksempel

putSSOUser Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nej

Svar

Returnerer: Option[CreateSubscriptionAPIResponse]

Eksempel

createSubscription Eksempel

Copy

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

deleteSubscription

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
userId	string = ""	No

Respons

Returnerer: Option[DeleteSubscriptionAPIResponse]

Eksempel

deleteSubscription Eksempel

Copy

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

getSubscriptions

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
userId	string = ""	No

Svar

Returnerer: Option[GetSubscriptionsAPIResponse]

Eksempel

getSubscriptions Eksempel

Copy

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

updateSubscription

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Nej
userId	string = ""	Nej

Svar

Returnerer: Option[UpdateSubscriptionAPIResponse]

Eksempel

updateSubscription Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetTenantDailyUsagesOptions	Nej

Svar

Returnerer: Option[GetTenantDailyUsagesResponse]

Eksempel

getTenantDailyUsages Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nej

Respons

Returnerer: Option[CreateTenantPackageResponse]

Eksempel

createTenantPackage Eksempel

Copy

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

deleteTenantPackage

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteTenantPackage Eksempel

Copy

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

getTenantPackage

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Svar

Returnerer: Option[GetTenantPackageResponse]

Eksempel

getTenantPackage Eksempel

Copy

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

getTenantPackages

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	float64	Nej

Svar

Returnerer: Option[GetTenantPackagesResponse]

Eksempel

getTenantPackages Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
replaceTenantPackageBody	ReplaceTenantPackageBody	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

replaceTenantPackage Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateTenantPackageBody	UpdateTenantPackageBody	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateTenantPackage Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Nej

Svar

Returnerer: Option[CreateTenantUserResponse]

Eksempel

createTenantUser Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
options	DeleteTenantUserOptions	Nej

Response

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteTenantUser Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetTenantUserResponse]

Eksempel

getTenantUser Eksempel

Copy

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

getTenantUsers

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
skip	float64	Nej

Svar

Returnerer: Option[GetTenantUsersResponse]

Eksempel

getTenantUsers Eksempel

Copy

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

replaceTenantUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Response

Returnerer: Option[APIEmptyResponse]

Eksempel

replaceTenantUser Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
redirectURL	string = ""	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

sendLoginLink Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateTenantUserBody	UpdateTenantUserBody	Nej
updateComments	string = ""	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateTenantUser Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Svar

Returnerer: Option[CreateTenantResponse]

Eksempel

createTenant Eksempel

Copy

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

deleteTenant

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
sure	string = ""	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteTenant Eksempel

Copy

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

getTenant

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Svar

Returnerer: Option[GetTenantResponse]

Eksempel

getTenant Eksempel

Copy

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

getTenants

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetTenantsOptions	Nej

Svar

Returnerer: Option[GetTenantsResponse]

Eksempel

getTenants Eksempel

Copy

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

updateTenant

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateTenant Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
id	string	Nej
changeTicketStateBody	ChangeTicketStateBody	Nej

Svar

Returnerer: Option[ChangeTicketStateResponse]

Eksempel

changeTicketState Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
userId	string	No
createTicketBody	CreateTicketBody	No

Svar

Returnerer: Option[CreateTicketResponse]

Eksempel

createTicket Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
userId	string = ""	Nej

Svar

Returnerer: Option[GetTicketResponse]

Eksempel

getTicket Eksempel

Copy

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

getTickets

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetTicketsOptions	Nej

Svar

Returnerer: Option[GetTicketsResponse]

Eksempel

getTickets Eksempel

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # brug tickets efter behov

getTranslations

Parametre

Navn	Type	Påkrævet
namespace	string	Nej
component	string	Nej
options	GetTranslationsOptions	Nej

Svar

Returnerer: Option[GetTranslationsResponse]

Eksempel

getTranslations Eksempel

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

Upload og ændre størrelse på et billede

Parameters

Navn	Type	Påkrævet
tenantId	string	Ja
file	string	Nej
options	UploadImageOptions	Nej

Response

Returnerer: Option[UploadImageResponse]

Example

uploadImage Eksempel

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # brug resultatet efter behov

getUserBadgeProgressById

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIGetUserBadgeProgressResponse]

Eksempel

getUserBadgeProgressById Eksempel

Copy

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

getUserBadgeProgressByUserId

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
userId	string	Nej

Svar

Returnerer: Option[APIGetUserBadgeProgressResponse]

Eksempel

getUserBadgeProgressByUserId Eksempel

Copy

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

getUserBadgeProgressList

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetUserBadgeProgressListOptions	Nej

Svar

Returnerer: Option[APIGetUserBadgeProgressListResponse]

Eksempel

getUserBadgeProgressList Eksempel

Copy

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

createUserBadge

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nej

Respons

Returns: Option[APICreateUserBadgeResponse]

Eksempel

createUserBadge Eksempel

Copy

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

deleteUserBadge

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIEmptySuccessResponse]

Eksempel

deleteUserBadge Eksempel

Copy

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

getUserBadge

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIGetUserBadgeResponse]

Eksempel

getUserBadge Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	GetUserBadgesOptions	Nej

Svar

Returnerer: Option[APIGetUserBadgesResponse]

Eksempel

getUserBadges Eksempel

Copy

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

updateUserBadge

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Svar

Returnerer: Option[APIEmptySuccessResponse]

Eksempel

updateUserBadge Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
sso	string = ""	No

Svar

Returnerer: Option[GetUserNotificationCountResponse]

Eksempel

getUserNotificationCount Eksempel

Copy

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

getUserNotifications

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
options	GetUserNotificationsOptions	Nej

Svar

Returnerer: Option[GetMyNotificationsResponse]

Eksempel

getUserNotifications Eksempel

Copy

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

resetUserNotificationCount

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[ResetUserNotificationsResponse]

Eksempel

resetUserNotificationCount Eksempel

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

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja
options	ResetUserNotificationsOptions	Nej

Svar

Returnerer: Option[ResetUserNotificationsResponse]

Eksempel

resetUserNotifications Eksempel

Copy

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

updateUserNotificationCommentSubscriptionStatus

Aktivér eller deaktiver notifikationer for en specifik kommentar.

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
notificationId	string	Nej
optedInOrOut	string	Nej
commentId	string	Ja
sso	string = ""	Nej

Svar

Returnerer: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Eksempel

updateUserNotificationCommentSubscriptionStatus Eksempel

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

Aktiver eller deaktiver meddelelser for en side. Når brugere er abonneret på en side, oprettes meddelelser for nye rodkommentarer, og også

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
url	string	Nej
pageTitle	string	Nej
subscribedOrUnsubscribed	string	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Eksempel

updateUserNotificationPageSubscriptionStatus Eksempel

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()
  # yderligere behandling med resp

updateUserNotificationStatus

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
notificationId	string	Nej
newStatus	string	Nej
sso	string = ""	Nej

Svar

Returnerer: Option[UpdateUserNotificationStatusResponse]

Eksempel

updateUserNotificationStatus Eksempel

Copy

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

getUserPresenceStatuses

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlIdWS	string	Nej
userIds	string	Nej

Respons

Returnerer: Option[GetUserPresenceStatusesResponse]

Eksempel

getUserPresenceStatuses Eksempel

Copy

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

searchUsers

Parametre

Navn	Type	Obligatorisk
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

Svar

Returnerer: Option[SearchUsersResult]

Eksempel

searchUsers Eksempel

Copy

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

getUser

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Yes
id	string	No

Respons

Returnerer: Option[GetUserResponse]

Eksempel

getUser Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
direction	string	Nej
options	CreateVoteOptions	Nej

Svar

Returnerer: Option[VoteResponse]

Eksempel

createVote Eksempel

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

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
editKey	string = ""	Nej

Svar

Returnerer: Option[VoteDeleteResponse]

Eksempel

deleteVote Eksempel

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

Parametre

Navn	Type	Krævet	Beskrivelse
tenantId	string	Ja
urlId	string	Ja

Svar

Returnerer: Option[GetVotesResponse]

Eksempel

getVotes Eksempel

Copy

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

getVotesForUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
options	GetVotesForUserOptions	Nej

Svar

Returnerer: Option[GetVotesForUserResponse]

Eksempel

getVotesForUser Eksempel

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

Brug for hjælp?

Hvis du støder på problemer eller har spørgsmål om Nim SDK'et, så:

Bidrag

Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.

Sprog 🇩🇰 Dansk

Dokumentation

Kom godt i gang

API-reference

Brug

Aggregering

Revisionslog

Godkendelse

Bloker fra kommentar

Tjek blokerede kommentarer

Kommentarer

Kommentarer for bruger

Domænekonfigurationer

E-mail-skabeloner

Hændelseslog

Feed-indlæg

Marker kommentar

GIF'er

Hashtags

Moderering

Moderatorer

Antal notifikationer

Notifikationer

Side-reaktioner

Sider

Ventende webhook-hændelser

Spørgsmålskonfigurationer

Spørgsmålsresultater

Aggregering af spørgeresultater

SSO-brugere

Abonnementer

Lejerens daglige brug

Lejerpakker

Lejerbrugere

Lejere

Billetter

Oversættelser

Upload billede

Brugerbadge-fremgang

Brugerbadges

Brugernotifikationer

Brugertilstedeværelsesstatus

Brugersøgning

Brugere

Stemmer

FastComments Nim SDK

Repository

Krav

Installation

Brug af Nimble

Byg fra kilde

Biblioteksindhold

Offentlige vs sikrede API'er

Hurtig start

Brug af autentificerede API'er (DefaultAPI)

Brug af offentlige API'er (PublicAPI)

Brug af moderations‑API'er (ModerationAPI)

Almindelige problemer

Foretage API-opkald

Eksempel: Hentning af kommentarer

Noter

Broadcast-id'er

SSO (Single Sign-On)

SSO-brug

Simpel SSO

Sikker SSO

Dokumentation for fastcomments

Dokumentation for API-endepunkter

Dokumentation for modeller

aggregate

Parameters

Response

Example

getAuditLogs

Parametre

Svar

Eksempel

logoutPublic

Respons

Eksempel