FastComments Nim SDK

Dit is de officiële Nim SDK voor FastComments.

Officiële Nim SDK voor de FastComments API

Repository

Vereisten

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installatie

Nimble gebruiken

nimble install fastcomments

Bouwen vanuit bron

nimble build

Inhoud van de bibliotheek

Deze bibliotheek bevat de tegenereerde API-client en de SSO-hulpmiddelen om het werken met de API gemakkelijker te maken.

Documentatie API-clientbibliotheek

Openbare vs beveiligde API's

Voor de API-client zijn er drie API-modules, api_default, api_public en api_moderation. De api_default bevat methoden die uw API-sleutel vereisen, en api_public bevat API-aanroepen die rechtstreeks vanuit een browser/mobiel apparaat/etc. kunnen worden gedaan zonder authenticatie. De api_moderation-module bevat methoden voor het moderator-dashboard.

De `api_moderation`-module biedt een uitgebreide reeks live en snelle moderatie-API's. Elke `api_moderation`-methode accepteert een `sso`-parameter en kan authenticeren via SSO of een FastComments.com sessiecookie.

Snelstart

Gebruik van geauthenticeerde API's (DefaultAPI)

Belangrijk: Geauthenticeerde eindpunten vereisen dat uw API‑sleutel wordt ingesteld als de x-api-key header.

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"

# Make authenticated API calls.
# Required parameters (and the request body) are positional; optional
# parameters are passed via the operation's options object.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Gebruik van openbare API's (PublicAPI)

Openbare eindpunten vereisen geen authenticatie:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Make public API calls.
# tenantId and urlId are required (positional); everything else is optional.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Gebruik van moderatie‑API's (ModerationAPI)

Moderatie‑eindpunten voeden het moderator‑dashboard en zijn geauthenticeerd met een SSO‑token voor de werkende moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# List comments in the moderation dashboard.
# This operation has no required parameters, so everything is optional.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Veelvoorkomende problemen

401 authenticatiefout: Zorg ervoor dat u de x-api-key header op uw HttpClient instelt voordat u DefaultAPI‑verzoeken doet: client.headers["x-api-key"] = "your-api-key"
Verkeerde API‑klasse: Gebruik api_default voor server‑side geauthenticeerde verzoeken, api_public voor client‑side/openbare verzoeken, en api_moderation voor moderator‑dashboard verzoeken.

API-aanroepen

Alle API-methoden in deze SDK retourneren tuples van (Option[ResponseType], Response). Het eerste element bevat de geparseerde respons indien geslaagd, en het tweede element is de ruwe HTTP-respons.

Vereiste parameters en de request body worden positioneel doorgegeven. De resterende optionele parameters worden verzameld in één Api<Operation>Options-object, dat het laatste argument is. Operaties zonder optionele parameters nemen geen opties-object.

Voorbeeld: Opvragen van reacties

import httpclient
import options
import fastcomments
import fastcomments/apis/api_default

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

let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Opmerkingen

Broadcast-id's

Je zult zien dat je in sommige API-aanroepen een broadcastId moet meegeven. Wanneer je gebeurtenissen ontvangt, krijg je deze ID terug, zodat je weet dat je de gebeurtenis moet negeren als je van plan bent wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen omdat het de beste ervaring biedt). Geef hier een UUID door. De ID moet voldoende uniek zijn zodat deze niet twee keer in een browsersessie voorkomt.

SSO (Single Sign-On)

Voor SSO-voorbeelden, zie hieronder.

SSO-gebruik

Eenvoudige 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

Beveiligde 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

Documentatie voor fastcomments

Documentatie voor API-eindpunten

Alle URI's zijn relatief ten opzichte van https://fastcomments.com

Klasse	Methode	HTTP‑verzoek	Beschrijving
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documenten door ze te groeperen (indien groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Vorige commentatoren op de pagina die NIET momenteel online zijn. Gesorteerd op displayName. Gebruik dit nadat /users/online is uitgeput om een “Members”‑sectie te renderen. Cursor‑paginering op commenterName: server doorloopt de partiële {tenantId, urlId, commenterName}‑index vanaf afterName via `$gt`, zonder `$skip`‑kosten.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Huidig‑online kijkers van een pagina: personen waarvan de websocket‑sessie nu op de pagina is geabonneerd. Retourneert anonCount + totalCount (abonnees op de room, inclusief anonieme kijkers die niet worden opgesomd).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Lijst pagina’s voor een tenant. Wordt gebruikt door de FChat‑desktopclient om de kamerlijst te vullen. Vereist `enableFChat` = true in de opgeloste custom‑configuratie voor elke pagina. Pagina’s die SSO vereisen worden gefilterd op groeps‑toegang van de aanvragende gebruiker.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk‑gebruiker‑info voor een tenant. Gegeven userIds wordt weergave‑info uit User / SSOUser geretourneerd. Wordt door de comment‑widget gebruikt om gebruikers die net verschenen via een presence‑event te verrijken. Geen paginacontext: privacy wordt uniform afgedwongen (privé‑profielen worden gemaskeerd).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload en verklein een afbeelding
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentatie voor Modellen

aggregate

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

Parameters

Naam	Type	Vereist
tenantId	string	Ja
aggregationRequest	AggregationRequest	Nee
options	AggregateOptions	Nee

Respons

Retourneert: Option[AggregateResponse]

Voorbeeld

aggregate Voorbeeld

Copy

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

getAuditLogs

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetAuditLogsOptions	Nee

Respons

Retourneert: Option[GetAuditLogsResponse]

Voorbeeld

getAuditLogs Voorbeeld

Copy

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

logoutPublic

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

logoutPublic Voorbeeld

Copy

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

blockFromCommentPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nee
sso	string = ""	Nee

Respons

Retourneert: Option[BlockSuccess]

Voorbeeld

blockFromCommentPublic Voorbeeld

Copy

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

unBlockCommentPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nee
sso	string = ""	Nee

Reactie

Retourneert: Option[UnblockSuccess]

Voorbeeld

unBlockCommentPublic Voorbeeld

Copy

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

checkedCommentsForBlocked

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentIds	string	Nee
sso	string = ""	Nee

Respons

Retourneert: Option[CheckBlockedCommentsResponse]

Voorbeeld

checkedCommentsForBlocked Voorbeeld

Copy

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

blockUserFromComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
blockFromCommentParams	BlockFromCommentParams	Nee
options	BlockUserFromCommentOptions	Nee

Response

Returns: Option[BlockSuccess]

Example

blockUserFromComment Voorbeeld

Copy

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

createCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Nee
commentData	CommentData	Nee
options	CreateCommentPublicOptions	Nee

Respons

Retourneert: Option[SaveCommentsResponseWithPresence]

Voorbeeld

createCommentPublic Voorbeeld

Copy

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

deleteComment

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Respons

Retourneert: Option[DeleteCommentResult]

Voorbeeld

deleteComment Voorbeeld

Copy

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

deleteCommentPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
options	DeleteCommentPublicOptions	Nee

Respons

Retourneert: Option[PublicAPIDeleteCommentResponse]

Voorbeeld

deleteCommentPublic Voorbeeld

Copy

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

deleteCommentVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
voteId	string	Nee
urlId	string	Ja
broadcastId	string	Nee
options	DeleteCommentVoteOptions	Nee

Respons

Retourneert: Option[VoteDeleteResponse]

Voorbeeld

deleteCommentVote Voorbeeld

Copy

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

flagComment

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Nee
options	FlagCommentOptions	Nee

Response

Retourneert: Option[FlagCommentResponse]

Example

flagComment voorbeeld

Copy

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

getComment

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIGetCommentResponse]

Voorbeeld

Voorbeeld getComment

Copy

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

getComments

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetCommentsOptions	Nee

Respons

Retourneert: Option[APIGetCommentsResponse]

Voorbeeld

getComments Voorbeeld

Copy

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

getCommentsPublic

req tenantId urlId

Parameters

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
options	GetCommentsPublicOptions	Nee

Response

Retourneert: Option[GetCommentsResponseWithPresencePublicComment]

Voorbeeld

getCommentsPublic Voorbeeld

Copy

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

getCommentText

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
options	GetCommentTextOptions	Nee

Response

Retourneert: Option[PublicAPIGetCommentTextResponse]

Example

getCommentText Voorbeeld

Copy

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

getCommentVoteUserNames

Parameters

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

Respons

Retourneert: Option[GetCommentVoteUserNamesSuccessResponse]

Voorbeeld

getCommentVoteUserNames Voorbeeld

Copy

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

lockComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
sso	string = ""	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

lockComment Voorbeeld

Copy

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

pinComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
sso	string = ""	Nee

Respons

Retourneert: Option[ChangeCommentPinStatusResponse]

Voorbeeld

pinComment Voorbeeld

Copy

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

saveComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
createCommentParams	CreateCommentParams	Nee
options	SaveCommentOptions	Nee

Response

Retourneert: Option[APISaveCommentResponse]

Voorbeeld

saveComment Voorbeeld

Copy

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

saveCommentsBulk

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nee
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Nee
id	string	Nee
fromName	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

saveCommentsBulk Voorbeeld

Copy

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

setCommentText

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
commentTextUpdateRequest	CommentTextUpdateRequest	Nee
options	SetCommentTextOptions	Nee

Respons

Retourneert: Option[PublicAPISetCommentTextResponse]

Voorbeeld

setCommentText Voorbeeld

Copy

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

unBlockUserFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
unBlockFromCommentParams	UnBlockFromCommentParams	Nee
options	UnBlockUserFromCommentOptions	Nee

Respons

Retourneert: Option[UnblockSuccess]

Voorbeeld

unBlockUserFromComment Voorbeeld

Copy

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

unFlagComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
options	UnFlagCommentOptions	Nee

Respons

Retourneert: Option[FlagCommentResponse]

Voorbeeld

unFlagComment Voorbeeld

Copy

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

unLockComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
sso	string = ""	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

unLockComment Voorbeeld

Copy

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

unPinComment

Parameters

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

Respons

Retourneert: Option[ChangeCommentPinStatusResponse]

Voorbeeld

unPinComment Voorbeeld

Copy

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

updateComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updatableCommentParams	UpdatableCommentParams	Nee
options	UpdateCommentOptions	Nee

Respons

Returns: Option[APIEmptyResponse]

Voorbeeld

updateComment Voorbeeld

Copy

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

voteComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

Respons

Retourneert: Option[VoteResponse]

Voorbeeld

voteComment Voorbeeld

Copy

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

getCommentsForUser

Parameters

Naam	Type	Verplicht	Beschrijving
options	GetCommentsForUserOptions	Nee

Respons

Retourneert: Option[GetCommentsForUserResponse]

Voorbeeld

getCommentsForUser Voorbeeld

Copy

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

addDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Respons

Retourneert: Option[AddDomainConfigResponse]

Voorbeeld

addDomainConfig Voorbeeld

Copy

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

deleteDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Nee

Respons

Retourneert: Option[DeleteDomainConfigResponse]

Voorbeeld

deleteDomainConfig Voorbeeld

Copy

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

getDomainConfig

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
domain	string	Nee

Respons

Retourneert: Option[GetDomainConfigResponse]

Voorbeeld

getDomainConfig Voorbeeld

Copy

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

getDomainConfigs

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Response

Retourneert: Option[GetDomainConfigsResponse]

Voorbeeld

getDomainConfigs Voorbeeld

Copy

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

patchDomainConfig

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
domainToUpdate	string	Nee
patchDomainConfigParams	PatchDomainConfigParams	Nee

Respons

Retourneert: Option[PatchDomainConfigResponse]

Voorbeeld

patchDomainConfig Voorbeeld

Copy

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

putDomainConfig

Parameters

Naam	Type	Vereist
tenantId	string	Ja
domainToUpdate	string	Nee
updateDomainConfigParams	UpdateDomainConfigParams	Nee

Respons

Returns: Option[PutDomainConfigResponse]

Voorbeeld

putDomainConfig Voorbeeld

Copy

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

createEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Nee

Respons

Retourneert: Option[CreateEmailTemplateResponse]

Voorbeeld

createEmailTemplate Voorbeeld

Copy

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

deleteEmailTemplate

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteEmailTemplate voorbeeld

Copy

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

deleteEmailTemplateRenderError

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
errorId	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteEmailTemplateRenderError Voorbeeld

Copy

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

getEmailTemplate

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetEmailTemplateResponse]

Voorbeeld

getEmailTemplate Voorbeeld

Copy

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

getEmailTemplateDefinitions

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja

Respons

Retourneert: Option[GetEmailTemplateDefinitionsResponse]

Voorbeeld

Voorbeeld getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
skip	float64	Nee

Response

Retourneert: Option[GetEmailTemplateRenderErrorsResponse]

Example

getEmailTemplateRenderErrors Voorbeeld

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # gebruik resp indien nodig
else:
  # verwerk ontbrekende respons
  discard

getEmailTemplates

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Retourneert: Option[GetEmailTemplatesResponse]

Voorbeeld

getEmailTemplates Voorbeeld

Copy

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

renderEmailTemplate

Parameters

Name	Type	Required
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Nee
locale	string = ""	Nee

Respons

Retourneert: Option[RenderEmailTemplateResponse]

Voorbeeld

renderEmailTemplate Voorbeeld

Copy

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

updateEmailTemplate

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
updateEmailTemplateBody	UpdateEmailTemplateBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateEmailTemplate Voorbeeld

Copy

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

getEventLog

req tenantId urlId userIdWS

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Respons

Retour: Option[GetEventLogResponse]

Voorbeeld

getEventLog Voorbeeld

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Nee
startTime	int64	Nee
endTime	int64	Nee

Reactie

Retourneert: Option[GetEventLogResponse]

Voorbeeld

Voorbeeld getGlobalEventLog

Copy

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

createFeedPost

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nee
options	CreateFeedPostOptions	Nee

Respons

Retourneert: Option[CreateFeedPostsResponse]

Voorbeeld

createFeedPost Voorbeeld

Copy

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

createFeedPostPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nee
options	CreateFeedPostPublicOptions	Nee

Respons

Retourneert: Option[CreateFeedPostResponse]

Voorbeeld

createFeedPostPublic Voorbeeld

Copy

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

deleteFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Nee
options	DeleteFeedPostPublicOptions	Nee

Respons

Retourneert: Option[DeleteFeedPostPublicResponse]

Voorbeeld

deleteFeedPostPublic Voorbeeld

Copy

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

getFeedPosts

req tenantId afterId

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetFeedPostsOptions	Nee

Respons

Retourneert: Option[GetFeedPostsResponse]

Voorbeeld

getFeedPosts Voorbeeld

Copy

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

getFeedPostsPublic

req tenantId afterId

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetFeedPostsPublicOptions	Nee

Reactie

Retourneert: Option[PublicFeedPostsResponse]

Voorbeeld

Voorbeeld getFeedPostsPublic

Copy

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

getFeedPostsStats

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
postIds	seq[string]	Nee
sso	string = ""	Nee

Respons

Retourneert: Option[FeedPostsStatsResponse]

Voorbeeld

getFeedPostsStats Voorbeeld

Copy

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

getUserReactsPublic

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Yes
options	GetUserReactsPublicOptions	No

Respons

Retourneert: Option[UserReactsResponse]

Voorbeeld

getUserReactsPublic Voorbeeld

Copy

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

reactFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Response

Retourneert: Option[ReactFeedPostResponse]

Voorbeeld

reactFeedPostPublic Voorbeeld

Copy

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

updateFeedPost

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateFeedPost Voorbeeld

Copy

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

updateFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Nee
updateFeedPostParams	UpdateFeedPostParams	Nee
options	UpdateFeedPostPublicOptions	Nee

Respons

Retourneert: Option[CreateFeedPostResponse]

Voorbeeld

updateFeedPostPublic Voorbeeld

Copy

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

flagCommentPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
isFlagged	bool	Nee
sso	string = ""	Nee

Reactie

Retourneert: Option[APIEmptyResponse]

Voorbeeld

flagCommentPublic Voorbeeld

Copy

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

getGifLarge

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
largeInternalURLSanitized	string	Nee

Respons

Retourneert: Option[GifGetLargeResponse]

Voorbeeld

getGifLarge Voorbeeld

Copy

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

getGifsSearch

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
search	string	Nee
options	GetGifsSearchOptions	Nee

Respons

Retourneert: Option[GetGifsSearchResponse]

Voorbeeld

getGifsSearch Voorbeeld

Copy

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

getGifsTrending

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetGifsTrendingOptions	Nee

Respons

Retourneert: Option[GetGifsTrendingResponse]

Voorbeeld

getGifsTrending Voorbeeld

Copy

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

addHashTag

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createHashTagBody	CreateHashTagBody	Nee

Reactie

Retourneert: Option[CreateHashTagResponse]

Voorbeeld

addHashTag Voorbeeld

Copy

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

addHashTagsBulk

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nee

Response

Retourneert: Option[BulkCreateHashTagsResponse]

Example

addHashTagsBulk Voorbeeld

Copy

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

deleteHashTag

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
tag	string	Nee
deleteHashTagRequestBody	DeleteHashTagRequestBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteHashTag Voorbeeld

Copy

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

getHashTags

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
page	float64	Nee

Respons

Retourneert: Option[GetHashTagsResponse]

Voorbeeld

getHashTags Voorbeeld

Copy

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

patchHashTag

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
tag	string	No
updateHashTagBody	UpdateHashTagBody	No

Reactie

Geeft terug: Option[UpdateHashTagResponse]

Voorbeeld

patchHashTag Voorbeeld

Copy

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

deleteModerationVote

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
options	DeleteModerationVoteOptions	No

Respons

Retourneert: Option[VoteDeleteResponse]

Voorbeeld

deleteModerationVote Voorbeeld

Copy

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

getApiComments

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetApiCommentsOptions	Nee

Respons

Retourneert: Option[ModerationAPIGetCommentsResponse]

Voorbeeld

getApiComments Voorbeeld

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # verdere verwerking kan worden gedaan met `resp`

getApiExportStatus

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetApiExportStatusOptions	Nee

Response

Retourneert: Option[ModerationExportStatusResponse]

Voorbeeld

Voorbeeld getApiExportStatus

Copy

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

getApiIds

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetApiIdsOptions	Nee

Response

Retourneert: Option[ModerationAPIGetCommentIdsResponse]

Voorbeeld

getApiIds Voorbeeld

Copy

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

getBanUsersFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nee

Reactie

Retourneert: Option[GetBannedUsersFromCommentResponse]

Voorbeeld

getBanUsersFromComment Voorbeeld

Copy

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

getCommentBanStatus

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Response

Retourneert: Option[GetCommentBanStatusResponse]

Example

getCommentBanStatus voorbeeld

Copy

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

getCommentChildren

Parameters

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

Respons

Retourneert: Option[ModerationAPIChildCommentsResponse]

Voorbeeld

Voorbeeld getCommentChildren

Copy

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

getCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetCountOptions	Nee

Respons

Retourneert: Option[ModerationAPICountCommentsResponse]

Voorbeeld

getCount Voorbeeld

Copy

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

getCounts

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[GetBannedUsersCountResponse]

Voorbeeld

getCounts Voorbeeld

Copy

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

getLogs

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Reactie

Retourneert: Option[ModerationAPIGetLogsResponse]

Voorbeeld

getLogs Voorbeeld

Copy

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

getManualBadges

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[GetTenantManualBadgesResponse]

Voorbeeld

getManualBadges Voorbeeld

Copy

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

getManualBadgesForUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
options	GetManualBadgesForUserOptions	No

Respons

Retourneert: Option[GetUserManualBadgesResponse]

Voorbeeld

getManualBadgesForUser Voorbeeld

Copy

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

getModerationComment

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
options	GetModerationCommentOptions	No

Respons

Retourneert: Option[ModerationAPICommentResponse]

Voorbeeld

Voorbeeld van getModerationComment

Copy

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

getModerationCommentText

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[GetCommentTextResponse]

Voorbeeld

Voorbeeld getModerationCommentText

Copy

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

getPreBanSummary

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
options	GetPreBanSummaryOptions	No

Respons

Retourneert: Option[PreBanSummary]

Voorbeeld

getPreBanSummary Voorbeeld

Copy

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

getSearchCommentsSummary

Parameters

Name	Type	Required	Beschrijving
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

Response

Retourneert: Option[ModerationCommentSearchResponse]

Example

getSearchCommentsSummary Voorbeeld

Copy

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

getSearchPages

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
options	GetSearchPagesOptions	No

Respons

Retourneert: Option[ModerationPageSearchResponse]

Voorbeeld

Voorbeeld getSearchPages

Copy

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

getSearchSites

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetSearchSitesOptions	Nee

Respons

Retourneert: Option[ModerationSiteSearchResponse]

Voorbeeld

getSearchSites Voorbeeld

Copy

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

getSearchSuggest

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetSearchSuggestOptions	Nee

Respons

Retourneert: Option[ModerationSuggestResponse]

Voorbeeld

getSearchSuggest Voorbeeld

Copy

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

getSearchUsers

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetSearchUsersOptions	Nee

Response

Retourneert: Option[ModerationUserSearchResponse]

Example

getSearchUsers Voorbeeld

Copy

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

getTrustFactor

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetTrustFactorOptions	No

Respons

Retourneert: Option[GetUserTrustFactorResponse]

Voorbeeld

getTrustFactor Voorbeeld

Copy

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

getUserBanPreference

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[APIModerateGetUserBanPreferencesResponse]

Voorbeeld

getUserBanPreference Voorbeeld

Copy

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

getUserInternalProfile

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
options	GetUserInternalProfileOptions	No

Reactie

Retourneert: Option[GetUserInternalProfileResponse]

Voorbeeld

getUserInternalProfile Voorbeeld

Copy

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

postAdjustCommentVotes

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

Respons

Retourneert: Option[AdjustVotesResponse]

Voorbeeld

postAdjustCommentVotes voorbeeld

Copy

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

postApiExport

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	PostApiExportOptions	Nee

Respons

Retourneert: Option[ModerationExportResponse]

Voorbeeld

postApiExport Voorbeeld

Copy

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

postBanUserFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
options	PostBanUserFromCommentOptions	Nee

Reactie

Retourneert: Option[BanUserFromCommentResult]

Voorbeeld

postBanUserFromComment Voorbeeld

Copy

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

postBanUserUndo

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
banUserUndoParams	BanUserUndoParams	Nee
sso	string = ""	Nee

Reactie

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postBanUserUndo Voorbeeld

Copy

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

postBulkPreBanSummary

Parameters

Name	Type	Required
tenantId	string	Ja
bulkPreBanParams	BulkPreBanParams	Nee
options	PostBulkPreBanSummaryOptions	Nee

Respons

Retourneert: Option[BulkPreBanSummary]

Voorbeeld

postBulkPreBanSummary Voorbeeld

Copy

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

postCommentsByIds

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentsByIdsParams	CommentsByIdsParams	No
sso	string = ""	No

Respons

Retourneert: Option[ModerationAPIChildCommentsResponse]

Voorbeeld

postCommentsByIds Voorbeeld

Copy

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

postFlagComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
options	PostFlagCommentOptions	No

Response

Retourneert: Option[APIEmptyResponse]

Example

postFlagComment Voorbeeld

Copy

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

postRemoveComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
options	PostRemoveCommentOptions	Nee

Respons

Retourneert: Option[PostRemoveCommentApiResponse]

Voorbeeld

postRemoveComment Voorbeeld

Copy

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

postRestoreDeletedComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
options	PostRestoreDeletedCommentOptions	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postRestoreDeletedComment Voorbeeld

Copy

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

postSetCommentApprovalStatus

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
options	PostSetCommentApprovalStatusOptions	Nee

Response

Retourneert: Option[SetCommentApprovedResponse]

Example

postSetCommentApprovalStatus Voorbeeld

Copy

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

postSetCommentReviewStatus

Parameters

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
options	PostSetCommentReviewStatusOptions	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postSetCommentReviewStatus Voorbeeld

Copy

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

postSetCommentSpamStatus

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
options	PostSetCommentSpamStatusOptions	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postSetCommentSpamStatus Voorbeeld

Copy

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

postSetCommentText

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
setCommentTextParams	SetCommentTextParams	Nee
options	PostSetCommentTextOptions	Nee

Response

Retourneert: Option[SetCommentTextResponse]

Example

postSetCommentText Voorbeeld

Copy

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

postUnFlagComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
options	PostUnFlagCommentOptions	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postUnFlagComment Voorbeeld

Copy

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

postVote

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
options	PostVoteOptions	Nee

Respons

Retourneert: Option[VoteResponse]

Voorbeeld

postVote Voorbeeld

Copy

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

putAwardBadge

Parameters

Naam	Type	Vereist
tenantId	string	Ja
badgeId	string	Nee
options	PutAwardBadgeOptions	Nee

Respons

Retourneert: Option[AwardUserBadgeResponse]

Voorbeeld

putAwardBadge Voorbeeld

Copy

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

putCloseThread

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

putCloseThread Voorbeeld

Copy

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

putRemoveBadge

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
badgeId	string	No
options	PutRemoveBadgeOptions	No

Respons

Retourneert: Option[RemoveUserBadgeResponse]

Voorbeeld

putRemoveBadge Voorbeeld

Copy

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

putReopenThread

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
sso	string = ""	Nee

Response

Retourneert: Option[APIEmptyResponse]

Example

putReopenThread Voorbeeld

Copy

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

setTrustFactor

Parameters

Naam	Type	Verplicht	Omschrijving
tenantId	string	Ja
options	SetTrustFactorOptions	Nee

Respons

Retourneert: Option[SetUserTrustFactorResponse]

Voorbeeld

setTrustFactor Voorbeeld

Copy

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

createModerator

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Nee

Respons

Geeft terug: Option[CreateModeratorResponse]

Voorbeeld

createModerator Voorbeeld

Copy

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

deleteModerator

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

Reactie

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteModerator Voorbeeld

Copy

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

getModerator

Parameters

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetModeratorResponse]

Voorbeeld

getModerator Voorbeeld

Copy

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

getModerators

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Response

Retourneert: Option[GetModeratorsResponse]

Voorbeeld

getModerators Voorbeeld

Copy

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

updateModerator

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateModeratorBody	UpdateModeratorBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateModerator Voorbeeld

Copy

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

deleteNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteNotificationCount Voorbeeld

Copy

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

getCachedNotificationCount

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetCachedNotificationCountResponse]

Voorbeeld

getCachedNotificationCount Voorbeeld

Copy

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

getNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetNotificationCountOptions	Nee

Respons

Retourneert: Option[GetNotificationCountResponse]

Voorbeeld

getNotificationCount voorbeeld

Copy

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

getNotifications

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetNotificationsOptions	Nee

Response

Retourneert: Option[GetNotificationsResponse]

Example

getNotifications Voorbeeld

Copy

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

updateNotification

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateNotificationBody	UpdateNotificationBody	Nee
userId	string = ""	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateNotification Voorbeeld

Copy

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

createV1PageReact

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
title	string = ""	Nee

Respons

Retourneert: Option[CreateV1PageReact]

Voorbeeld

createV1PageReact Voorbeeld

Copy

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

createV2PageReact

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
id	string	Nee
title	string = ""	Nee

Respons

Retourneert: Option[CreateV1PageReact]

Voorbeeld

createV2PageReact Voorbeeld

Copy

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

deleteV1PageReact

Parameters

Name	Type	Required	Description
tenantId	string	Ja
urlId	string	Ja

Response

Retourneert: Option[CreateV1PageReact]

Voorbeeld

deleteV1PageReact Voorbeeld

Copy

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

deleteV2PageReact

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
id	string	Nee

Respons

Retourneert: Option[CreateV1PageReact]

Voorbeeld

deleteV2PageReact Voorbeeld

Copy

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

getV1PageLikes

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: Option[GetV1PageLikes]

Voorbeeld

getV1PageLikes Voorbeeld

Copy

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

getV2PageReacts

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: Option[GetV2PageReacts]

Voorbeeld

getV2PageReacts Voorbeeld

Copy

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

getV2PageReactUsers

Parameters

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
id	string	Nee

Reactie

Returns: Option[GetV2PageReactUsersResponse]

Voorbeeld

getV2PageReactUsers Voorbeeld

Copy

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

addPage

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Nee

Respons

Retourneert: Option[AddPageAPIResponse]

Voorbeeld

addPage Voorbeeld

Copy

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

deletePage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[DeletePageAPIResponse]

Voorbeeld

deletePage voorbeeld

Copy

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

getOfflineUsers

Vorige commenters op de pagina die NIET momenteel online zijn. Gesorteerd op displayName.
Gebruik dit nadat /users/online is uitgeput om een "Members"-sectie weer te geven.
Cursor-paginering op commenterName: de server doorloopt de partiële {tenantId, urlId, commenterName} index vanaf afterName voortzetten via $gt, zonder $skip‑kosten.

Parameters

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

Response

Retourneert: Option[PageUsersOfflineResponse]

Voorbeeld

getOfflineUsers Voorbeeld

Copy

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

getOnlineUsers

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
options	GetOnlineUsersOptions	Nee

Respons

Returns: Option[PageUsersOnlineResponse]

Voorbeeld

Voorbeeld getOnlineUsers

Copy

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

getPageByURLId

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: Option[GetPageByURLIdAPIResponse]

Voorbeeld

getPageByURLId Voorbeeld

Copy

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

getPages

Parameters

Naam	Type	Vereist	Omschrijving
tenantId	string	Ja

Respons

Retourneert: Option[GetPagesAPIResponse]

Voorbeeld

getPages Voorbeeld

Copy

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

getPagesPublic

List pagina's voor een tenant. Wordt gebruikt door de FChat‑desktopclient om zijn kamerlijst te vullen.
Vereist dat enableFChat true is in de opgeloste aangepaste configuratie voor elke pagina.
Pagina's die SSO vereisen, worden gefilterd op basis van de groepsrechten van de aanvragende gebruiker.

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetPagesPublicOptions	Nee

Respons

Retourneert: Option[GetPublicPagesResponse]

Voorbeeld

getPagesPublic Voorbeeld

Copy

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

getUsersInfo

Bulk gebruikersinfo voor een huurder. Gegeven userIds wordt weergave‑info van User / SSOUser geretourneerd. Wordt gebruikt door de reactie‑widget om gebruikers die zojuist verschenen via een aanwezigheids‑event te verrijken. Geen paginacontext: privacy wordt uniform afgedwongen (privéprofielen worden gemaskeerd).

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
ids	string	Nee

Response

Retourneert: Option[PageUsersInfoResponse]

Voorbeeld

getUsersInfo Voorbeeld

Copy

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

patchPage

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
updateAPIPageData	UpdateAPIPageData	Nee

Respons

Retourneert: Option[PatchPageAPIResponse]

Voorbeeld

patchPage Voorbeeld

Copy

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

deletePendingWebhookEvent

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deletePendingWebhookEvent Voorbeeld

Copy

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

getPendingWebhookEventCount

Parameters

Name	Type	Required	Description
tenantId	string	Ja
options	GetPendingWebhookEventCountOptions	Nee

Response

Retourneert: Option[GetPendingWebhookEventCountResponse]

Example

getPendingWebhookEventCount Voorbeeld

Copy

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

getPendingWebhookEvents

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetPendingWebhookEventsOptions	Nee

Respons

Retourneert: Option[GetPendingWebhookEventsResponse]

Voorbeeld

getPendingWebhookEvents Voorbeeld

Copy

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

createQuestionConfig

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nee

Respons

Returns: Option[CreateQuestionConfigResponse]

Voorbeeld

createQuestionConfig Voorbeeld

Copy

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

deleteQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteQuestionConfig Voorbeeld

Copy

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

getQuestionConfig

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetQuestionConfigResponse]

Voorbeeld

getQuestionConfig Voorbeeld

Copy

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

getQuestionConfigs

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Response

Retourneert: Option[GetQuestionConfigsResponse]

Example

getQuestionConfigs Voorbeeld

Copy

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

updateQuestionConfig

Parameters

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

Response

Retourneert: Option[APIEmptyResponse]

Example

updateQuestionConfig Voorbeeld

Copy

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

createQuestionResult

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nee

Respons

Retourneert: Option[CreateQuestionResultResponse]

Voorbeeld

createQuestionResult Voorbeeld

Copy

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

deleteQuestionResult

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[APIEmptyResponse]

Example

deleteQuestionResult Voorbeeld

Copy

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

getQuestionResult

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetQuestionResultResponse]

Voorbeeld

getQuestionResult Voorbeeld

Copy

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

getQuestionResults

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetQuestionResultsOptions	Nee

Respons

Retourneert: Option[GetQuestionResultsResponse]

Voorbeeld

getQuestionResults Voorbeeld

Copy

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

updateQuestionResult

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
updateQuestionResultBody	UpdateQuestionResultBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateQuestionResult Voorbeeld

Copy

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

aggregateQuestionResults

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	AggregateQuestionResultsOptions	No

Respons

Retourneert: Option[AggregateQuestionResultsResponse]

Voorbeeld

aggregateQuestionResults Voorbeeld

Copy

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

bulkAggregateQuestionResults

Parameters

Naam	Type	Vereist
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Nee
forceRecalculate	bool	Nee

Respons

Retourneert: Option[BulkAggregateQuestionResultsResponse]

Voorbeeld

bulkAggregateQuestionResults Voorbeeld

Copy

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

combineCommentsWithQuestionResults

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	CombineCommentsWithQuestionResultsOptions	Nee

Respons

Retourneert: Option[CombineQuestionResultsWithCommentsResponse]

Voorbeeld

combineCommentsWithQuestionResults Voorbeeld

Copy

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

addSSOUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Nee

Respons

Retourneert: Option[AddSSOUserAPIResponse]

Voorbeeld

addSSOUser Voorbeeld

Copy

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

deleteSSOUser

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
options	DeleteSSOUserOptions	Nee

Reactie

Retourneert: Option[DeleteSSOUserAPIResponse]

Voorbeeld

deleteSSOUser Voorbeeld

Copy

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

getSSOUserByEmail

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
email	string	Nee

Respons

Retourneert: Option[GetSSOUserByEmailAPIResponse]

Voorbeeld

getSSOUserByEmail Voorbeeld

Copy

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

getSSOUserById

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetSSOUserByIdAPIResponse]

Voorbeeld

getSSOUserById Voorbeeld

Copy

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

getSSOUsers

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	int	Nee

Respons

Retourneert: Option[GetSSOUsersResponse]

Voorbeeld

getSSOUsers Voorbeeld

Copy

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

patchSSOUser

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
updateAPISSOUserData	UpdateAPISSOUserData	Nee
updateComments	bool	Nee

Respons

Retourneert: Option[PatchSSOUserAPIResponse]

Voorbeeld

patchSSOUser Voorbeeld

Copy

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

putSSOUser

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
updateAPISSOUserData	UpdateAPISSOUserData	Nee
updateComments	bool	Nee

Response

Retourneert: Option[PutSSOUserAPIResponse]

Voorbeeld

putSSOUser Voorbeeld

Copy

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

createSubscription

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nee

Response

Retourneert: Option[CreateSubscriptionAPIResponse]

Example

createSubscription Voorbeeld

Copy

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

deleteSubscription

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
userId	string = ""	Nee

Reactie

Retourneert: Option[DeleteSubscriptionAPIResponse]

Voorbeeld

deleteSubscription Voorbeeld

Copy

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

getSubscriptions

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
userId	string = ""	Nee

Respons

Retourneert: Option[GetSubscriptionsAPIResponse]

Voorbeeld

getSubscriptions Voorbeeld

Copy

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

updateSubscription

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
id	string	No
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	No
userId	string = ""	No

Respons

Retourneert: Option[UpdateSubscriptionAPIResponse]

Voorbeeld

updateSubscription Voorbeeld

Copy

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

getTenantDailyUsages

Parameters

Name	Type	Required	Description
tenantId	string	Yes
options	GetTenantDailyUsagesOptions	No

Respons

Retourneert: Option[GetTenantDailyUsagesResponse]

Voorbeeld

getTenantDailyUsages Voorbeeld

Copy

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

createTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nee

Respons

Retourneert: Option[CreateTenantPackageResponse]

Voorbeeld

createTenantPackage Voorbeeld

Copy

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

deleteTenantPackage

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[APIEmptyResponse]

Example

deleteTenantPackage Voorbeeld

Copy

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

getTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetTenantPackageResponse]

Voorbeeld

getTenantPackage Voorbeeld

Copy

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

getTenantPackages

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Retourneert: Option[GetTenantPackagesResponse]

Voorbeeld

getTenantPackages Voorbeeld

Copy

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

replaceTenantPackage

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
replaceTenantPackageBody	ReplaceTenantPackageBody	Nee

Response

Retourneert: Option[APIEmptyResponse]

Example

replaceTenantPackage Voorbeeld

Copy

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

updateTenantPackage

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
updateTenantPackageBody	UpdateTenantPackageBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateTenantPackage voorbeeld

Copy

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

createTenantUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

Respons

Retourneert: Option[CreateTenantUserResponse]

Voorbeeld

createTenantUser Voorbeeld

Copy

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

deleteTenantUser

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
options	DeleteTenantUserOptions	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteTenantUser Voorbeeld

Copy

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

getTenantUser

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetTenantUserResponse]

Voorbeeld

getTenantUser Voorbeeld

Copy

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

getTenantUsers

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Respons

Retourneert: Option[GetTenantUsersResponse]

Voorbeeld

getTenantUsers Voorbeeld

Copy

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

replaceTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Respons

Returns: Option[APIEmptyResponse]

Voorbeeld

replaceTenantUser Voorbeeld

Copy

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

sendLoginLink

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
redirectURL	string = ""	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

sendLoginLink Voorbeeld

Copy

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

updateTenantUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateTenantUserBody	UpdateTenantUserBody	Nee
updateComments	string = ""	Nee

Respons

Returns: Option[APIEmptyResponse]

Voorbeeld

updateTenantUser Voorbeeld

Copy

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

createTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantBody	CreateTenantBody	Nee

Respons

Retourneert: Option[CreateTenantResponse]

Voorbeeld

createTenant Voorbeeld

Copy

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

deleteTenant

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
sure	string = ""	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteTenant Voorbeeld

Copy

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

getTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetTenantResponse]

Voorbeeld

getTenant Voorbeeld

Copy

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

getTenants

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetTenantsOptions	Nee

Response

Retourneert: Option[GetTenantsResponse]

Voorbeeld

getTenants Voorbeeld

Copy

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

updateTenant

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateTenantBody	UpdateTenantBody	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateTenant Voorbeeld

Copy

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

changeTicketState

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
userId	string	Nee
id	string	Nee
changeTicketStateBody	ChangeTicketStateBody	Nee

Respons

Retourneert: Option[ChangeTicketStateResponse]

Voorbeeld

changeTicketState Voorbeeld

Copy

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

createTicket

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
userId	string	Nee
createTicketBody	CreateTicketBody	Nee

Respons

Retourneert: Option[CreateTicketResponse]

Voorbeeld

createTicket Voorbeeld

Copy

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

getTicket

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
userId	string = ""	Nee

Respons

Retourneert: Option[GetTicketResponse]

Voorbeeld

getTicket Voorbeeld

Copy

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

getTickets

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetTicketsOptions	Nee

Respons

Retourneert: Option[GetTicketsResponse]

Voorbeeld

getTickets Voorbeeld

Copy

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

getTranslations

Parameters

Naam	Type	Vereist
namespace	string	Nee
component	string	Nee
options	GetTranslationsOptions	Nee

Respons

Retourneert: Option[GetTranslationsResponse]

Voorbeeld

getTranslations Voorbeeld

Copy

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

uploadImage

Upload en schaalk een afbeelding

Parameters

Naam	Type	Vereist
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Response

Retourneert: Option[UploadImageResponse]

Voorbeeld

uploadImage Voorbeeld

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # gebruik het resultaat zoals nodig

getUserBadgeProgressById

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIGetUserBadgeProgressResponse]

Voorbeeld

Voorbeeld getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
userId	string	Nee

Respons

Retourneert: Option[APIGetUserBadgeProgressResponse]

Voorbeeld

getUserBadgeProgressByUserId Voorbeeld

Copy

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

getUserBadgeProgressList

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetUserBadgeProgressListOptions	Nee

Respons

Retourneert: Option[APIGetUserBadgeProgressListResponse]

Voorbeeld

getUserBadgeProgressList Voorbeeld

Copy

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

createUserBadge

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nee

Response

Retourneert: Option[APICreateUserBadgeResponse]

Example

createUserBadge Voorbeeld

Copy

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

deleteUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIEmptySuccessResponse]

Voorbeeld

deleteUserBadge Voorbeeld

Copy

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

getUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIGetUserBadgeResponse]

Voorbeeld

getUserBadge Voorbeeld

Copy

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

getUserBadges

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
options	GetUserBadgesOptions	Nee

Respons

Retourneert: Option[APIGetUserBadgesResponse]

Voorbeeld

getUserBadges Voorbeeld

Copy

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

updateUserBadge

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateUserBadgeParams	UpdateUserBadgeParams	Nee

Respons

Retourneert: Option[APIEmptySuccessResponse]

Voorbeeld

updateUserBadge Voorbeeld

Copy

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

getUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[GetUserNotificationCountResponse]

Voorbeeld

getUserNotificationCount Voorbeeld

Copy

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

getUserNotifications

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	GetUserNotificationsOptions	Nee

Respons

Retourneert: Option[GetMyNotificationsResponse]

Voorbeeld

Voorbeeld getUserNotifications

Copy

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

resetUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string = ""	Nee

Respons

Retourneert: Option[ResetUserNotificationsResponse]

Voorbeeld

resetUserNotificationCount Voorbeeld

Copy

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

resetUserNotifications

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
options	ResetUserNotificationsOptions	Nee

Respons

Retourneert: Option[ResetUserNotificationsResponse]

Voorbeeld

resetUserNotifications Voorbeeld

Copy

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

updateUserNotificationCommentSubscriptionStatus

Schakel meldingen in of uit voor een specifieke reactie.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
notificationId	string	Nee
optedInOrOut	string	Nee
commentId	string	Ja
sso	string = ""	Nee

Respons

Returns: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Voorbeeld

updateUserNotificationCommentSubscriptionStatus Voorbeeld

Copy

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

updateUserNotificationPageSubscriptionStatus

Enable of uitschakelen van meldingen voor een pagina. Wanneer gebruikers geabonneerd zijn op een pagina, worden meldingen aangemaakt voor nieuwe hoofdreacties, en ook

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
url	string	Nee
pageTitle	string	Nee
subscribedOrUnsubscribed	string	Nee
sso	string = ""	Nee

Respons

Retourneert: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Voorbeeld

Voorbeeld updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
notificationId	string	Nee
newStatus	string	Nee
sso	string = ""	Nee

Response

Retourneert: Option[UpdateUserNotificationStatusResponse]

Example

updateUserNotificationStatus Voorbeeld

Copy

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

getUserPresenceStatuses

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlIdWS	string	Nee
userIds	string	Nee

Respons

Retourneert: Option[GetUserPresenceStatusesResponse]

Voorbeeld

getUserPresenceStatuses Voorbeeld

Copy

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

searchUsers

Parameters

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

Respons

Retourneert: Option[SearchUsersResult]

Voorbeeld

searchUsers Voorbeeld

Copy

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

getUser

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Returns: Option[GetUserResponse]

Voorbeeld

getUser voorbeeld

Copy

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

createVote

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Response

Retourneert: Option[VoteResponse]

Example

createVote Voorbeeld

Copy

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

deleteVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
editKey	string = ""	Nee

Respons

Retourneert: Option[VoteDeleteResponse]

Voorbeeld

deleteVote Voorbeeld

Copy

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

getVotes

Parameters

Naam	Type	Vereist	Omschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: Option[GetVotesResponse]

Voorbeeld

getVotes Voorbeeld

Copy

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

getVotesForUser

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
options	GetVotesForUserOptions	Nee

Respons

Retourneert: Option[GetVotesForUserResponse]

Voorbeeld

getVotesForUser Voorbeeld

Copy

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

Hulp nodig?

Als u problemen ondervindt of vragen heeft over de Nim SDK, kunt u:

Bijdragen

Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.

Taal 🇳🇱 Nederlands

Documentatie

Aan de slag

API-referentie

Gebruik

Aggregatie

Auditlogs

Authenticatie

Blokkeren van reactie

Controle op geblokkeerde reacties

Reacties

Reacties voor gebruiker

Domeinconfiguraties

E-mailsjablonen

Gebeurtenislogboek

Feed-berichten

Reactie markeren

Gifs

Hashtags

Moderatie

Moderatoren

Aantal meldingen

Meldingen

Pagina-reacties

Pagina's

Wachtende webhook-evenementen

Vraagconfiguraties

Vraagresultaten

Aggregatie van vraagresultaten

SSO-gebruikers

Abonnementen

Dagelijks gebruik tenant

Tenant-pakketten

Tenant-gebruikers

Tenants

Tickets

Vertalingen

Afbeelding uploaden

Voortgang gebruikersbadge

Gebruikersbadges

Gebruikersmeldingen

Aanwezigheidsstatus van gebruikers

Gebruiker zoeken

Gebruikers

Stemmen

FastComments Nim SDK

Repository

Vereisten

Installatie

Nimble gebruiken

Bouwen vanuit bron

Inhoud van de bibliotheek

Openbare vs beveiligde API's

De api_moderation-module biedt een uitgebreide reeks live en snelle moderatie-API's. Elke api_moderation-methode accepteert een sso-parameter en kan authenticeren via SSO of een FastComments.com sessiecookie.

Snelstart

Gebruik van geauthenticeerde API's (DefaultAPI)

Gebruik van openbare API's (PublicAPI)

Gebruik van moderatie‑API's (ModerationAPI)

Veelvoorkomende problemen

API-aanroepen

Voorbeeld: Opvragen van reacties

Opmerkingen

Broadcast-id's

SSO (Single Sign-On)

SSO-gebruik

Eenvoudige SSO

Beveiligde SSO

Documentatie voor fastcomments

Documentatie voor API-eindpunten

Documentatie voor Modellen

aggregate

Parameters

Respons

Voorbeeld

getAuditLogs

Parameters

Respons

Voorbeeld

logoutPublic

Respons

De `api_moderation`-module biedt een uitgebreide reeks live en snelle moderatie-API's. Elke `api_moderation`-methode accepteert een `sso`-parameter en kan authenticeren via SSO of een FastComments.com sessiecookie.