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 kildekode

nimble build

Bibliotekets indhold

Dette bibliotek indeholder den genererede API-klient og SSO-værktøjerne, som gør det nemmere at arbejde med API'et.

Dokumentation for API-klientbiblioteket

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/mobile enhed/andet uden autentificering. api_moderation-modulet indeholder metoder til moderator-dashboardet.

`api_moderation`-metoderne dækker oplistning, optælling, søgning og eksport af kommentarer og deres logfiler; moderationshandlinger som fjernelse/gendannelse af kommentarer, markering, indstilling af review/spam/godkendelsesstatus, justering af stemmer og genåbning/lukning af tråde; udelukkelser (udelukke en bruger fra at kommentere, ophæve en udelukkelse, forudgående udelukkelsesoversigter, udelukkelsesstatus og præferencer samt antal udelukkede brugere); og badges & tillid (tildeling/fjernelse af et badge, liste over manuelle badges, hente/indstille en brugers tillidsfaktor og hente en brugers interne profil). Hver `api_moderation`-metode accepterer en `sso`-parameter, så kaldet er autentificeret som en SSO-moderator.

Hurtig start

Brug af autentificerede API'er (DefaultAPI)

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

import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data

let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"

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

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

Brug af offentlige API'er (PublicAPI)

Offentlige endpoints kræver ikke autentificering:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

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

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

Brug af Moderations-API'er (ModerationAPI)

Moderations-endpoints driver moderatorpanelet og autentificeres med et SSO-token for den agerende moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Vis kommentarer i moderatorpanelet
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Almindelige problemer

401 authentication error: Sørg for at sætte headeren x-api-key på din HttpClient inden du foretager DefaultAPI-forespørgsler: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Brug api_default til autentificerede forespørgsler på serversiden, api_public til klient-side/offentlige forespørgsler, og api_moderation til forespørgsler til moderator-dashboardet.

Foretage API-opkald

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

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

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

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 Endpoints

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	Aggregerer 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/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	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 lige nu. Sorteret efter displayName. Brug denne efter du har udtømt /users/online for at vise en "Medlemmer"-sektion. Cursor-paginering på commenterName: serveren gennemgår det delvise {tenantId, urlId, commenterName} indeks fra afterName fremad via $gt, ingen $skip-omkostning.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Brugere, der i øjeblikket er online på en side: personer, hvis websocket-session lige nu er tilkoblet siden. Returnerer anonCount + totalCount (abonnenter i rummet, inklusive anonyme brugere vi ikke opregner).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List sider for en lejer. Bruges af FChat desktop klienten til at udfylde dets rums-liste. Kræver at `enableFChat` er sat til true på den tilknyttede brugerdefinerede konfiguration for hver side. Sider som kræver SSO, bliver filtreret ud fra 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	Masseinformation om brugere for en lejer. Givet userIds, returnerer visningsinformation fra User / SSOUser. Bruges af kommentar-widget'en til at berige brugere, der lige er dukket op via en presence event. Ingen sidekontekst: Privatliv håndhæves ensartet (private profiler er skjulte).
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 abonnerer 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 ændr størrelsen på et billede
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentation for Modeller

aggregate

Aggregerer 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
parentTenantId	string	Nej
includeStats	bool	Nej

Respons

Returnerer: Option[AggregateResponse]

Eksempel

aggregate Eksempel

Copy

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

getAuditLogs

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
limit	float64	No
skip	float64	No
order	SORTDIR	No
after	float64	No
before	float64	No

Svar

Returnerer: Option[GetAuditLogsResponse]

Eksempel

getAuditLogs Eksempel

Copy

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

logoutPublic

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på logoutPublic

Copy

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

blockFromCommentPublic

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

unBlockCommentPublic

Parametre

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

Svar

Returnerer: Option[UnblockSuccess]

Eksempel

unBlockCommentPublic Eksempel

Copy

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

checkedCommentsForBlocked

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentIds	string	Nej
sso	string	Nej

Svar

Returnerer: Option[CheckBlockedCommentsResponse]

Eksempel

checkedCommentsForBlocked-eksempel

Copy

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

blockUserFromComment

Parametre

Name	Type	Obligatorisk
tenantId	string	Ja
id	string	Nej
blockFromCommentParams	BlockFromCommentParams	Nej
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: Option[BlockSuccess]

Eksempel

blockUserFromComment Eksempel

Copy

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

createCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Nej
commentData	CommentData	Nej
sessionId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[SaveCommentsResponseWithPresence]

Eksempel

createCommentPublic Eksempel

Copy

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

deleteComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
contextUserId	string	Nej
isLive	bool	Nej

Svar

Returnerer: Option[DeleteCommentResult]

Eksempel

Eksempel på deleteComment

Copy

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

deleteCommentPublic

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nej
editKey	string	Nej
sso	string	Nej

Response

Returnerer: Option[PublicAPIDeleteCommentResponse]

Eksempel

deleteCommentPublic Eksempel

Copy

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

deleteCommentVote

Parametre

Navn	Type	Påkrævet
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
editKey	string	No
sso	string	No

Svar

Returnerer: Option[VoteDeleteResponse]

Eksempel

Eksempel på deleteCommentVote

Copy

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

flagComment

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Nej
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: Option[FlagCommentResponse]

Eksempel

flagComment-eksempel

Copy

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

getComment

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-7890")
if response.isSome:
  let comment = response.get()
  discard comment
else:
  echo "Comment not found"

getComments

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
page	int	Nej
limit	int	Nej
skip	int	Nej
asTree	bool	Nej
skipChildren	int	Nej
limitChildren	int	Nej
maxTreeDepth	int	Nej
urlId	string	Ja
userId	string	Nej
anonUserId	string	Nej
contextUserId	string	Nej
hashTag	string	Nej
parentId	string	Nej
direction	SortDirections	Nej
fromDate	int64	Nej
toDate	int64	Nej

Respons

Returnerer: Option[APIGetCommentsResponse]

Eksempel

getComments Eksempel

Copy

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

getCommentsPublic

req tenantId urlId

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
page	int	Nej
direction	SortDirections	Nej
sso	string	Nej
skip	int	Nej
skipChildren	int	Nej
limit	int	Nej
limitChildren	int	Nej
countChildren	bool	Nej
fetchPageForCommentId	string	Nej
includeConfig	bool	Nej
countAll	bool	Nej
includei10n	bool	Nej
locale	string	Nej
modules	string	Nej
isCrawler	bool	Nej
includeNotificationCount	bool	Nej
asTree	bool	Nej
maxTreeDepth	int	Nej
useFullTranslationIds	bool	Nej
parentId	string	Nej
searchText	string	Nej
hashTags	seq[string]	Nej
userId	string	Nej
customConfigStr	string	Nej
afterCommentId	string	Nej
beforeCommentId	string	Nej

Svar

Returnerer: Option[GetCommentsResponseWithPresencePublicComment]

Eksempel

getCommentsPublic Eksempel

Copy

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

getCommentText

Parametre

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

Svar

Returnerer: Option[PublicAPIGetCommentTextResponse]

Eksempel

getCommentText Eksempel

Copy

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

getCommentVoteUserNames

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

lockComment

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på lockComment

Copy

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

pinComment

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

saveComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createCommentParams	CreateCommentParams	Nej
isLive	bool	Nej
doSpamCheck	bool	Nej
sendEmails	bool	Nej
populateNotifications	bool	Nej

Svar

Returnerer: Option[APISaveCommentResponse]

Eksempel

saveComment Eksempel

Copy

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

saveCommentsBulk

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nej
isLive	bool	Nej
doSpamCheck	bool	Nej
sendEmails	bool	Nej
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	Nej
id	string	Nej
fromName	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på saveCommentsBulk

Copy

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

setCommentText

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nej
commentTextUpdateRequest	CommentTextUpdateRequest	Nej
editKey	string	Nej
sso	string	Nej

Svar

Returnerer: Option[PublicAPISetCommentTextResponse]

Eksempel

setCommentText Eksempel

Copy

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

unBlockUserFromComment

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
unBlockFromCommentParams	UnBlockFromCommentParams	Nej
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: Option[UnblockSuccess]

Eksempel

unBlockUserFromComment Eksempel

Copy

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

unFlagComment

Parametre

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

Svar

Returnerer: Option[FlagCommentResponse]

Eksempel

Eksempel på unFlagComment

Copy

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

unLockComment

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

unLockComment-eksempel

Copy

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

unPinComment

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nej
sso	string	Nej

Respons

Returnerer: Option[ChangeCommentPinStatusResponse]

Eksempel

unPinComment Eksempel

Copy

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

updateComment

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Nej
updatableCommentParams	UpdatableCommentParams	Nej
contextUserId	string	Nej
doSpamCheck	bool	Nej
isLive	bool	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på updateComment

Copy

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

voteComment

Parametre

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

Svar

Returnerer: Option[VoteResponse]

Eksempel

voteComment Eksempel

Copy

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

getCommentsForUser

Parametre

Navn	Type	Påkrævet
userId	string	Nej
direction	SortDirections	Nej
repliesToUserId	string	Nej
page	float64	Nej
includei10n	bool	Nej
locale	string	Nej
isCrawler	bool	Nej

Svar

Returnerer: Option[GetCommentsForUserResponse]

Eksempel

Eksempel på getCommentsForUser

Copy

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

addDomainConfig

Parametre

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

Respons

Returnerer: Option[AddDomainConfigResponse]

Eksempel

addDomainConfig Eksempel

Copy

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

deleteDomainConfig

Parametre

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

Svar

Returnerer: Option[DeleteDomainConfigResponse]

Eksempel

deleteDomainConfig Eksempel

Copy

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

getDomainConfig

Parametre

Name	Type	Required	Description
tenantId	string	Ja
domain	string	Nej

Svar

Returnerer: Option[GetDomainConfigResponse]

Eksempel

getDomainConfig Eksempel

Copy

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

getDomainConfigs

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: Option[GetDomainConfigsResponse]

Eksempel

getDomainConfigs Eksempel

Copy

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

patchDomainConfig

Parametre

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

Svar

Returnerer: Option[PatchDomainConfigResponse]

Eksempel

Eksempel på patchDomainConfig

Copy

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

putDomainConfig

Parametre

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Svar

Returnerer: Option[PutDomainConfigResponse]

Eksempel

putDomainConfig Eksempel

Copy

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

createEmailTemplate

Parametre

Name	Type	Required	Description
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Nej

Svar

Returnerer: Option[CreateEmailTemplateResponse]

Eksempel

createEmailTemplate Eksempel

Copy

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

deleteEmailTemplate

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteEmailTemplate Eksempel

Copy

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

deleteEmailTemplateRenderError

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parametre

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

Respons

Returnerer: Option[GetEmailTemplateResponse]

Eksempel

getEmailTemplate Eksempel

Copy

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

getEmailTemplateDefinitions

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: Option[GetEmailTemplateDefinitionsResponse]

Eksempel

getEmailTemplateDefinitions Eksempel

Copy

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

getEmailTemplateRenderErrors

Parametre

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

Svar

Returnerer: Option[GetEmailTemplateRenderErrorsResponse]

Eksempel

getEmailTemplateRenderErrors Eksempel

Copy

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

getEmailTemplates

Parametre

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

Respons

Returnerer: Option[GetEmailTemplatesResponse]

Eksempel

getEmailTemplates Eksempel

Copy

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

renderEmailTemplate

Parametre

Name	Type	Required
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Nej
locale	string	Nej

Svar

Returnerer: Option[RenderEmailTemplateResponse]

Eksempel

Eksempel på renderEmailTemplate

Copy

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

updateEmailTemplate

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

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

---

getGlobalEventLog

req tenantId urlId userIdWS

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

createFeedPost

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nej
broadcastId	string	Nej
isLive	bool	Nej
doSpamCheck	bool	Nej
skipDupCheck	bool	Nej

Svar

Returnerer: Option[CreateFeedPostsResponse]

Eksempel

Eksempel på createFeedPost

Copy

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

createFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nej
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[CreateFeedPostResponse]

Eksempel

createFeedPostPublic Eksempel

Copy

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

deleteFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Nej
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[DeleteFeedPostPublicResponse]

Eksempel

Eksempel på deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
afterId	string	Nej
limit	int	Nej
tags	seq[string]	Nej

Svar

Returnerer: Option[GetFeedPostsResponse]

Eksempel

getFeedPosts Eksempel

Copy

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

getFeedPostsPublic

req tenantId afterId

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
afterId	string	Nej
limit	int	Nej
tags	seq[string]	Nej
sso	string	Nej
isCrawler	bool	Nej
includeUserInfo	bool	Nej

Respons

Returnerer: Option[PublicFeedPostsResponse]

Eksempel

getFeedPostsPublic Eksempel

Copy

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

getFeedPostsStats

Parametre

Name	Type	Required
tenantId	string	Yes
postIds	seq[string]	No
sso	string	No

Svar

Returnerer: Option[FeedPostsStatsResponse]

Eksempel

Eksempel på getFeedPostsStats

Copy

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

getUserReactsPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postIds	seq[string]	Nej
sso	string	Nej

Respons

Returnerer: Option[UserReactsResponse]

Eksempel

Eksempel på getUserReactsPublic

Copy

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

reactFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Nej
reactBodyParams	ReactBodyParams	Nej
isUndo	bool	Nej
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[ReactFeedPostResponse]

Eksempel

reactFeedPostPublic Eksempel

Copy

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

updateFeedPost

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateFeedPost Eksempel

Copy

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

updateFeedPostPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
postId	string	Nej
updateFeedPostParams	UpdateFeedPostParams	Nej
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[CreateFeedPostResponse]

Eksempel

updateFeedPostPublic Eksempel

Copy

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

flagCommentPublic

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
isFlagged	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

flagCommentPublic Eksempel

Copy

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

getGifLarge

Parametre

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

Svar

Returnerer: Option[GifGetLargeResponse]

Eksempel

Eksempel på getGifLarge

Copy

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

getGifsSearch

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
search	string	Nej
locale	string	Nej
rating	string	Nej
page	float64	Nej

Svar

Returnerer: Option[GetGifsSearchResponse]

Eksempel

getGifsSearch Eksempel

Copy

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

getGifsTrending

Parametre

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

Svar

Returnerer: Option[GetGifsTrendingResponse]

Eksempel

getGifsTrending Eksempel

Copy

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

addHashTag

Parametre

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

Respons

Returnerer: Option[CreateHashTagResponse]

Eksempel

addHashTag Eksempel

Copy

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

addHashTagsBulk

Parametre

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

Svar

Returnerer: Option[BulkCreateHashTagsResponse]

Eksempel

addHashTagsBulk Eksempel

Copy

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

deleteHashTag

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteHashTag Eksempel

Copy

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

getHashTags

Parametre

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

Respons

Returnerer: Option[GetHashTagsResponse]

Eksempel

getHashTags Eksempel

Copy

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

patchHashTag

Parametre

Name	Type	Required
tag	string	Nej
tenantId	string	Ja
updateHashTagBody	UpdateHashTagBody	Nej

Respons

Returnerer: Option[UpdateHashTagResponse]

Eksempel

patchHashTag Eksempel

Copy

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

deleteModerationVote

Parameters

Navn	Type	Påkrævet
commentId	string	Ja
voteId	string	Nej
sso	string	Nej

Response

Returnerer: Option[VoteDeleteResponse]

Example

deleteModerationVote Eksempel

Copy

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

getApiComments

Parametre

Navn	Type	Påkrævet
page	float64	No
count	float64	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	bool	No
sso	string	No

Svar

Returnerer: Option[ModerationAPIGetCommentsResponse]

Eksempel

getApiComments Eksempel

Copy

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

getApiExportStatus

Parametre

Name	Type	Påkrævet	Beskrivelse
batchJobId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationExportStatusResponse]

Eksempel

getApiExportStatus Eksempel

Copy

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

getApiIds

Parametre

Navn	Type	Påkrævet
textSearch	string	Nej
byIPFromComment	string	Nej
filters	string	Nej
searchFilters	string	Nej
afterId	string	Nej
demo	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationAPIGetCommentIdsResponse]

Eksempel

getApiIds Eksempel

Copy

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

getBanUsersFromComment

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[GetBannedUsersFromCommentResponse]

Eksempel

getBanUsersFromComment Eksempel

Copy

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

getCommentBanStatus

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[GetCommentBanStatusResponse]

Eksempel

getCommentBanStatus Eksempel

Copy

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

getCommentChildren

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[ModerationAPIChildCommentsResponse]

Eksempel

getCommentChildren Eksempel

Copy

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

getCount

Parametre

Navn	Type	Påkrævet
textSearch	string	Nej
byIPFromComment	string	Nej
filter	string	Nej
searchFilters	string	Nej
demo	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationAPICountCommentsResponse]

Eksempel

getCount Eksempel

Copy

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

getCounts

Parametre

Name	Type	Required	Description
sso	string	Nej

Respons

Returnerer: Option[GetBannedUsersCountResponse]

Eksempel

getCounts-eksempel

Copy

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

getLogs

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[ModerationAPIGetLogsResponse]

Eksempel

getLogs Eksempel

Copy

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

getManualBadges

Parametre

Navn	Type	Påkrævet	Beskrivelse
sso	string	Nej

Svar

Returnerer: Option[GetTenantManualBadgesResponse]

Eksempel

getManualBadges Eksempel

Copy

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

getManualBadgesForUser

Parametre

Name	Type	Required
badgesUserId	string	Nej
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[GetUserManualBadgesResponse]

Eksempel

getManualBadgesForUser Eksempel

Copy

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

getModerationComment

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
includeEmail	bool	Nej
includeIP	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationAPICommentResponse]

Eksempel

Eksempel på getModerationComment

Copy

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

getModerationCommentText

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Response

Returnerer: Option[GetCommentTextResponse]

Eksempel

getModerationCommentText Eksempel

Copy

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

getPreBanSummary

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
includeByUserIdAndEmail	bool	Nej
includeByIP	bool	Nej
includeByEmailDomain	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[PreBanSummary]

Eksempel

getPreBanSummary Eksempel

Copy

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

getSearchCommentsSummary

Parametre

Name	Type	Påkrævet
value	string	Nej
filters	string	Nej
searchFilters	string	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationCommentSearchResponse]

Eksempel

getSearchCommentsSummary Eksempel

Copy

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

getSearchPages

Parametre

Navn	Type	Påkrævet	Beskrivelse
value	string	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationPageSearchResponse]

Eksempel

getSearchPages Eksempel

Copy

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

getSearchSites

Parametre

Name	Type	Påkrævet	Beskrivelse
value	string	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationSiteSearchResponse]

Eksempel

getSearchSites Eksempel

Copy

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

getSearchSuggest

Parametre

Name	Type	Påkrævet	Beskrivelse
textSearch	string	Nej
sso	string	Nej

Respons

Returnerer: Option[ModerationSuggestResponse]

Eksempel

getSearchSuggest Eksempel

Copy

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

getSearchUsers

Parametre

Navn	Type	Påkrævet	Beskrivelse
value	string	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationUserSearchResponse]

Eksempel

getSearchUsers Eksempel

Copy

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

getTrustFactor

Parametre

Navn	Type	Påkrævet	Beskrivelse
userId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[GetUserTrustFactorResponse]

Eksempel

getTrustFactor Eksempel

Copy

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

getUserBanPreference

Parametre

Navn	Type	Påkrævet	Beskrivelse
sso	string	Nej

Svar

Returnerer: Option[APIModerateGetUserBanPreferencesResponse]

Eksempel

Eksempel på getUserBanPreference

Copy

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

getUserInternalProfile

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[GetUserInternalProfileResponse]

Eksempel

getUserInternalProfile Eksempel

Copy

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

postAdjustCommentVotes

Parametre

Name	Type	Required
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	No
sso	string	No

Svar

Returnerer: Option[AdjustVotesResponse]

Eksempel

postAdjustCommentVotes Eksempel

Copy

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

postApiExport

Parametre

Navn	Type	Påkrævet
textSearch	string	Nej
byIPFromComment	string	Nej
filters	string	Nej
searchFilters	string	Nej
sorts	string	Nej
sso	string	Nej

Respons

Returnerer: Option[ModerationExportResponse]

Eksempel

Eksempel på postApiExport

Copy

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

postBanUserFromComment

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
banEmail	bool	Nej
banEmailDomain	bool	Nej
banIP	bool	Nej
deleteAllUsersComments	bool	Nej
bannedUntil	string	Nej
isShadowBan	bool	Nej
updateId	string	Nej
banReason	string	Nej
sso	string	Nej

Respons

Returnerer: Option[BanUserFromCommentResult]

Eksempel

Eksempel på postBanUserFromComment

Copy

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

postBanUserUndo

Parametre

Name	Type	Påkrævet	Beskrivelse
banUserUndoParams	BanUserUndoParams	No
sso	string	No

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

postBanUserUndo Eksempel

Copy

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

postBulkPreBanSummary

Parametre

Name	Type	Påkrævet
bulkPreBanParams	BulkPreBanParams	Nej
includeByUserIdAndEmail	bool	Nej
includeByIP	bool	Nej
includeByEmailDomain	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[BulkPreBanSummary]

Eksempel

postBulkPreBanSummary Eksempel

Copy

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

postCommentsByIds

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentsByIdsParams	CommentsByIdsParams	Nej
sso	string	Nej

Svar

Returnerer: Option[ModerationAPIChildCommentsResponse]

Eksempel

postCommentsByIds Eksempel

Copy

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

postFlagComment

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

postFlagComment Eksempel

Copy

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

postRemoveComment

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[PostRemoveCommentResponse]

Eksempel

postRemoveComment Eksempel

Copy

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

postRestoreDeletedComment

Parametre

Name	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

postRestoreDeletedComment Eksempel

Copy

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

postSetCommentApprovalStatus

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
approved	bool	Nej
sso	string	Nej

Respons

Returnerer: Option[SetCommentApprovedResponse]

Eksempel

postSetCommentApprovalStatus Eksempel

Copy

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

postSetCommentReviewStatus

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
reviewed	bool	Nej
sso	string	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på postSetCommentReviewStatus

Copy

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

postSetCommentSpamStatus

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
spam	bool	Nej
permNotSpam	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

postSetCommentSpamStatus Eksempel

Copy

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

postSetCommentText

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
setCommentTextParams	SetCommentTextParams	Nej
sso	string	Nej

Respons

Returnerer: Option[SetCommentTextResponse]

Eksempel

postSetCommentText Eksempel

Copy

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

postUnFlagComment

Parametre

Navn	Type	Påkrævet	Beskrivelse
commentId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

postUnFlagComment Eksempel

Copy

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

postVote

Parametre

Navn	Type	Påkrævet
commentId	string	Ja
direction	string	Nej
sso	string	Nej

Svar

Returnerer: Option[VoteResponse]

Eksempel

postVote-eksempel

Copy

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

putAwardBadge

Parametre

Navn	Type	Påkrævet
badgeId	string	Nej
userId	string	Nej
commentId	string	Ja
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[AwardUserBadgeResponse]

Eksempel

putAwardBadge Eksempel

Copy

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

putCloseThread

Parametre

Navn	Type	Påkrævet	Beskrivelse
urlId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

putCloseThread Eksempel

Copy

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

putRemoveBadge

Parametre

Navn	Type	Påkrævet
badgeId	string	Nej
userId	string	Nej
commentId	string	Ja
broadcastId	string	Nej
sso	string	Nej

Svar

Returnerer: Option[RemoveUserBadgeResponse]

Eksempel

putRemoveBadge-eksempel

Copy

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

putReopenThread

Parametre

Navn	Type	Påkrævet	Beskrivelse
urlId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

putReopenThread Eksempel

Copy

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

setTrustFactor

Parametre

Navn	Type	Påkrævet
userId	string	Nej
trustFactor	string	Nej
sso	string	Nej

Svar

Returnerer: Option[SetUserTrustFactorResponse]

Eksempel

setTrustFactor Eksempel

Copy

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

createModerator

Parametre

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

Svar

Returnerer: Option[CreateModeratorResponse]

Eksempel

createModerator Eksempel

Copy

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

deleteModerator

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deleteModerator

Copy

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

getModerator

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetModeratorResponse]

Eksempel

getModerator Eksempel

Copy

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

getModerators

Parametre

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

Svar

Returnerer: Option[GetModeratorsResponse]

Eksempel

getModerators Eksempel

Copy

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

updateModerator

Parametre

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

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

updateModerator Eksempel

Copy

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

deleteNotificationCount

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteNotificationCount Eksempel

Copy

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

getCachedNotificationCount

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetCachedNotificationCountResponse]

Eksempel

getCachedNotificationCount Eksempel

Copy

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

getNotificationCount

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
urlId	string	Ja
fromCommentId	string	Nej
viewed	bool	Nej

Respons

Returnerer: Option[GetNotificationCountResponse]

Eksempel

getNotificationCount Eksempel

Copy

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

getNotifications

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
urlId	string	Ja
fromCommentId	string	Nej
viewed	bool	Nej
skip	float64	Nej

Svar

Returnerer: Option[GetNotificationsResponse]

Eksempel

getNotifications Eksempel

Copy

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

updateNotification

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
updateNotificationBody	UpdateNotificationBody	Nej
userId	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på updateNotification

Copy

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

createV1PageReact

Parametre

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

Respons

Returnerer: Option[CreateV1PageReact]

Eksempel

createV1PageReact Eksempel

Copy

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

createV2PageReact

Parametre

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

Svar

Returnerer: Option[CreateV1PageReact]

Eksempel

Eksempel på createV2PageReact

Copy

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

deleteV1PageReact

Parametre

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

Svar

Returnerer: Option[CreateV1PageReact]

Eksempel

deleteV1PageReact Eksempel

Copy

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

deleteV2PageReact

Parametre

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

Svar

Returnerer: Option[CreateV1PageReact]

Eksempel

deleteV2PageReact Eksempel

Copy

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

getV1PageLikes

Parametre

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

Svar

Returnerer: Option[GetV1PageLikes]

Eksempel

getV1PageLikes Eksempel

Copy

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

getV2PageReacts

Parametre

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

Svar

Returnerer: Option[GetV2PageReacts]

Eksempel

getV2PageReacts Eksempel

Copy

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

getV2PageReactUsers

Parametre

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

Svar

Returnerer: Option[GetV2PageReactUsersResponse]

Eksempel

getV2PageReactUsers Eksempel

Copy

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

addPage

Parametre

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

Svar

Returnerer: Option[AddPageAPIResponse]

Eksempel

addPage-eksempel

Copy

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

deletePage

Parametre

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

Respons

Returnerer: Option[DeletePageAPIResponse]

Eksempel

deletePage Eksempel

Copy

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

getOfflineUsers

Tidligere kommentatorer på siden som IKKE er online lige nu. Sorteret efter displayName. Brug dette efter at have udtømt /users/online for at gengive en "Medlemmer"-sektion. Cursor-paginering på commenterName: serveren går igennem den delvise {tenantId, urlId, commenterName} index fra afterName fremad via $gt, no $skip cost.

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Response

Returnerer: Option[PageUsersOfflineResponse]

Eksempel

Eksempel på getOfflineUsers

Copy

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

getOnlineUsers

Nuværende online-seere på en side: personer hvis websocket-session er abonneret på siden lige nu. Returnerer anonCount + totalCount (abonnenter for hele rummet, inklusive anonyme seere, som vi ikke opregner).

Parametre

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

Svar

Returnerer: Option[PageUsersOnlineResponse]

Eksempel

getOnlineUsers Eksempel

Copy

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

getPageByURLId

Parametre

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

Svar

Returnerer: Option[GetPageByURLIdAPIResponse]

Eksempel

getPageByURLId Eksempel

Copy

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

getPages

Parametre

Navn	Type	Påkrævet	Beskrivelse
tenantId	string	Ja

Svar

Returnerer: Option[GetPagesAPIResponse]

Eksempel

getPages Eksempel

Copy

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

getPagesPublic

Lister sider for en tenant. Bruges af FChat desktop-klienten til at udfylde dens rumliste. Kræver, at enableFChat er true i den løste brugerdefinerede konfiguration for hver side. Sider, der kræver SSO, bliver filtreret i forhold til den anmodende brugers gruppeadgang.

Parametre

Name	Type	Required
tenantId	string	Yes
cursor	string	No
limit	int	No
q	string	No
sortBy	PagesSortBy	No
hasComments	bool	No

Svar

Returnerer: Option[GetPublicPagesResponse]

Eksempel

getPagesPublic Eksempel

Copy

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

getUsersInfo

Bulk brugeroplysninger for en tenant. Givet userIds, returnér visningsoplysninger fra User / SSOUser. Bruges af comment widget til at berige brugere, der lige dukkede op via en presence event. Ingen sidekontekst: privatliv håndhæves ensartet (private profiler er maskeret).

Parametre

Name	Type	Required	Description
tenantId	string	Ja
ids	string	Nej

Svar

Returnerer: Option[PageUsersInfoResponse]

Eksempel

getUsersInfo Eksempel

Copy

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

patchPage

Parametre

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

Svar

Returnerer: Option[PatchPageAPIResponse]

Eksempel

patchPage Eksempel

Copy

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

deletePendingWebhookEvent

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deletePendingWebhookEvent

Copy

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

getPendingWebhookEventCount

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
externalId	string	Nej
eventType	string	Nej
domain	string	Nej
attemptCountGT	float64	Nej

Svar

Returnerer: Option[GetPendingWebhookEventCountResponse]

Eksempel

getPendingWebhookEventCount Eksempel

Copy

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

getPendingWebhookEvents

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
commentId	string	Ja
externalId	string	Nej
eventType	string	Nej
domain	string	Nej
attemptCountGT	float64	Nej
skip	float64	Nej

Svar

Returnerer: Option[GetPendingWebhookEventsResponse]

Eksempel

Eksempel på getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametre

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

Respons

Returnerer: Option[CreateQuestionConfigResponse]

Eksempel

Eksempel på createQuestionConfig

Copy

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

deleteQuestionConfig

Parametre

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

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deleteQuestionConfig

Copy

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

getQuestionConfig

Parametre

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

Svar

Returnerer: Option[GetQuestionConfigResponse]

Eksempel

getQuestionConfig Eksempel

Copy

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

getQuestionConfigs

Parametre

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

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

updateQuestionConfig

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Nej
updateQuestionConfigBody	UpdateQuestionConfigBody	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på updateQuestionConfig

Copy

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

createQuestionResult

Parametre

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

Respons

Returnerer: Option[CreateQuestionResultResponse]

Eksempel

createQuestionResult Eksempel

Copy

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

deleteQuestionResult

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deleteQuestionResult

Copy

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

getQuestionResult

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetQuestionResultResponse]

Eksempel

getQuestionResult Eksempel

Copy

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

getQuestionResults

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
userId	string	Nej
startDate	string	Nej
questionId	string	Nej
questionIds	string	Nej
skip	float64	Nej

Respons

Returnerer: Option[GetQuestionResultsResponse]

Eksempel

getQuestionResults Eksempel

Copy

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

updateQuestionResult

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Nej
updateQuestionResultBody	UpdateQuestionResultBody	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på updateQuestionResult

Copy

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

aggregateQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
questionId	string	Nej
questionIds	seq[string]	Nej
urlId	string	Ja
timeBucket	AggregateTimeBucket	Nej
startDate	string	Nej
forceRecalculate	bool	Nej

Svar

Returnerer: Option[AggregateQuestionResultsResponse]

Eksempel

aggregateQuestionResults Eksempel

Copy

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

bulkAggregateQuestionResults

Parametre

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

Svar

Returnerer: Option[BulkAggregateQuestionResultsResponse]

Eksempel

bulkAggregateQuestionResults Eksempel

Copy

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

combineCommentsWithQuestionResults

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
questionId	string	Nej
questionIds	seq[string]	Nej
urlId	string	Ja
startDate	string	Nej
forceRecalculate	bool	Nej
minValue	float64	Nej
maxValue	float64	Nej
limit	float64	Nej

Respons

Returnerer: Option[CombineQuestionResultsWithCommentsResponse]

Eksempel

Eksempel på combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parametre

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

Svar

Returnerer: Option[AddSSOUserAPIResponse]

Eksempel

addSSOUser Eksempel

Copy

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

deleteSSOUser

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
deleteComments	bool	Nej
commentDeleteMode	string	Nej

Svar

Returnerer: Option[DeleteSSOUserAPIResponse]

Eksempel

deleteSSOUser Eksempel

Copy

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

getSSOUserByEmail

Parametre

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

Svar

Returnerer: Option[GetSSOUserByEmailAPIResponse]

Eksempel

Eksempel på getSSOUserByEmail

Copy

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

getSSOUserById

Parametre

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

Svar

Returnerer: Option[GetSSOUserByIdAPIResponse]

Eksempel

getSSOUserById Eksempel

Copy

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

getSSOUsers

Parametre

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

Respons

Returnerer: Option[GetSSOUsersResponse]

Eksempel

Eksempel på getSSOUsers

Copy

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

patchSSOUser

Parametre

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

Svar

Returnerer: Option[PatchSSOUserAPIResponse]

Eksempel

Eksempel på patchSSOUser

Copy

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

putSSOUser

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

createSubscription

Parametre

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

Respons

Returnerer: Option[CreateSubscriptionAPIResponse]

Eksempel

Eksempel på createSubscription

Copy

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

deleteSubscription

Parametre

Name	Type	Required
tenantId	string	Yes
id	string	No
userId	string	No

Svar

Returnerer: Option[DeleteSubscriptionAPIResponse]

Eksempel

deleteSubscription Eksempel

Copy

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

getSubscriptions

Parametre

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

Svar

Returnerer: Option[GetSubscriptionsAPIResponse]

Eksempel

getSubscriptions-eksempel

Copy

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

updateSubscription

Parametre

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

Respons

Returnerer: Option[UpdateSubscriptionAPIResponse]

Eksempel

Eksempel på updateSubscription

Copy

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

getTenantDailyUsages

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
yearNumber	float64	Nej
monthNumber	float64	Nej
dayNumber	float64	Nej
skip	float64	Nej

Svar

Returnerer: Option[GetTenantDailyUsagesResponse]

Eksempel

getTenantDailyUsages Eksempel

Copy

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

createTenantPackage

Parametre

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

Svar

Returnerer: Option[CreateTenantPackageResponse]

Eksempel

createTenantPackage Eksempel

Copy

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

deleteTenantPackage

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deleteTenantPackage

Copy

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

getTenantPackage

Parametre

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

Svar

Returnerer: Option[GetTenantPackageResponse]

Eksempel

getTenantPackage Eksempel

Copy

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

getTenantPackages

Parametre

Name	Type	Required	Description
tenantId	string	Ja
skip	float64	Nej

Svar

Returnerer: Option[GetTenantPackagesResponse]

Eksempel

getTenantPackages Eksempel

Copy

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

replaceTenantPackage

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

replaceTenantPackage Eksempel

Copy

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

updateTenantPackage

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

updateTenantPackage Eksempel

Copy

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

createTenantUser

Parametre

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

Respons

Returnerer: Option[CreateTenantUserResponse]

Eksempel

Eksempel på createTenantUser

Copy

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

deleteTenantUser

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

deleteTenantUser Eksempel

Copy

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

getTenantUser

Parametre

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

Svar

Returnerer: Option[GetTenantUserResponse]

Eksempel

getTenantUser-eksempel

Copy

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

getTenantUsers

Parametre

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

Svar

Returnerer: Option[GetTenantUsersResponse]

Eksempel

Eksempel på getTenantUsers

Copy

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

replaceTenantUser

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
id	string	Nej
replaceTenantUserBody	ReplaceTenantUserBody	Nej
updateComments	string	Nej

Respons

Returnerer: Option[APIEmptyResponse]

Eksempel

replaceTenantUser Eksempel

Copy

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

sendLoginLink

Parametre

Name	Type	Required
tenantId	string	Ja
id	string	Nej
redirectURL	string	Nej

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

sendLoginLink-eksempel

Copy

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

updateTenantUser

Parametre

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

createTenant

Parametre

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

Respons

Returnerer: Option[CreateTenantResponse]

Eksempel

createTenant Eksempel

Copy

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

deleteTenant

Parametre

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

Svar

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på deleteTenant

Copy

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

getTenant

Parametre

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nej

Svar

Returnerer: Option[GetTenantResponse]

Eksempel

getTenant Eksempel

Copy

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

getTenants

Parametre

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

Svar

Returnerer: Option[GetTenantsResponse]

Eksempel

getTenants Eksempel

Copy

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

updateTenant

Parametre

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

Response

Returnerer: Option[APIEmptyResponse]

Eksempel

Eksempel på updateTenant

Copy

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

changeTicketState

Parametre

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

Respons

Returnerer: Option[ChangeTicketStateResponse]

Eksempel

changeTicketState Eksempel

Copy

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

createTicket

Parametre

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

Svar

Returnerer: Option[CreateTicketResponse]

Eksempel

createTicket Eksempel

Copy

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

getTicket

Parametre

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

Svar

Returnerer: Option[GetTicketResponse]

Eksempel

getTicket Eksempel

Copy

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

getTickets

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
state	float64	Nej
skip	float64	Nej
limit	float64	Nej

Respons

Returnerer: Option[GetTicketsResponse]

Eksempel

getTickets Eksempel

Copy

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

getTranslations

Parametre

Navn	Type	Påkrævet
namespace	string	Nej
component	string	Nej
locale	string	Nej
useFullTranslationIds	bool	Nej

Svar

Returnerer: Option[GetTranslationsResponse]

Eksempel

getTranslations-eksempel

Copy

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

uploadImage

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
file	string	Nej
sizePreset	SizePreset	Nej
urlId	string	Ja

Svar

Returnerer: Option[UploadImageResponse]

Eksempel

uploadImage Eksempel

Copy

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

getUserBadgeProgressById

Parametre

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

Respons

Returnerer: Option[APIGetUserBadgeProgressResponse]

Eksempel

getUserBadgeProgressById Eksempel

Copy

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

getUserBadgeProgressByUserId

Parametre

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

Svar

Returnerer: Option[APIGetUserBadgeProgressResponse]

Eksempel

getUserBadgeProgressByUserId Eksempel

Copy

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

getUserBadgeProgressList

Parametre

Name	Type	Required
tenantId	string	Ja
userId	string	Nej
limit	float64	Nej
skip	float64	Nej

Svar

Returnerer: Option[APIGetUserBadgeProgressListResponse]

Eksempel

getUserBadgeProgressList Eksempel

Copy

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

createUserBadge

Parametre

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

Svar

Returnerer: Option[APICreateUserBadgeResponse]

Eksempel

Eksempel på createUserBadge

Copy

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

deleteUserBadge

Parametre

Navn	Type	Obligatorisk	Beskrivelse
tenantId	string	Ja
id	string	Nej

Respons

Returnerer: Option[APIEmptySuccessResponse]

Eksempel

deleteUserBadge-eksempel

Copy

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

getUserBadge

Parametre

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

Respons

Returnerer: Option[APIGetUserBadgeResponse]

Eksempel

Eksempel på getUserBadge

Copy

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

getUserBadges

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
userId	string	Nej
badgeId	string	Nej
displayedOnComments	bool	Nej
limit	float64	Nej
skip	float64	Nej

Respons

Returnerer: Option[APIGetUserBadgesResponse]

Eksempel

getUserBadges Eksempel

Copy

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

updateUserBadge

Parametre

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

Svar

Returnerer: Option[APIEmptySuccessResponse]

Eksempel

Eksempel på updateUserBadge

Copy

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

getUserNotificationCount

Parametre

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

Svar

Returnerer: Option[GetUserNotificationCountResponse]

Eksempel

getUserNotificationCount Eksempel

Copy

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

getUserNotifications

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
pageSize	int	Nej
afterId	string	Nej
includeContext	bool	Nej
afterCreatedAt	int64	Nej
unreadOnly	bool	Nej
dmOnly	bool	Nej
noDm	bool	Nej
includeTranslations	bool	Nej
includeTenantNotifications	bool	Nej
sso	string	Nej

Svar

Returnerer: Option[GetMyNotificationsResponse]

Eksempel

getUserNotifications Eksempel

Copy

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

resetUserNotificationCount

Parametre

Name	Type	Required	Description
tenantId	string	Ja
sso	string	Nej

Svar

Returnerer: Option[ResetUserNotificationsResponse]

Eksempel

Eksempel på resetUserNotificationCount

Copy

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

resetUserNotifications

Parametre

Navn	Type	Obligatorisk
tenantId	string	Ja
afterId	string	Nej
afterCreatedAt	int64	Nej
unreadOnly	bool	Nej
dmOnly	bool	Nej
noDm	bool	Nej
sso	string	Nej

Respons

Returnerer: Option[ResetUserNotificationsResponse]

Eksempel

resetUserNotifications Eksempel

Copy

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

updateUserNotificationCommentSubscriptionStatus

Aktivér eller deaktiver notifikationer for en bestemt kommentar.

Parametre

Name	Type	Required
tenantId	string	Ja
notificationId	string	Nej
optedInOrOut	string	Nej
commentId	string	Ja
sso	string	Nej

Respons

Returnerer: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Eksempel

updateUserNotificationCommentSubscriptionStatus Eksempel

Copy

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

updateUserNotificationPageSubscriptionStatus

Aktivér eller deaktiver meddelelser for en side. Når brugere er tilmeldt en side, oprettes der meddelelser for nye rodkommentarer, og også

Parametre

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
url	string	Nej
pageTitle	string	Nej
subscribedOrUnsubscribed	string	Nej
sso	string	Nej

Svar

Returnerer: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Eksempel

Eksempel på updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parametre

Name	Type	Påkrævet
tenantId	string	Ja
notificationId	string	Nej
newStatus	string	Nej
sso	string	Nej

Respons

Returnerer: Option[UpdateUserNotificationStatusResponse]

Eksempel

Eksempel på updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parametre

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

Svar

Returnerer: Option[GetUserPresenceStatusesResponse]

Eksempel

Eksempel på getUserPresenceStatuses

Copy

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

searchUsers

Parametre

Navn	Type	Påkrævet
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Nej
mentionGroupIds	seq[string]	Nej
sso	string	Nej
searchSection	string	Nej

Response

Returnerer: Option[SearchUsersResult]

Eksempel

searchUsers-eksempel

Copy

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

getUser

Parametre

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

Svar

Returnerer: Option[GetUserResponse]

Eksempel

getUser Eksempel

Copy

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

createVote

Parametre

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
direction	string	Nej
userId	string	Nej
anonUserId	string	Nej

Svar

Returnerer: Option[VoteResponse]

Eksempel

createVote Eksempel

Copy

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

deleteVote

Parametre

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

Svar

Returnerer: Option[VoteDeleteResponse]

Eksempel

deleteVote Eksempel

Copy

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

getVotes

Parametre

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

Svar

Returnerer: Option[GetVotesResponse]

Eksempel

getVotes-eksempel

Copy

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

getVotesForUser

Parametre

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

Svar

Returnerer: Option[GetVotesForUserResponse]

Eksempel

getVotesForUser Eksempel

Copy

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

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 kildekode

Bibliotekets indhold

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 Endpoints

Dokumentation for Modeller

aggregate

Parameters

Respons

Eksempel

getAuditLogs

Parametre

Svar

Eksempel

logoutPublic

Svar

Eksempel