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 vanaf de bron

nimble build

Inhoud van de bibliotheek

Deze bibliotheek bevat de gegenereerde API-client en de SSO-hulpprogramma's om het werken met de API gemakkelijker te maken.

Documentatie van de API-clientbibliotheek

Openbare versus 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. zonder authenticatie kunnen worden gedaan. De api_moderation-module bevat methoden voor het moderatoren-dashboard.

De api_moderation-methoden omvatten het opsommen, tellen, doorzoeken en exporteren van opmerkingen en hun logboeken; moderatie-acties zoals het verwijderen/herstellen van opmerkingen, markeren, het instellen van review-/spam-/goedkeuringsstatus, het aanpassen van stemmen, en het heropenen/sluiten van threads; bans (het verbannen van een gebruiker van een opmerking, het ongedaan maken van een ban, pre-ban-samenvattingen, ban-status en voorkeuren, en aantallen gebande gebruikers); en badges & vertrouwen (toekennen/verwijderen van een badge, het opsommen van handmatige badges, het verkrijgen/instellen van iemands trust factor, en het ophalen van het interne profiel van een gebruiker). Elke api_moderation-methode accepteert een sso-parameter zodat de aanroep geauthenticeerd is als een SSO-moderator.

Snelstart

Geauthenticeerde API's gebruiken (DefaultAPI)

Belangrijk: Geauthenticeerde endpoints vereisen dat uw API-sleutel is 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"

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

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

Openbare API's gebruiken (PublicAPI)

Openbare endpoints vereisen geen authenticatie:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

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

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

Moderatie-API's gebruiken (ModerationAPI)

Moderatie-endpoints voorzien het moderatiedashboard en worden geauthenticeerd met een SSO-token voor de actieve moderator:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Lijst reacties in het moderatiedashboard
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Veelvoorkomende problemen

401 authenticatiefout: Zorg dat u de x-api-key header op uw HttpClient instelt voordat u DefaultAPI-aanvragen 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 verzoeken van het moderatiedashboard.

API-aanroepen

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

Voorbeeld: Reacties ophalen

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

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

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

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

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	Aggregreert documenten door ze te groeperen (indien groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. som, countDistinct, gemiddelde, etc.) 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	vereist tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	vereist tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	vereist tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	vereist 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}	vereist tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Voorgaande reageerders op de pagina die NIET momenteel online zijn. Gesorteerd op displayName. Gebruik deze nadat /users/online is uitgeput om een "Leden"-sectie weer te geven. Cursor-paginatie op commenterName: server doorloopt de gedeeltelijke {tenantId, urlId, commenterName} index vanaf afterName vooruit via $gt, geen $skip-kosten.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Momenteel online kijkers van een pagina: mensen wiens websocket-sessie nu is geabonneerd op de pagina. Geeft anonCount + totalCount terug (abonnees over de hele ruimte, inclusief anonieme kijkers die we niet apart benoemen).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Lijst van pagina's voor een tenant. Wordt gebruikt door de FChat desktop-client om de kamerlijst te vullen. Vereist dat `enableFChat` waar is op de opgeloste aangepaste configuratie van elke pagina. Pagina's die SSO vereisen worden gefilterd op basis van de toegangsrechten van de opvragende 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 gebruikersinformatie voor een tenant. Gegeven userIds, retourneer display-informatie uit User / SSOUser. Wordt door de comment widget gebruikt om gebruikers die net via een presence-event zichtbaar werden te verrijken. Geen pagina-context: privacy wordt uniform afgedwongen (privé-profielen worden afgeschermd).
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}	Schakel meldingen voor een specifiek commentaar in of uit.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina abonneren, worden meldingen gemaakt voor nieuwe hoofdreacties, en ook
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

Voert aggregatie uit op documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
aggregationRequest	AggregationRequest	Nee
parentTenantId	string	Nee
includeStats	bool	Nee

Respons

Geeft terug: Option[AggregateResponse]

Voorbeeld

aggregate Voorbeeld

Copy

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

getAuditLogs

Parameters

Naam	Type	Vereist
tenantId	string	Ja
limit	float64	Nee
skip	float64	Nee
order	SORTDIR	Nee
after	float64	Nee
before	float64	Nee

Respons

Retourneert: Option[GetAuditLogsResponse]

Voorbeeld

getAuditLogs Voorbeeld

Copy

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

logoutPublic

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

logoutPublic Voorbeeld

Copy

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

blockFromCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nee
sso	string	Nee

Respons

Retourneert: Option[BlockSuccess]

Voorbeeld

blockFromCommentPublic Voorbeeld

Copy

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

unBlockCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nee
sso	string	Nee

Response

Geeft terug: Option[UnblockSuccess]

Voorbeeld

unBlockCommentPublic Voorbeeld

Copy

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

checkedCommentsForBlocked

Parameters

Name	Type	Required
tenantId	string	Ja
commentIds	string	Nee
sso	string	Nee

Response

Retourneert: Option[CheckBlockedCommentsResponse]

Voorbeeld

checkedCommentsForBlocked Voorbeeld

Copy

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

blockUserFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Antwoord

Retourneert: Option[BlockSuccess]

Voorbeeld

Voorbeeld van blockUserFromComment

Copy

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

createCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Nee
commentData	CommentData	Nee
sessionId	string	Nee
sso	string	Nee

Antwoord

Geeft terug: Option[SaveCommentsResponseWithPresence]

Voorbeeld

createCommentPublic Voorbeeld

Copy

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

deleteComment

Parameters

Name	Type	Vereist
tenantId	string	Ja
id	string	Nee
contextUserId	string	Nee
isLive	bool	Nee

Respons

Geeft terug: Option[DeleteCommentResult]

Voorbeeld

deleteComment Voorbeeld

Copy

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

deleteCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
editKey	string	Nee
sso	string	Nee

Response

Retourneert: Option[PublicAPIDeleteCommentResponse]

Voorbeeld

deleteCommentPublic Voorbeeld

Copy

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

deleteCommentVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
voteId	string	Nee
urlId	string	Ja
broadcastId	string	Nee
editKey	string	Nee
sso	string	Nee

Respons

Retourneert: Option[VoteDeleteResponse]

Voorbeeld

deleteCommentVote Voorbeeld

Copy

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

flagComment

Parameters

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

Response

Retourneert: Option[FlagCommentResponse]

Example

flagComment Voorbeeld

Copy

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

getComment

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIGetCommentResponse]

Voorbeeld

getComment Voorbeeld

Copy

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

getComments

Parameters

Naam	Type	Vereist
tenantId	string	Ja
page	int	Nee
limit	int	Nee
skip	int	Nee
asTree	bool	Nee
skipChildren	int	Nee
limitChildren	int	Nee
maxTreeDepth	int	Nee
urlId	string	Ja
userId	string	Nee
anonUserId	string	Nee
contextUserId	string	Nee
hashTag	string	Nee
parentId	string	Nee
direction	SortDirections	Nee
fromDate	int64	Nee
toDate	int64	Nee

Antwoord

Geeft terug: Option[APIGetCommentsResponse]

Voorbeeld

getComments Voorbeeld

Copy

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

getCommentsPublic

req tenantId urlId

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
page	int	Nee
direction	SortDirections	Nee
sso	string	Nee
skip	int	Nee
skipChildren	int	Nee
limit	int	Nee
limitChildren	int	Nee
countChildren	bool	Nee
fetchPageForCommentId	string	Nee
includeConfig	bool	Nee
countAll	bool	Nee
includei10n	bool	Nee
locale	string	Nee
modules	string	Nee
isCrawler	bool	Nee
includeNotificationCount	bool	Nee
asTree	bool	Nee
maxTreeDepth	int	Nee
useFullTranslationIds	bool	Nee
parentId	string	Nee
searchText	string	Nee
hashTags	seq[string]	Nee
userId	string	Nee
customConfigStr	string	Nee
afterCommentId	string	Nee
beforeCommentId	string	Nee

Respons

Retourneert: Option[GetCommentsResponseWithPresencePublicComment]

Voorbeeld

getCommentsPublic Voorbeeld

Copy

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

getCommentText

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nee
sso	string	Nee

Respons

Retourneert: Option[PublicAPIGetCommentTextResponse]

Voorbeeld

getCommentText Voorbeeld

Copy

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

getCommentVoteUserNames

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
dir	int	Nee
sso	string	Nee

Respons

Retourneert: Option[GetCommentVoteUserNamesSuccessResponse]

Voorbeeld

getCommentVoteUserNames Voorbeeld

Copy

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

lockComment

Parameters

Name	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

lockComment Voorbeeld

Copy

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

pinComment

Parameters

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

Antwoord

Retourneert: Option[ChangeCommentPinStatusResponse]

Voorbeeld

pinComment Voorbeeld

Copy

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

saveComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
createCommentParams	CreateCommentParams	Nee
isLive	bool	Nee
doSpamCheck	bool	Nee
sendEmails	bool	Nee
populateNotifications	bool	Nee

Response

Retourneert: Option[APISaveCommentResponse]

Voorbeeld

saveComment Voorbeeld

Copy

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

saveCommentsBulk

Parameters

Name	Type	Required
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nee
isLive	bool	Nee
doSpamCheck	bool	Nee
sendEmails	bool	Nee
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	Nee
id	string	Nee
fromName	string	Nee

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

saveCommentsBulk Voorbeeld

Copy

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

setCommentText

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nee
commentTextUpdateRequest	CommentTextUpdateRequest	Nee
editKey	string	Nee
sso	string	Nee

Respons

Retourneert: Option[PublicAPISetCommentTextResponse]

Voorbeeld

setCommentText Voorbeeld

Copy

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

unBlockUserFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Antwoord

Retourneert: Option[UnblockSuccess]

Voorbeeld

unBlockUserFromComment Voorbeeld

Copy

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

unFlagComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Nee
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: Option[FlagCommentResponse]

Voorbeeld

unFlagComment Voorbeeld

Copy

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

unLockComment

Parameters

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

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

unLockComment Voorbeeld

Copy

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

unPinComment

Parameters

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

Respons

Retourneert: Option[ChangeCommentPinStatusResponse]

Voorbeeld

unPinComment Voorbeeld

Copy

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

updateComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updatableCommentParams	UpdatableCommentParams	Nee
contextUserId	string	Nee
doSpamCheck	bool	Nee
isLive	bool	Nee

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateComment Voorbeeld

Copy

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

voteComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Nee
voteBodyParams	VoteBodyParams	Nee
sessionId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[VoteResponse]

Voorbeeld

voteComment Voorbeeld

Copy

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

getCommentsForUser

Parameters

Naam	Type	Vereist
userId	string	Nee
direction	SortDirections	Nee
repliesToUserId	string	Nee
page	float64	Nee
includei10n	bool	Nee
locale	string	Nee
isCrawler	bool	Nee

Respons

Geeft terug: Option[GetCommentsForUserResponse]

Voorbeeld

getCommentsForUser Voorbeeld

Copy

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

addDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Nee

Antwoord

Retourneert: Option[AddDomainConfigResponse]

Voorbeeld

addDomainConfig Voorbeeld

Copy

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

deleteDomainConfig

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
domain	string	Nee

Response

Retourneert: Option[DeleteDomainConfigResponse]

Voorbeeld

deleteDomainConfig Voorbeeld

Copy

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

getDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Nee

Respons

Retourneert: Option[GetDomainConfigResponse]

Voorbeeld

getDomainConfig Voorbeeld

Copy

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

getDomainConfigs

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja

Respons

Geeft terug: Option[GetDomainConfigsResponse]

Voorbeeld

getDomainConfigs Voorbeeld

Copy

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

patchDomainConfig

Parameters

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

Respons

Retourneert: Option[PatchDomainConfigResponse]

Voorbeeld

patchDomainConfig Voorbeeld

Copy

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

putDomainConfig

Parameters

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

Respons

Retourneert: Option[PutDomainConfigResponse]

Voorbeeld

putDomainConfig Voorbeeld

Copy

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

createEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Nee

Antwoord

Retourneert: Option[CreateEmailTemplateResponse]

Voorbeeld

createEmailTemplate Voorbeeld

Copy

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

deleteEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteEmailTemplate Voorbeeld

Copy

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

deleteEmailTemplateRenderError

Parameters

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

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

Voorbeeld deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parameteren

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Geeft terug: Option[GetEmailTemplateResponse]

Voorbeeld

getEmailTemplate Voorbeeld

Copy

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

getEmailTemplateDefinitions

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Antwoord

Retourneert: Option[GetEmailTemplateDefinitionsResponse]

Voorbeeld

getEmailTemplateDefinitions Voorbeeld

Copy

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

getEmailTemplateRenderErrors

Parameters

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

Antwoord

Retourneert: Option[GetEmailTemplateRenderErrorsResponse]

Voorbeeld

getEmailTemplateRenderErrors Voorbeeld

Copy

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

getEmailTemplates

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Retourneert: Option[GetEmailTemplatesResponse]

Voorbeeld

getEmailTemplates Voorbeeld

Copy

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

renderEmailTemplate

Parameters

Naam	Type	Vereist
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Nee
locale	string	Nee

Respons

Retourneert: Option[RenderEmailTemplateResponse]

Voorbeeld

renderEmailTemplate Voorbeeld

Copy

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

updateEmailTemplate

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Nee
updateEmailTemplateBody	UpdateEmailTemplateBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateEmailTemplate Voorbeeld

Copy

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

getEventLog

req tenantId urlId userIdWS

Parameters

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

Antwoord

Retourneert: Option[GetEventLogResponse]

Voorbeeld

getEventLog Voorbeeld

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Respons

Geeft terug: Option[GetEventLogResponse]

Voorbeeld

getGlobalEventLog Voorbeeld

Copy

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

createFeedPost

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nee
broadcastId	string	No
isLive	bool	No
doSpamCheck	bool	No
skipDupCheck	bool	No

Respons

Geeft terug: Option[CreateFeedPostsResponse]

Voorbeeld

createFeedPost Voorbeeld

Copy

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

createFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nee
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[CreateFeedPostResponse]

Voorbeeld

createFeedPostPublic Voorbeeld

Copy

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

deleteFeedPostPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
postId	string	Nee
broadcastId	string	Nee
sso	string	Nee

Response

Retourneert: Option[DeleteFeedPostPublicResponse]

Voorbeeld

deleteFeedPostPublic Voorbeeld

Copy

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

getFeedPosts

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Ja
afterId	string	Nee
limit	int	Nee
tags	seq[string]	Nee

Antwoord

Retourneert: Option[GetFeedPostsResponse]

Voorbeeld

getFeedPosts Voorbeeld

Copy

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

getFeedPostsPublic

req tenantId afterId

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
limit	int	Nee
tags	seq[string]	Nee
sso	string	Nee
isCrawler	bool	Nee
includeUserInfo	bool	Nee

Respons

Retourneert: Option[PublicFeedPostsResponse]

Voorbeeld

getFeedPostsPublic Voorbeeld

Copy

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

getFeedPostsStats

Parameters

Name	Type	Required
tenantId	string	Ja
postIds	seq[string]	Nee
sso	string	Nee

Response

Retourneert: Option[FeedPostsStatsResponse]

Voorbeeld

getFeedPostsStats Voorbeeld

Copy

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

getUserReactsPublic

Parameters

Name	Type	Required
tenantId	string	Ja
postIds	seq[string]	Nee
sso	string	Nee

Respons

Retourneert: Option[UserReactsResponse]

Voorbeeld

getUserReactsPublic Voorbeeld

Copy

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

reactFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Nee
reactBodyParams	ReactBodyParams	Nee
isUndo	bool	Nee
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[ReactFeedPostResponse]

Voorbeeld

reactFeedPostPublic Voorbeeld

Copy

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

updateFeedPost

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
feedPost	FeedPost	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateFeedPost Voorbeeld

Copy

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

updateFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Ja
postId	string	Nee
updateFeedPostParams	UpdateFeedPostParams	Nee
broadcastId	string	Nee
sso	string	Nee

Response

Retourneert: Option[CreateFeedPostResponse]

Voorbeeld

updateFeedPostPublic Voorbeeld

Copy

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

flagCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
isFlagged	bool	Nee
sso	string	Nee

Respons

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

flagCommentPublic Voorbeeld

Copy

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

getGifLarge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
largeInternalURLSanitized	string	Nee

Antwoord

Retourneert: Option[GifGetLargeResponse]

Voorbeeld

getGifLarge Voorbeeld

Copy

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

getGifsSearch

Parameters

Naam	Type	Vereist
tenantId	string	Ja
search	string	Nee
locale	string	Nee
rating	string	Nee
page	float64	Nee

Respons

Retourneert: Option[GetGifsSearchResponse]

Voorbeeld

getGifsSearch Voorbeeld

Copy

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

getGifsTrending

Parameters

Naam	Type	Vereist
tenantId	string	Ja
locale	string	Nee
rating	string	Nee
page	float64	Nee

Respons

Retourneert: Option[GetGifsTrendingResponse]

Voorbeeld

getGifsTrending Voorbeeld

Copy

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

addHashTag

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createHashTagBody	CreateHashTagBody	Nee

Respons

Retourneert: Option[CreateHashTagResponse]

Voorbeeld

addHashTag Voorbeeld

Copy

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

addHashTagsBulk

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nee

Respons

Retourneert: Option[BulkCreateHashTagsResponse]

Voorbeeld

addHashTagsBulk Voorbeeld

Copy

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

deleteHashTag

Parameters

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

Antwoord

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

deleteHashTag Voorbeeld

Copy

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

getHashTags

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
page	float64	Nee

Antwoord

Geeft terug: Option[GetHashTagsResponse]

Voorbeeld

Voorbeeld van getHashTags

Copy

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

patchHashTag

Parameters

Naam	Type	Vereist
tag	string	Nee
tenantId	string	Ja
updateHashTagBody	UpdateHashTagBody	Nee

Antwoord

Retourneert: Option[UpdateHashTagResponse]

Voorbeeld

patchHashTag Voorbeeld

Copy

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

deleteModerationVote

Parameters

Naam	Type	Vereist
commentId	string	Ja
voteId	string	Nee
sso	string	Nee

Antwoord

Retourneert: Option[VoteDeleteResponse]

Voorbeeld

deleteModerationVote Voorbeeld

Copy

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

getApiComments

Parameters

Naam	Type	Verplicht
page	float64	Nee
count	float64	Nee
textSearch	string	Nee
byIPFromComment	string	Nee
filters	string	Nee
searchFilters	string	Nee
sorts	string	Nee
demo	bool	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationAPIGetCommentsResponse]

Voorbeeld

getApiComments Voorbeeld

Copy

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

getApiExportStatus

Parameters

Naam	Type	Vereist	Beschrijving
batchJobId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationExportStatusResponse]

Voorbeeld

getApiExportStatus Voorbeeld

Copy

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

getApiIds

Parameters

Naam	Type	Vereist
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	bool	No
sso	string	No

Response

Retourneert: Option[ModerationAPIGetCommentIdsResponse]

Voorbeeld

getApiIds Voorbeeld

Copy

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

getBanUsersFromComment

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[GetBannedUsersFromCommentResponse]

Voorbeeld

getBanUsersFromComment Voorbeeld

Copy

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

getCommentBanStatus

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[GetCommentBanStatusResponse]

Voorbeeld

getCommentBanStatus Voorbeeld

Copy

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

getCommentChildren

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[ModerationAPIChildCommentsResponse]

Voorbeeld

getCommentChildren Voorbeeld

Copy

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

getCount

Parameters

Naam	Type	Vereist
textSearch	string	Nee
byIPFromComment	string	Nee
filter	string	Nee
searchFilters	string	Nee
demo	bool	Nee
sso	string	Nee

Respons

Geeft terug: Option[ModerationAPICountCommentsResponse]

Voorbeeld

getCount Voorbeeld

Copy

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

getCounts

Parameters

Naam	Type	Vereist	Beschrijving
sso	string	No

Antwoord

Retourneert: Option[GetBannedUsersCountResponse]

Voorbeeld

getCounts Voorbeeld

Copy

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

getLogs

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[ModerationAPIGetLogsResponse]

Voorbeeld

getLogs Voorbeeld

Copy

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

getManualBadges

Parameters

Naam	Type	Vereist	Beschrijving
sso	string	Nee

Respons

Retourneert: Option[GetTenantManualBadgesResponse]

Voorbeeld

getManualBadges Voorbeeld

Copy

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

getManualBadgesForUser

Parameters

Naam	Type	Vereist
badgesUserId	string	Nee
commentId	string	Ja
sso	string	Nee

Respons

Geeft terug: Option[GetUserManualBadgesResponse]

Voorbeeld

getManualBadgesForUser Voorbeeld

Copy

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

getModerationComment

Parameters

Naam	Type	Verplicht
commentId	string	Ja
includeEmail	bool	Nee
includeIP	bool	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationAPICommentResponse]

Voorbeeld

getModerationComment Voorbeeld

Copy

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

getModerationCommentText

Parameters

Name	Type	Required	Description
commentId	string	Ja
sso	string	Nee

Antwoord

Retourneert: Option[GetCommentTextResponse]

Voorbeeld

getModerationCommentText Voorbeeld

Copy

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

getPreBanSummary

Parameters

Naam	Type	Vereist
commentId	string	Ja
includeByUserIdAndEmail	bool	Nee
includeByIP	bool	Nee
includeByEmailDomain	bool	Nee
sso	string	Nee

Respons

Retourneert: Option[PreBanSummary]

Voorbeeld

getPreBanSummary Voorbeeld

Copy

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

getSearchCommentsSummary

Parameters

Naam	Type	Vereist
value	string	Nee
filters	string	Nee
searchFilters	string	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationCommentSearchResponse]

Voorbeeld

getSearchCommentsSummary Voorbeeld

Copy

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

getSearchPages

Parameters

Naam	Type	Vereist	Beschrijving
value	string	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationPageSearchResponse]

Voorbeeld

getSearchPages Voorbeeld

Copy

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

getSearchSites

Parameters

Naam	Type	Vereist	Beschrijving
value	string	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationSiteSearchResponse]

Voorbeeld

getSearchSites Voorbeeld

Copy

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

getSearchSuggest

Parameters

Naam	Type	Vereist	Beschrijving
textSearch	string	Nee
sso	string	Nee

Response

Retourneert: Option[ModerationSuggestResponse]

Voorbeeld

getSearchSuggest Voorbeeld

Copy

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

getSearchUsers

Parameters

Naam	Type	Vereist	Beschrijving
value	string	Nee
sso	string	Nee

Respons

Geeft terug: Option[ModerationUserSearchResponse]

Voorbeeld

getSearchUsers Voorbeeld

Copy

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

getTrustFactor

Parameters

Naam	Type	Vereist	Beschrijving
userId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[GetUserTrustFactorResponse]

Voorbeeld

getTrustFactor Voorbeeld

Copy

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

getUserBanPreference

Parameters

Naam	Type	Vereist	Beschrijving
sso	string	Nee

Response

Retourneert: Option[APIModerateGetUserBanPreferencesResponse]

Voorbeeld

getUserBanPreference Voorbeeld

Copy

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

getUserInternalProfile

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[GetUserInternalProfileResponse]

Voorbeeld

getUserInternalProfile Voorbeeld

Copy

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

postAdjustCommentVotes

Parameters

Naam	Type	Vereist
commentId	string	Ja
adjustCommentVotesParams	AdjustCommentVotesParams	Nee
sso	string	Nee

Antwoord

Retourneert: Option[AdjustVotesResponse]

Voorbeeld

postAdjustCommentVotes Voorbeeld

Copy

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

postApiExport

Parameters

Naam	Type	Verplicht
textSearch	string	Nee
byIPFromComment	string	Nee
filters	string	Nee
searchFilters	string	Nee
sorts	string	Nee
sso	string	Nee

Respons

Retourneert: Option[ModerationExportResponse]

Voorbeeld

postApiExport Voorbeeld

Copy

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

postBanUserFromComment

Parameters

Naam	Type	Vereist
commentId	string	Ja
banEmail	bool	Nee
banEmailDomain	bool	Nee
banIP	bool	Nee
deleteAllUsersComments	bool	Nee
bannedUntil	string	Nee
isShadowBan	bool	Nee
updateId	string	Nee
banReason	string	Nee
sso	string	Nee

Respons

Retourneert: Option[BanUserFromCommentResult]

Voorbeeld

postBanUserFromComment Voorbeeld

Copy

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

postBanUserUndo

Parameters

Naam	Type	Vereist	Beschrijving
banUserUndoParams	BanUserUndoParams	Nee
sso	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postBanUserUndo Voorbeeld

Copy

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

postBulkPreBanSummary

Parameters

Naam	Type	Vereist
bulkPreBanParams	BulkPreBanParams	Nee
includeByUserIdAndEmail	bool	Nee
includeByIP	bool	Nee
includeByEmailDomain	bool	Nee
sso	string	Nee

Respons

Retourneert: Option[BulkPreBanSummary]

Voorbeeld

postBulkPreBanSummary Voorbeeld

Copy

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

postCommentsByIds

Parameters

Naam	Type	Vereist	Beschrijving
commentsByIdsParams	CommentsByIdsParams	Nee
sso	string	Nee

Antwoord

Retourneert: Option[ModerationAPIChildCommentsResponse]

Voorbeeld

postCommentsByIds Voorbeeld

Copy

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

postFlagComment

Parameters

Naam	Type	Verplicht	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postFlagComment Voorbeeld

Copy

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

postRemoveComment

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[PostRemoveCommentResponse]

Voorbeeld

postRemoveComment Voorbeeld

Copy

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

postRestoreDeletedComment

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Respons

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

postRestoreDeletedComment Voorbeeld

Copy

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

postSetCommentApprovalStatus

Parameters

Naam	Type	Vereist
commentId	string	Ja
approved	bool	Nee
sso	string	Nee

Response

Retourneert: Option[SetCommentApprovedResponse]

Voorbeeld

postSetCommentApprovalStatus Voorbeeld

Copy

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

postSetCommentReviewStatus

Parameters

Naam	Type	Vereist
commentId	string	Ja
reviewed	bool	Nee
sso	string	Nee

Respons

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

postSetCommentReviewStatus Voorbeeld

Copy

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

postSetCommentSpamStatus

Parameters

Naam	Type	Vereist
commentId	string	Ja
spam	bool	Nee
permNotSpam	bool	Nee
sso	string	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postSetCommentSpamStatus Voorbeeld

Copy

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

postSetCommentText

Parameters

Naam	Type	Vereist
commentId	string	Ja
setCommentTextParams	SetCommentTextParams	Nee
sso	string	Nee

Antwoord

Retourneert: Option[SetCommentTextResponse]

Voorbeeld

postSetCommentText Voorbeeld

Copy

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

postUnFlagComment

Parameters

Naam	Type	Vereist	Beschrijving
commentId	string	Ja
sso	string	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

postUnFlagComment Voorbeeld

Copy

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

postVote

Parameters

Naam	Type	Vereist
commentId	string	Ja
direction	string	Nee
sso	string	Nee

Respons

Retourneert: Option[VoteResponse]

Voorbeeld

postVote Voorbeeld

Copy

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

putAwardBadge

Parameters

Naam	Type	Verplicht
badgeId	string	Nee
userId	string	Nee
commentId	string	Ja
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[AwardUserBadgeResponse]

Voorbeeld

putAwardBadge Voorbeeld

Copy

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

putCloseThread

Parameters

Naam	Type	Vereist	Beschrijving
urlId	string	Ja
sso	string	Nee

Antwoord

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

putCloseThread Voorbeeld

Copy

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

putRemoveBadge

Parameters

Naam	Type	Vereist
badgeId	string	Nee
userId	string	Nee
commentId	string	Ja
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[RemoveUserBadgeResponse]

Voorbeeld

putRemoveBadge Voorbeeld

Copy

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

putReopenThread

Parameters

Naam	Type	Vereist	Beschrijving
urlId	string	Ja
sso	string	Nee

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

putReopenThread Voorbeeld

Copy

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

setTrustFactor

Parameters

Name	Type	Required
userId	string	No
trustFactor	string	No
sso	string	No

Antwoord

Retourneert: Option[SetUserTrustFactorResponse]

Voorbeeld

setTrustFactor Voorbeeld

Copy

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

createModerator

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Nee

Respons

Geeft terug: Option[CreateModeratorResponse]

Voorbeeld

createModerator Voorbeeld

Copy

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

deleteModerator

Parameters

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

Reactie

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

deleteModerator Voorbeeld

Copy

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

getModerator

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetModeratorResponse]

Voorbeeld

getModerator Voorbeeld

Copy

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

getModerators

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Geeft terug: Option[GetModeratorsResponse]

Voorbeeld

getModerators Voorbeeld

Copy

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

updateModerator

Parameters

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

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateModerator Voorbeeld

Copy

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

deleteNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
id	string	No

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteNotificationCount Voorbeeld

Copy

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

getCachedNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[GetCachedNotificationCountResponse]

Voorbeeld

getCachedNotificationCount Voorbeeld

Copy

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

getNotificationCount

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
urlId	string	Ja
fromCommentId	string	Nee
viewed	bool	Nee

Response

Retourneert: Option[GetNotificationCountResponse]

Voorbeeld

getNotificationCount Voorbeeld

Copy

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

getNotifications

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
urlId	string	Ja
fromCommentId	string	Nee
viewed	bool	Nee
skip	float64	Nee

Antwoord

Geeft terug: Option[GetNotificationsResponse]

Voorbeeld

getNotifications Voorbeeld

Copy

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

updateNotification

Parameters

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

Respons

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

updateNotification Voorbeeld

Copy

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

createV1PageReact

Parameters

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

Response

Retourneert: Option[CreateV1PageReact]

Voorbeeld

createV1PageReact Voorbeeld

Copy

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

createV2PageReact

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

deleteV1PageReact

Parameters

Name	Type	Required	Description
tenantId	string	Ja
urlId	string	Ja

Respons

Geeft terug: Option[CreateV1PageReact]

Voorbeeld

deleteV1PageReact Voorbeeld

Copy

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

deleteV2PageReact

Parameters

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

Respons

Retourneert: Option[CreateV1PageReact]

Voorbeeld

deleteV2PageReact Voorbeeld

Copy

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

getV1PageLikes

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Geeft terug: Option[GetV1PageLikes]

Voorbeeld

getV1PageLikes Voorbeeld

Copy

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

getV2PageReacts

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: Option[GetV2PageReacts]

Voorbeeld

getV2PageReacts Voorbeeld

Copy

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

getV2PageReactUsers

Parameters

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

Response

Retourneert: Option[GetV2PageReactUsersResponse]

Voorbeeld

getV2PageReactUsers Voorbeeld

Copy

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

addPage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Nee

Respons

Geeft terug: Option[AddPageAPIResponse]

Voorbeeld

addPage Voorbeeld

Copy

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

deletePage

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Geeft terug: Option[DeletePageAPIResponse]

Voorbeeld

deletePage Voorbeeld

Copy

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

getOfflineUsers

Eerdere reageerders op de pagina die op dit moment NIET online zijn. Gesorteerd op displayName. Gebruik dit nadat /users/online is uitgeput om een "Leden"-sectie weer te geven. Cursorpaginatie op commenterName: de server doorloopt de partiële {tenantId, urlId, commenterName} index vanaf afterName vooruit via $gt, geen $skip-kosten.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nee
afterUserId	string	Nee

Respons

Geeft terug: Option[PageUsersOfflineResponse]

Voorbeeld

getOfflineUsers Voorbeeld

Copy

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

getOnlineUsers

Momenteel online kijkers van een pagina: mensen wiens websocket session op dit moment op de pagina geabonneerd is. Retourneert anonCount + totalCount (kamer-brede abonnees, inclusief anonieme kijkers die we niet opsommen).

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nee
afterUserId	string	Nee

Response

Retourneert: Option[PageUsersOnlineResponse]

Voorbeeld

getOnlineUsers Voorbeeld

Copy

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

getPageByURLId

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: Option[GetPageByURLIdAPIResponse]

Voorbeeld

getPageByURLId Voorbeeld

Copy

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

getPages

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja

Respons

Retourneert: Option[GetPagesAPIResponse]

Voorbeeld

getPages Voorbeeld

Copy

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

getPagesPublic

Lijst met pagina's voor een tenant. Gebruikt door de FChat-desktopclient om de lijst met kamers te vullen. Vereist dat enableFChat op true staat 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	Vereist
tenantId	string	Ja
cursor	string	Nee
limit	int	Nee
q	string	Nee
sortBy	PagesSortBy	Nee
hasComments	bool	Nee

Antwoord

Retourneert: Option[GetPublicPagesResponse]

Voorbeeld

getPagesPublic Voorbeeld

Copy

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

getUsersInfo

Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneer weergave-informatie van User / SSOUser. Wordt gebruikt door de commentaar-widget om gebruikers te verrijken die zojuist via een presence event verschenen. Geen paginacontext: privacy wordt uniform afgedwongen (privéprofielen worden gemaskeerd).

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
ids	string	Nee

Antwoord

Retourneert: Option[PageUsersInfoResponse]

Voorbeeld

getUsersInfo Voorbeeld

Copy

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

patchPage

Parameters

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

Respons

Retourneert: Option[PatchPageAPIResponse]

Voorbeeld

patchPage Voorbeeld

Copy

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

deletePendingWebhookEvent

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 = "wh_evt_9f8b7a6c")
if response.isSome:
  let apiEmpty = response.get()
  echo "Pending webhook event deleted for tenant my-tenant-123"
else:
  echo "Failed to delete pending webhook event"

getPendingWebhookEventCount

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
externalId	string	Nee
eventType	string	Nee
domain	string	Nee
attemptCountGT	float64	Nee

Antwoord

Retourneert: Option[GetPendingWebhookEventCountResponse]

Voorbeeld

getPendingWebhookEventCount Voorbeeld

Copy

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

getPendingWebhookEvents

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
externalId	string	Nee
eventType	string	Nee
domain	string	Nee
attemptCountGT	float64	Nee
skip	float64	Nee

Respons

Retourneert: Option[GetPendingWebhookEventsResponse]

Voorbeeld

getPendingWebhookEvents Voorbeeld

Copy

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

createQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nee

Antwoord

Retourneert: Option[CreateQuestionConfigResponse]

Voorbeeld

createQuestionConfig Voorbeeld

Copy

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

deleteQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

deleteQuestionConfig Voorbeeld

Copy

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

getQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Geeft terug: Option[GetQuestionConfigResponse]

Voorbeeld

getQuestionConfig Voorbeeld

Copy

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

getQuestionConfigs

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Response

Geeft terug: Option[GetQuestionConfigsResponse]

Voorbeeld

getQuestionConfigs Voorbeeld

Copy

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

updateQuestionConfig

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateQuestionConfigBody	UpdateQuestionConfigBody	Nee

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateQuestionConfig Voorbeeld

Copy

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

createQuestionResult

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nee

Antwoord

Retourneert: Option[CreateQuestionResultResponse]

Voorbeeld

createQuestionResult Voorbeeld

Copy

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

deleteQuestionResult

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

deleteQuestionResult Voorbeeld

Copy

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

getQuestionResult

Parameters

Naam	Type	Vereist	Omschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetQuestionResultResponse]

Voorbeeld

getQuestionResult Voorbeeld

Copy

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

getQuestionResults

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
userId	string	Nee
startDate	string	Nee
questionId	string	Nee
questionIds	string	Nee
skip	float64	Nee

Antwoord

Retourneert: Option[GetQuestionResultsResponse]

Voorbeeld

getQuestionResults Voorbeeld

Copy

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

updateQuestionResult

Parameters

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

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

Voorbeeld updateQuestionResult

Copy

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

aggregateQuestionResults

Parameters

Naam	Type	Vereist
tenantId	string	Ja
questionId	string	Nee
questionIds	seq[string]	Nee
urlId	string	Ja
timeBucket	AggregateTimeBucket	Nee
startDate	string	Nee
forceRecalculate	bool	Nee

Antwoord

Retourneert: Option[AggregateQuestionResultsResponse]

Voorbeeld

aggregateQuestionResults Voorbeeld

Copy

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

bulkAggregateQuestionResults

Parameters

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

Respons

Retourneert: Option[BulkAggregateQuestionResultsResponse]

Voorbeeld

bulkAggregateQuestionResults Voorbeeld

Copy

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

combineCommentsWithQuestionResults

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
questionId	string	Nee
questionIds	seq[string]	Nee
urlId	string	Ja
startDate	string	Nee
forceRecalculate	bool	Nee
minValue	float64	Nee
maxValue	float64	Nee
limit	float64	Nee

Respons

Retourneert: Option[CombineQuestionResultsWithCommentsResponse]

Voorbeeld

combineCommentsWithQuestionResults Voorbeeld

Copy

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

addSSOUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Nee

Respons

Retourneert: Option[AddSSOUserAPIResponse]

Voorbeeld

addSSOUser Voorbeeld

Copy

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

deleteSSOUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
deleteComments	bool	Nee
commentDeleteMode	string	Nee

Respons

Retourneert: Option[DeleteSSOUserAPIResponse]

Voorbeeld

deleteSSOUser Voorbeeld

Copy

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

getSSOUserByEmail

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
email	string	Nee

Antwoord

Retourneert: Option[GetSSOUserByEmailAPIResponse]

Voorbeeld

getSSOUserByEmail Voorbeeld

Copy

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

getSSOUserById

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Geeft terug: Option[GetSSOUserByIdAPIResponse]

Voorbeeld

getSSOUserById Voorbeeld

Copy

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

getSSOUsers

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	int	Nee

Respons

Retourneert: Option[GetSSOUsersResponse]

Voorbeeld

getSSOUsers Voorbeeld

Copy

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

patchSSOUser

Parameters

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

Respons

Retourneert: Option[PatchSSOUserAPIResponse]

Voorbeeld

patchSSOUser Voorbeeld

Copy

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

putSSOUser

Parameters

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

Antwoord

Retourneert: Option[PutSSOUserAPIResponse]

Voorbeeld

putSSOUser Voorbeeld

Copy

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

createSubscription

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nee

Respons

Retourneert: Option[CreateSubscriptionAPIResponse]

Voorbeeld

createSubscription Voorbeeld

Copy

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

deleteSubscription

Parameters

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

Antwoord

Retourneert: Option[DeleteSubscriptionAPIResponse]

Voorbeeld

deleteSubscription Voorbeeld

Copy

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

getSubscriptions

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
userId	string	Nee

Respons

Geeft terug: Option[GetSubscriptionsAPIResponse]

Voorbeeld

getSubscriptions Voorbeeld

Copy

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

updateSubscription

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Nee
userId	string	Nee

Respons

Retourneert: Option[UpdateSubscriptionAPIResponse]

Voorbeeld

updateSubscription Voorbeeld

Copy

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

getTenantDailyUsages

Parameters

Naam	Type	Vereist
tenantId	string	Ja
yearNumber	float64	Nee
monthNumber	float64	Nee
dayNumber	float64	Nee
skip	float64	Nee

Respons

Retourneert: Option[GetTenantDailyUsagesResponse]

Voorbeeld

getTenantDailyUsages Voorbeeld

Copy

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

createTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nee

Antwoord

Retourneert: Option[CreateTenantPackageResponse]

Voorbeeld

createTenantPackage Voorbeeld

Copy

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

deleteTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nee

Response

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

deleteTenantPackage Voorbeeld

Copy

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

getTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[GetTenantPackageResponse]

Voorbeeld

getTenantPackage Voorbeeld

Copy

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

getTenantPackages

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Antwoord

Retourneert: Option[GetTenantPackagesResponse]

Voorbeeld

getTenantPackages Voorbeeld

Copy

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

replaceTenantPackage

Parameters

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

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

replaceTenantPackage Voorbeeld

Copy

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

updateTenantPackage

Parameters

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

Respons

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateTenantPackage Voorbeeld

Copy

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

createTenantUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Nee

Antwoord

Retourneert: Option[CreateTenantUserResponse]

Voorbeeld

createTenantUser Voorbeeld

Copy

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

deleteTenantUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
deleteComments	string	Nee
commentDeleteMode	string	Nee

Antwoord

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

deleteTenantUser Voorbeeld

Copy

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

getTenantUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Geeft terug: Option[GetTenantUserResponse]

Voorbeeld

getTenantUser Voorbeeld

Copy

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

getTenantUsers

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Antwoord

Retourneert: Option[GetTenantUsersResponse]

Voorbeeld

getTenantUsers Voorbeeld

Copy

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

replaceTenantUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
replaceTenantUserBody	ReplaceTenantUserBody	Nee
updateComments	string	Nee

Response

Retourneert: Option[APIEmptyResponse]

Voorbeeld

replaceTenantUser Voorbeeld

Copy

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

sendLoginLink

Parameters

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

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

sendLoginLink Voorbeeld

Copy

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

updateTenantUser

Parameters

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

Antwoord

Retourneert: Option[APIEmptyResponse]

Voorbeeld

updateTenantUser Voorbeeld

Copy

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

createTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantBody	CreateTenantBody	Nee

Respons

Geeft terug: Option[CreateTenantResponse]

Voorbeeld

createTenant Voorbeeld

Copy

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

deleteTenant

Parameters

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

Response

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

deleteTenant Voorbeeld

Copy

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

getTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Geeft terug: Option[GetTenantResponse]

Voorbeeld

getTenant Voorbeeld

Copy

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

getTenants

Parameters

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

Antwoord

Retourneert: Option[GetTenantsResponse]

Voorbeeld

getTenants Voorbeeld

Copy

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

updateTenant

Parameters

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

Respons

Geeft terug: Option[APIEmptyResponse]

Voorbeeld

updateTenant Voorbeeld

Copy

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

changeTicketState

Parameters

Name	Type	Required
tenantId	string	Ja
userId	string	Nee
id	string	Nee
changeTicketStateBody	ChangeTicketStateBody	Nee

Antwoord

Geeft terug: Option[ChangeTicketStateResponse]

Voorbeeld

changeTicketState Voorbeeld

Copy

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

createTicket

Parameters

Name	Type	Required
tenantId	string	Ja
userId	string	Nee
createTicketBody	CreateTicketBody	Nee

Antwoord

Retourneert: Option[CreateTicketResponse]

Voorbeeld

createTicket Voorbeeld

Copy

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

getTicket

Parameters

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

Antwoord

Retourneert: Option[GetTicketResponse]

Voorbeeld

getTicket Voorbeeld

Copy

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

getTickets

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
userId	string	Nee
state	float64	Nee
skip	float64	Nee
limit	float64	Nee

Respons

Retourneert: Option[GetTicketsResponse]

Voorbeeld

getTickets Voorbeeld

Copy

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

getTranslations

Parameters

Naam	Type	Vereist
namespace	string	No
component	string	No
locale	string	No
useFullTranslationIds	bool	No

Respons

Retourneert: Option[GetTranslationsResponse]

Voorbeeld

getTranslations Voorbeeld

Copy

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

uploadImage

Parameters

Naam	Type	Vereist
tenantId	string	Ja
file	string	Nee
sizePreset	SizePreset	Nee
urlId	string	Ja

Respons

Geeft terug: Option[UploadImageResponse]

Voorbeeld

uploadImage Voorbeeld

Copy

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

getUserBadgeProgressById

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[APIGetUserBadgeProgressResponse]

Voorbeeld

getUserBadgeProgressById Voorbeeld

Copy

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

getUserBadgeProgressByUserId

Parameters

Name	Type	Required	Description
tenantId	string	Ja
userId	string	Nee

Respons

Retourneert: Option[APIGetUserBadgeProgressResponse]

Voorbeeld

getUserBadgeProgressByUserId Voorbeeld

Copy

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

getUserBadgeProgressList

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
limit	float64	Nee
skip	float64	Nee

Respons

Geeft terug: Option[APIGetUserBadgeProgressListResponse]

Voorbeeld

getUserBadgeProgressList Voorbeeld

Copy

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

createUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nee

Respons

Geeft terug: Option[APICreateUserBadgeResponse]

Voorbeeld

createUserBadge Voorbeeld

Copy

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

deleteUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[APIEmptySuccessResponse]

Voorbeeld

deleteUserBadge Voorbeeld

Copy

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

getUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[APIGetUserBadgeResponse]

Voorbeeld

getUserBadge Voorbeeld

Copy

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

getUserBadges

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
userId	string	Nee
badgeId	string	Nee
displayedOnComments	bool	Nee
limit	float64	Nee
skip	float64	Nee

Respons

Geeft terug: Option[APIGetUserBadgesResponse]

Voorbeeld

getUserBadges Voorbeeld

Copy

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

updateUserBadge

Parameters

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

Response

Retourneert: Option[APIEmptySuccessResponse]

Voorbeeld

updateUserBadge Voorbeeld

Copy

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

getUserNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Ja
sso	string	Nee

Response

Retourneert: Option[GetUserNotificationCountResponse]

Example

getUserNotificationCount Voorbeeld

Copy

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

getUserNotifications

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
pageSize	int	Nee
afterId	string	Nee
includeContext	bool	Nee
afterCreatedAt	int64	Nee
unreadOnly	bool	Nee
dmOnly	bool	Nee
noDm	bool	Nee
includeTranslations	bool	Nee
includeTenantNotifications	bool	Nee
sso	string	Nee

Response

Retourneert: Option[GetMyNotificationsResponse]

Voorbeeld

getUserNotifications Voorbeeld

Copy

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

resetUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string	Nee

Antwoord

Retourneert: Option[ResetUserNotificationsResponse]

Voorbeeld

resetUserNotificationCount Voorbeeld

Copy

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

resetUserNotifications

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
afterCreatedAt	int64	Nee
unreadOnly	bool	Nee
dmOnly	bool	Nee
noDm	bool	Nee
sso	string	Nee

Respons

Retourneert: Option[ResetUserNotificationsResponse]

Voorbeeld

resetUserNotifications Voorbeeld

Copy

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

updateUserNotificationCommentSubscriptionStatus

Schakel meldingen in of uit voor een specifieke reactie.

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
notificationId	string	Nee
optedInOrOut	string	Nee
commentId	string	Ja
sso	string	Nee

Respons

Retourneert: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Voorbeeld

Voorbeeld van updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina abonneren, worden meldingen aangemaakt voor nieuwe root-reacties, en ook

Parameters

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

Antwoord

Retourneert: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Voorbeeld

updateUserNotificationPageSubscriptionStatus Voorbeeld

Copy

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

updateUserNotificationStatus

Parameters

Naam	Type	Vereist
tenantId	string	Ja
notificationId	string	Nee
newStatus	string	Nee
sso	string	Nee

Respons

Retourneert: Option[UpdateUserNotificationStatusResponse]

Voorbeeld

Voorbeeld updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parameters

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

Antwoord

Retourneert: Option[GetUserPresenceStatusesResponse]

Voorbeeld

getUserPresenceStatuses Voorbeeld

Copy

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

searchUsers

Parameters

Naam	Type	Vereist
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	seq[string]	No
sso	string	No
searchSection	string	No

Respons

Retourneert: Option[SearchUsersResult]

Voorbeeld

searchUsers Voorbeeld

Copy

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

getUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetUserResponse]

Voorbeeld

getUser Voorbeeld

Copy

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

createVote

Parameters

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

Respons

Retourneert: Option[VoteResponse]

Voorbeeld

createVote Voorbeeld

Copy

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

deleteVote

Parameters

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

Respons

Retourneert: Option[VoteDeleteResponse]

Voorbeeld

deleteVote Voorbeeld

Copy

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

getVotes

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Antwoord

Geeft terug: Option[GetVotesResponse]

Voorbeeld

getVotes Voorbeeld

Copy

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

getVotesForUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Geeft terug: Option[GetVotesForUserResponse]

Voorbeeld

getVotesForUser Voorbeeld

Copy

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

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 vanaf de bron

Inhoud van de bibliotheek

Openbare versus beveiligde API's

Snelstart

Geauthenticeerde API's gebruiken (DefaultAPI)

Openbare API's gebruiken (PublicAPI)

Moderatie-API's gebruiken (ModerationAPI)

Veelvoorkomende problemen

API-aanroepen

Voorbeeld: Reacties ophalen

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

Voorbeeld