FastComments Nim SDK

Dit is de officiële Nim SDK voor FastComments.

Officiële Nim SDK voor de FastComments API

Repository

Vereisten

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installatie

Nimble gebruiken

nimble install fastcomments

Bouwen vanuit 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 te vergemakkelijken.

Documentatie van de API-clientbibliotheek

Openbare vs beveiligde API's

Voor de API-client zijn er twee API-modules, api_default en api_public. De api_default bevat methoden die uw API-sleutel vereisen, en api_public bevat API-aanroepen die rechtstreeks vanuit een browser/mobiel apparaat/enz. kunnen worden gedaan zonder authenticatie.

Snel aan de slag

Gebruik van geauthenticeerde API's (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"

# Maak geauthenticeerde API-aanroepen
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"

Gebruik van openbare API's (PublicAPI)

Openbare endpoints vereisen geen authenticatie:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Maak openbare API-aanroepen
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"

Veelvoorkomende problemen

401 authentication error: Zorg ervoor dat u de x-api-key header op uw HttpClient instelt voordat u DefaultAPI-aanvragen doet: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Gebruik api_default voor server-side geauthenticeerde verzoeken, api_public voor client-side/openbare verzoeken.

API-aanroepen maken

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"

Notities

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	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregeert documenten door ze te groeperen (als groupBy wordt opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
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	getFeedPosts	GET /api/v1/feed-posts	vereist tenantId afterId
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
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	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	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
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	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
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	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
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	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
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	getGlobalEventLog	GET /event-log/global/{tenantId}	vereist tenantId urlId userIdWS
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	lockComment	POST /comments/{tenantId}/{commentId}/lock
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 in of uit voor een specifieke opmerking.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Schakel meldingen in of uit voor een pagina. Wanneer gebruikers zijn geabonneerd op een pagina, worden er meldingen gemaakt voor nieuwe root-opmerkingen, en ook
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload en schaal een afbeelding
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentatie voor modellen

Documentatie voor autorisatie

api_key

Type: API key
Naam van de API-sleutelparameter: x-api-key
Locatie: HTTP-header

aggregate

Parameters

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

Respons

Retourneert: Option[AggregationResponse]

Voorbeeld

aggregate Voorbeeld

Copy

let (response, httpResponse) = client.aggregate(
  tenantId = "my-tenant-123",
  aggregationRequest = AggregationRequest(),
  parentTenantId = "",
  includeStats = false
)
if response.isSome:
  let aggregation = response.get()
  echo $aggregation

getAuditLogs

Parameters

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

Response

Retourneert: Option[GetAuditLogs_200_response]

Voorbeeld

getAuditLogs Voorbeeld

Copy

let (response, httpResponse) = client.getAuditLogs(
  tenantId = "my-tenant-123",
  limit = 100.0,
  skip = 0.0,
  order = SORTDIR(0),
  after = 0.0,
  before = 0.0
)
if response.isSome:
  let audit = response.get()
  echo audit

blockFromCommentPublic

Parameters

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

Respons

Retourneert: Option[BlockFromCommentPublic_200_response]

Voorbeeld

blockFromCommentPublic Voorbeeld

Copy

let (response, httpResponse) = client.blockFromCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-987654",
  publicBlockFromCommentParams = PublicBlockFromCommentParams(),
  sso = "sso-token-7a9b3c"
)
if response.isSome:
  let blockResult = response.get()
  discard blockResult

unBlockCommentPublic

Parameters

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

Antwoord

Retourneert: Option[UnBlockCommentPublic_200_response]

Voorbeeld

unBlockCommentPublic Voorbeeld

Copy

let (response, httpResponse) = client.unBlockCommentPublic(
  tenantId = "news-site-456",
  commentId = "comment-abc123",
  publicBlockFromCommentParams = PublicBlockFromCommentParams{},
  sso = ""
)
if response.isSome:
  let unblocked = response.get()
  discard unblocked
else:
  discard httpResponse

checkedCommentsForBlocked

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentIds	string	Nee
sso	string	Nee

Response

Retourneert: Option[CheckedCommentsForBlocked_200_response]

Voorbeeld

checkedCommentsForBlocked Voorbeeld

Copy

let (response, httpResponse) = client.checkedCommentsForBlocked(
  tenantId = "my-tenant-123",
  commentIds = "",
  sso = ""
)
if response.isSome:
  let checked = response.get()
  echo "Checked comments received for tenant my-tenant-123"
  echo checked
else:
  echo "No checked comments (HTTP status: ", $httpResponse.statusCode, ")"

blockUserFromComment

Parameters

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

Response

Retourneert: Option[BlockFromCommentPublic_200_response]

Voorbeeld

blockUserFromComment Voorbeeld

Copy

let (response, httpResponse) = client.blockUserFromComment(
  tenantId = "my-tenant-123",
  id = "comment-98765",
  blockFromCommentParams = BlockFromCommentParams(),
  userId = "user-456",
  anonUserId = ""
)
if response.isSome:
  let blocked = response.get()
  echo "Block confirmed for tenant:", " my-tenant-123"

createCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
sessionId	string	No
sso	string	No

Antwoord

Geeft terug: Option[CreateCommentPublic_200_response]

Voorbeeld

createCommentPublic Voorbeeld

Copy

let (response, httpResponse) = client.createCommentPublic(
  tenantId = "my-tenant-123",
  urlId = "news/breaking-elections-2025",
  broadcastId = "broadcast-456",
  commentData = CommentData(
    content = "Great reporting — thanks for the clear analysis!",
    authorName = "Jane Doe",
    authorEmail = "jane.doe@example.com",
    isVerified = false,
    tags = @["politics", "analysis"]
  ),
  sessionId = "session-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let created = response.get()
  echo "Created comment:", created
else:
  echo "No comment returned, HTTP status: ", httpResponse.status`

deleteComment

Parameters

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

Respons

Retourneert: Option[DeleteComment_200_response]

Voorbeeld

deleteComment Voorbeeld

Copy

let (response, httpResponse) = client.deleteComment(tenantId = "my-tenant-123", id = "cmt-456abc", contextUserId = "user-789", isLive = true)
if response.isSome:
  let deleted = response.get()
  discard deleted
  echo "Delete succeeded"
else:
  echo "No delete response"

deleteCommentPublic

Parameters

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

Respons

Geeft terug: Option[DeleteCommentPublic_200_response]

Voorbeeld

deleteCommentPublic Voorbeeld

Copy

let (response, httpResponse) = client.deleteCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "cmt-987654",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  echo "Delete succeeded"
  echo "HTTP status: ", httpResponse.status
else:
  echo "Delete failed, 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[DeleteCommentVote_200_response]

Voorbeeld

deleteCommentVote Voorbeeld

Copy

let (response, httpResponse) = client.deleteCommentVote(
  tenantId = "my-tenant-123",
  commentId = "cmt-789",
  voteId = "",
  urlId = "news/breaking-story-2025",
  broadcastId = "",
  editKey = "",
  sso = ""
)
if response.isSome:
  let deleted = response.get()
  discard deleted
  echo "Vote removed for comment cmt-789"
else:
  echo "No response body returned"

flagComment

Parameters

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

Respons

Retourneert: Option[FlagComment_200_response]

Voorbeeld

flagComment Voorbeeld

Copy

let (response, httpResponse) = client.flagComment(tenantId = "my-tenant-123", id = "cmt-98765", userId = "user-8342", anonUserId = "")
if response.isSome:
  let flagged = response.get()
  echo "Flagged comment response: ", flagged
else:
  echo "Flag comment failed: ", httpResponse

getComment

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetComment_200_response]

Voorbeeld

getComment Voorbeeld

Copy

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

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

Respons

Retourneert: Option[GetComments_200_response]

Voorbeeld

getComments Voorbeeld

Copy

let (response, httpResponse) = client.getComments(
  tenantId = "my-tenant-123",
  page = 1,
  limit = 20,
  skip = 0,
  asTree = false,
  skipChildren = 0,
  limitChildren = 0,
  maxTreeDepth = 0,
  urlId = "news/2025-election-night",
  userId = "",
  anonUserId = "",
  contextUserId = "",
  hashTag = "",
  parentId = "",
  direction = SortDirections.Desc
)
if response.isSome:
  let comments = response.get()
  echo "Status: ", httpResponse.status, " Comments: ", comments

getCommentsPublic

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[GetCommentsPublic_200_response]

Voorbeeld

getCommentsPublic Voorbeeld

Copy

let (response, httpResponse) = client.getCommentsPublic(
  tenantId = "my-tenant-123",
  urlId = "news/world/article-2025",
  page = 1,
  direction = SortDirections(0),
  sso = "sso_token_abc",
  skip = 0,
  skipChildren = 0,
  limit = 20,
  limitChildren = 5,
  countChildren = false,
  fetchPageForCommentId = "cmt_789",
  includeConfig = true,
  countAll = false,
  includei10n = true,
  locale = "en-US",
  modules = "reactions,moderation",
  isCrawler = false,
  includeNotificationCount = true,
  asTree = true,
  maxTreeDepth = 3,
  useFullTranslationIds = false,
  parentId = "parent_123",
  searchText = "openAI integration",
  hashTags = @["ai", "technology"],
  userId = "user_456",
  customConfigStr = "{}",
  afterCommentId = "cmt_100",
  beforeCommentId = ""
)
if response.isSome:
  let comments = response.get()
  discard comments
else:
  discard httpResponse

getCommentText

Parameters

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

Response

Retourneert: Option[GetCommentText_200_response]

Voorbeeld

getCommentText Voorbeeld

Copy

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

getCommentVoteUserNames

Parameters

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

Respons

Retourneert: Option[GetCommentVoteUserNames_200_response]

Voorbeeld

getCommentVoteUserNames Voorbeeld

Copy

let (response, httpResponse) = client.getCommentVoteUserNames(tenantId = "my-tenant-123", commentId = "c_987654321", dir = 0, sso = "")
if response.isSome:
  let res = response.get()
  for userName in res.userNames:
    echo userName

lockComment

Parameters

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

Respons

Geeft terug: Option[LockComment_200_response]

Voorbeeld

lockComment Voorbeeld

Copy

let (response, httpResponse) = client.lockComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-98765",
  broadcastId = "",
  sso = ""
)
if response.isSome:
  let lockResp = response.get()
  discard lockResp

pinComment

Parameters

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

Antwoord

Retourneert: Option[PinComment_200_response]

Voorbeeld

pinComment Voorbeeld

Copy

let (response, httpResponse) = client.pinComment(tenantId = "my-tenant-123", commentId = "cmt-98765", broadcastId = "", sso = "")
if response.isSome:
  let pinned = response.get()
  echo "Pinned comment response received"
else:
  echo "No pin response"

saveComment

Parameters

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

Antwoord

Retourneert: Option[SaveComment_200_response]

Voorbeeld

saveComment Voorbeeld

Copy

let (response, httpResponse) = client.saveComment(
  tenantId = "my-tenant-123",
  createCommentParams = CreateCommentParams(
    content = "This article was really helpful, thanks!",
    urlId = "news/2025-11/ai-regulations",
    authorName = "Jane Doe",
    authorEmail = "jane.doe@example.com",
    tags = @["policy", "analysis"]
  ),
  isLive = true,
  doSpamCheck = true,
  sendEmails = true,
  populateNotifications = false
)
if response.isSome:
  let saved = response.get()
  discard saved

saveCommentsBulk

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nee
isLive	bool	Nee
doSpamCheck	bool	Nee
sendEmails	bool	Nee
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	Nee
id	string	Nee
unBlockFromCommentParams	UnBlockFromCommentParams	Nee
userId	string	Nee
anonUserId	string	Nee

Antwoord

Geeft terug: Option[UnBlockCommentPublic_200_response]

Voorbeeld

saveCommentsBulk Voorbeeld

Copy

let (response, httpResponse) = client.saveCommentsBulk(
  tenantId = "my-tenant-123",
  createCommentParams = @[],
  isLive = true,
  doSpamCheck = true,
  sendEmails = false,
  populateNotifications = true,
  id = "batch-20251122",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-456",
  anonUserId = "anon-789"
)
if response.isSome:
  let unblocked = response.get()
  echo "Unblocked response received: ", unblocked
else:
  echo "No unblocked response, httpResponse: ", $httpResponse

setCommentText

Parameters

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

Respons

Retourneert: Option[SetCommentText_200_response]

Voorbeeld

setCommentText Voorbeeld

Copy

let (response, httpResponse) = client.setCommentText(
  tenantId = "my-tenant-123",
  commentId = "cmt-7890",
  broadcastId = "broadcast-456",
  commentTextUpdateRequest = CommentTextUpdateRequest(text = "Updated comment text to fix typos and add clarity."),
  editKey = "edit-key-abc123",
  sso = "sso-token-xyz"
)
if response.isSome:
  let updated = response.get()

unBlockUserFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Nee
unBlockFromCommentParams	UnBlockFromCommentParams	Nee
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: Option[UnBlockCommentPublic_200_response]

Voorbeeld

unBlockUserFromComment Voorbeeld

Copy

let (response, httpResponse) = client.unBlockUserFromComment(
  tenantId = "news-site-001",
  id = "cmt-8fj3k9",
  unBlockFromCommentParams = UnBlockFromCommentParams(),
  userId = "user-98765",
  anonUserId = ""
)
if response.isSome:
  let unblocked = response.get()
  discard unblocked

unFlagComment

Parameters

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

Respons

Retourneert: Option[FlagComment_200_response]

Voorbeeld

unFlagComment Voorbeeld

Copy

let (response, httpResponse) = client.unFlagComment(
  tenantId = "my-tenant-123",
  id = "flag-789",
  userId = "",
  anonUserId = ""
)
if response.isSome:
  let flagResponse = response.get()
  echo "Comment unflagged successfully"

unLockComment

Parameters

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

Respons

Retourneert: Option[LockComment_200_response]

Voorbeeld

unLockComment Voorbeeld

Copy

let (response, httpResponse) = client.unLockComment(tenantId = "my-tenant-123", commentId = "cmt-7f9a3b2d", broadcastId = "", sso = "")
if response.isSome:
  let lockResult = response.get()
  echo "Unlock response: ", $lockResult
else:
  echo "Unlock failed, HTTP response: ", $httpResponse

unPinComment

Parameters

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

Respons

Retourneert: Option[PinComment_200_response]

Voorbeeld

unPinComment Voorbeeld

Copy

let (response, httpResponse) = client.unPinComment(tenantId = "my-tenant-123", commentId = "cmt-9f8b7a6", broadcastId = "", sso = "")
if response.isSome:
  let pinResp = response.get()
  echo "Unpinned comment successfully"
else:
  echo "Failed to unpin comment; HTTP response: ", httpResponse

updateComment

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateComment Voorbeeld

Copy

let updatableCommentParams = UpdatableCommentParams(content: "Fixed a typo in the second paragraph", tags: @["article-edit", "typo"], isApproved: true)
let (response, httpResponse) = client.updateComment(
  tenantId = "my-tenant-123",
  id = "comment-456",
  updatableCommentParams = updatableCommentParams,
  contextUserId = "user-789",
  doSpamCheck = true,
  isLive = true
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

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[VoteComment_200_response]

Voorbeeld

voteComment Voorbeeld

Copy

let voteBody = VoteBodyParams()
let (response, httpResponse) = client.voteComment(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  urlId = "news/2025/fastcomments-integration",
  broadcastId = "",
  voteBodyParams = voteBody,
  sessionId = "",
  sso = ""
)
if response.isSome:
  let voteResp = response.get()
  echo "Vote recorded for comment cmt-456789"
else:
  echo "Failed to record vote"

addDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Nee

Antwoord

Geeft terug: Option[AddDomainConfig_200_response]

Voorbeeld

addDomainConfig Voorbeeld

Copy

let (response, httpResponse) = client.addDomainConfig(tenantId = "my-tenant-123", addDomainConfigParams = AddDomainConfigParams())
if response.isSome:
  let domainConfig = response.get()
  discard domainConfig
else:
  discard httpResponse

deleteDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Nee

Respons

Retourneert: Option[DeleteDomainConfig_200_response]

Voorbeeld

deleteDomainConfig Voorbeeld

Copy

let (response, httpResponse) = client.deleteDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let result = response.get()
  echo "Deleted domain config result: ", result
else:
  echo "No response body, HTTP status: ", $httpResponse.status

getDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Nee

Respons

Retourneert: Option[GetDomainConfig_200_response]

Voorbeeld

getDomainConfig Voorbeeld

Copy

let (response, httpResponse) = client.getDomainConfig(tenantId = "my-tenant-123", domain = "news.example.com")
if response.isSome:
  let domainConfig = response.get()
  echo "Loaded domain config for tenant my-tenant-123:", $domainConfig
else:
  echo "No domain config; HTTP status:", $httpResponse.status

getDomainConfigs

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Respons

Retourneert: Option[GetDomainConfigs_200_response]

Voorbeeld

getDomainConfigs Voorbeeld

Copy

let (response, httpResponse) = client.getDomainConfigs(tenantId = "my-tenant-123")
if response.isSome:
  let domainConfigs = response.get()
  echo "Domain configs received:"
  echo domainConfigs
else:
  echo "Failed to retrieve domain configs."
  echo httpResponse

patchDomainConfig

Parameters

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

Response

Geeft terug: Option[GetDomainConfig_200_response]

Voorbeeld

patchDomainConfig Voorbeeld

Copy

let (response, httpResponse) = client.patchDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/article-crowdsourcing",
  patchDomainConfigParams = PatchDomainConfigParams(
    allowedOrigins = @["https://www.news-site.com"],
    moderated = true,
    maxCommentLength = 1000
  )
)
if response.isSome:
  let domainConfig = response.get()
  echo "Updated domain config received"
else:
  echo "No domain config returned"

putDomainConfig

Parameters

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

Antwoord

Retourneert: Option[GetDomainConfig_200_response]

Voorbeeld

putDomainConfig Voorbeeld

Copy

let updateParams = UpdateDomainConfigParams(
  allowAnonymous = false,
  moderationEnabled = true,
  allowedOrigins = @["https://news.example.com"],
  maxCommentLength = 2000
)
let (response, httpResponse) = client.putDomainConfig(
  tenantId = "my-tenant-123",
  domainToUpdate = "news/example-article",
  updateDomainConfigParams = updateParams
)
if response.isSome:
  let domainCfg = response.get()
  discard domainCfg

createEmailTemplate

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Respons

Geeft terug: Option[CreateEmailTemplate_200_response]

Voorbeeld

createEmailTemplate Voorbeeld

Copy

let (response, httpResponse) = client.createEmailTemplate(tenantId = "my-tenant-123", createEmailTemplateBody = CreateEmailTemplateBody(name = "Weekly Newsletter", subject = "Weekly updates from OurSite", fromName = "OurSite Team", fromEmail = "newsletter@oursite.com", bodyHtml = "<h1>Highlights</h1><p>Top stories this week...</p>", enabled = true, tags = @["newsletter", "weekly"]))
if response.isSome:
  let template = response.get()
  discard template

deleteEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteEmailTemplate Voorbeeld

Copy

let (response, httpResponse) = client.deleteEmailTemplate(tenantId = "my-tenant-123", id = "tmpl-456")
if response.isSome:
  let deleted = response.get()
  echo deleted

deleteEmailTemplateRenderError

Parameters

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

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteEmailTemplateRenderError Voorbeeld

Copy

let (response, httpResponse) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email-template",
  errorId = "render-error-2026"
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

getEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetEmailTemplate_200_response]

Voorbeeld

getEmailTemplate Voorbeeld

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email-01")
if response.isSome:
  let template = response.get()
  echo "Template ID: ", template.id
  echo "Subject: ", template.subject
  echo "Body: ", template.body

getEmailTemplateDefinitions

Parameters

Name	Type	Required	Description
tenantId	string	Ja

Respons

Retourneert: Option[GetEmailTemplateDefinitions_200_response]

Voorbeeld

getEmailTemplateDefinitions Voorbeeld

Copy

let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if response.isSome:
  let defs = response.get()
  echo "Received email template definitions for tenant my-tenant-123"
else:
  echo "No template definitions returned; HTTP status: ", httpResponse.status

getEmailTemplateRenderErrors

Parameters

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

Antwoord

Geeft terug: Option[GetEmailTemplateRenderErrors_200_response]

Voorbeeld

Voorbeeld van getEmailTemplateRenderErrors

Copy

let (response, httpResponse) = client.getEmailTemplateRenderErrors(tenantId = "my-tenant-123", id = "welcome-email-template-001", skip = 0.0)
if response.isSome:
  let result = response.get()
  echo "Render errors:", result
else:
  echo "No render errors or request failed. HTTP status:", httpResponse.status

getEmailTemplates

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Retourneert: Option[GetEmailTemplates_200_response]

Voorbeeld

Voorbeeld getEmailTemplates

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 templates returned"

renderEmailTemplate

Parameters

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

Antwoord

Retourneert: Option[RenderEmailTemplate_200_response]

Voorbeeld

renderEmailTemplate Voorbeeld

Copy

let renderBody = RenderEmailTemplateBody(templateId: "comment-notification", subject: "New comment on your article", variables: @["John Doe", "news/global-climate"])
let (response, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = renderBody, locale = "en-US")
if response.isSome:
  let rendered = response.get()
  echo rendered

updateEmailTemplate

Parameters

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

Respons

Geeft terug: Option[FlagCommentPublic_200_response]

Voorbeeld

updateEmailTemplate Voorbeeld

Copy

let updateBody = UpdateEmailTemplateBody(
  name = "Welcome Email",
  subject = "Welcome to Example News",
  html = "<p>Hi {name}, welcome to Example News.</p>",
  isActive = true,
  tags = @["onboarding", "welcome"]
)
let (response, httpResponse) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-template-2026",
  updateEmailTemplateBody = updateBody
)
if response.isSome:
  let template = response.get()
  discard template

getEventLog

Parameters

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

Respons

Retourneert: Option[GetEventLog_200_response]

Voorbeeld

getEventLog Voorbeeld

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64
)
if response.isSome:
  let eventLog = response.get()
  echo "Received event log for ", "my-tenant-123"
else:
  echo "No event log returned. HTTP status: ", $httpResponse.status

getGlobalEventLog

Parameters

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

Respons

Geeft terug: Option[GetEventLog_200_response]

Voorbeeld

getGlobalEventLog Voorbeeld

Copy

let (response, httpResponse) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = int64(0),
  endTime = int64(0)
)
if response.isSome:
  let eventLog = response.get()
  echo eventLog
else:
  echo "No event log returned"

createFeedPost

Parameters

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

Respons

Retourneert: Option[CreateFeedPost_200_response]

Voorbeeld

createFeedPost Voorbeeld

Copy

let createParams = CreateFeedPostParams(
  content = "We're rolling out realtime comments to all users!",
  title = "Realtime Comments Rollout",
  url = "news/realtime-comments-rollout-2025",
  authorId = "prod-team",
  tags = @["release", "comments"]
)
let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = createParams,
  broadcastId = "broadcast-2025-11",
  isLive = true,
  doSpamCheck = true,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  echo "Feed post created, id: ", $created.id
else:
  echo "Failed to create feed post, HTTP status: ", $httpResponse.statusCode

createFeedPostPublic

Parameters

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

Respons

Retourneert: Option[CreateFeedPostPublic_200_response]

Voorbeeld

createFeedPostPublic Voorbeeld

Copy

let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(
    title = "Product Launch Announcement",
    content = "We just launched a new commenting feature to improve engagement.",
    authorId = "team-product",
    url = "news/product-launch",
    tags = @["launch", "comments"],
    isFeatured = false
  ),
  broadcastId = "broadcast-009",
  sso = ""
)
if response.isSome:
  let created = response.get()
  discard created

deleteFeedPostPublic

Parameters

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

Respons

Retourneert: Option[DeleteFeedPostPublic_200_response]

Voorbeeld

deleteFeedPostPublic Voorbeeld

Copy

let (response, httpResponse) = client.deleteFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  broadcastId = "broadcast-789",
  sso = ""
)
if response.isSome:
  let result = response.get()

getFeedPosts

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
limit	int	Nee
tags	seq[string]	Nee

Antwoord

Retourneert: Option[GetFeedPosts_200_response]

Voorbeeld

getFeedPosts Voorbeeld

Copy

let (response, httpResponse) = client.getFeedPosts(tenantId = "my-tenant-123", afterId = "post_abc123", limit = 20, tags = @["news", "sports"])
if response.isSome:
  let feed = response.get()
  echo "Feed posts retrieved for tenant my-tenant-123"
else:
  echo "No feed posts returned, HTTP status: ", $httpResponse.status

getFeedPostsPublic

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

Antwoord

Retourneert: Option[GetFeedPostsPublic_200_response]

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()
  echo feed

getFeedPostsStats

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postIds	seq[string]	Nee
sso	string	Nee

Respons

Retourneert: Option[GetFeedPostsStats_200_response]

Voorbeeld

getFeedPostsStats Voorbeeld

Copy

let (response, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["news/article-2025-11-22", "opinion/market-trends-452"],
  sso = ""
)
if response.isSome:
  let stats = response.get()
  discard stats

getUserReactsPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postIds	seq[string]	Nee
sso	string	Nee

Antwoord

Retourneert: Option[GetUserReactsPublic_200_response]

Voorbeeld

getUserReactsPublic Voorbeeld

Copy

let (response, httpResponse) = client.getUserReactsPublic(tenantId = "my-tenant-123", postIds = @[], sso = "")
if response.isSome:
  let reacts = response.get()
  discard reacts

reactFeedPostPublic

Parameters

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

Respons

Geeft terug: Option[ReactFeedPostPublic_200_response]

Voorbeeld

reactFeedPostPublic Voorbeeld

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-title",
  reactBodyParams = ReactBodyParams(),
  isUndo = false,
  broadcastId = "broadcast-456",
  sso = ""
)
if response.isSome:
  let result = response.get()
  echo "Reaction result: ", result
else:
  echo "Reaction failed, HTTP response: ", httpResponse

updateFeedPost

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateFeedPost Voorbeeld

Copy

let feedPost = FeedPost(
  title: "Local Election Results",
  content: "Updated vote counts across precincts",
  tags: @["politics", "local"],
  authorId: "journalist-32",
  isPublished: true,
  views: 124
)
let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

updateFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Nee
updateFeedPostParams	UpdateFeedPostParams	Nee
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: Option[CreateFeedPostPublic_200_response]

Voorbeeld

Voorbeeld updateFeedPostPublic

Copy

var updateParams: UpdateFeedPostParams = UpdateFeedPostParams(
  title = "Breaking: Service Update",
  content = "We improved feed performance and UX for all users.",
  tags = @["performance", "release"],
  isPublic = true
)
let (response, httpResponse) = client.updateFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "post-456",
  updateFeedPostParams = updateParams,
  broadcastId = "broadcast-789",
  sso = "sso-token-abc123"
)
if response.isSome:
  let post = response.get()
  echo "Updated post title: ", post.title
  echo "HTTP status: ", httpResponse.status

flagCommentPublic

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

flagCommentPublic Voorbeeld

Copy

let (response, httpResponse) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  isFlagged = false,
  sso = ""
)
if response.isSome:
  let flagResult = response.get()
  discard flagResult

addHashTag

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createHashTagBody	CreateHashTagBody	Nee

Respons

Retourneert: Option[AddHashTag_200_response]

Voorbeeld

addHashTag Voorbeeld

Copy

let createBody = CreateHashTagBody(
  name = "sports",
  description = "Articles and discussions about sports",
  aliases = @["sport", "athletics"],
  isActive = true
)
let (response, httpResponse) = client.addHashTag(tenantId = "my-tenant-123", createHashTagBody = createBody)
if response.isSome:
  let added = response.get()
  echo "HashTag added successfully"
else:
  echo "Failed to add HashTag"

addHashTagsBulk

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nee

Respons

Retourneert: Option[AddHashTagsBulk_200_response]

Voorbeeld

addHashTagsBulk Voorbeeld

Copy

let bulkBody = BulkCreateHashTagsBody(
  tags = @["breaking", "world-news", "economy"],
  createdBy = "editor@dailynews.com",
  replaceExisting = false
)
let (response, httpResponse) = client.addHashTagsBulk(tenantId = "newsroom-tenant-42", bulkCreateHashTagsBody = bulkBody)
if response.isSome:
  let created = response.get()
  echo created
else:
  echo "AddHashTagsBulk failed:", httpResponse

deleteHashTag

Parameters

Naam	Type	Vereist
tag	string	Nee
tenantId	string	Ja
deleteHashTagRequest	DeleteHashTagRequest	Nee

Respons

Geeft terug: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteHashTag Voorbeeld

Copy

let (response, httpResponse) = client.deleteHashTag(tag = "breaking-news", tenantId = "my-tenant-123", deleteHashTagRequest = DeleteHashTagRequest())
if response.isSome:
  let result = response.get()
  discard result

getHashTags

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
page	float64	Nee

Respons

Retourneert: Option[GetHashTags_200_response]

Voorbeeld

getHashTags Voorbeeld

Copy

let (response, httpResponse) = client.getHashTags(tenantId = "my-tenant-123", page = 1.0)
if response.isSome:
  let tags = response.get()
  for t in tags:
    echo t
else:
  echo "no hashtags found"

patchHashTag

Parameters

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

Respons

Retourneert: Option[PatchHashTag_200_response]

Voorbeeld

patchHashTag Voorbeeld

Copy

let (response, httpResponse) = client.patchHashTag(tag = "politics", tenantId = "my-tenant-123", updateHashTagBody = UpdateHashTagBody())
if response.isSome:
  let updated = response.get()
  echo "Hashtag updated successfully"
else:
  echo "Failed to update hashtag, status:", httpResponse.status

createModerator

Parameters

Name	Type	Vereist	Beschrijving
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Nee

Respons

Retourneert: Option[CreateModerator_200_response]

Voorbeeld

createModerator Voorbeeld

Copy

let createBody = CreateModeratorBody(
  email = "moderator@news-site.com",
  displayName = "News Moderator",
  permissions = @["approve_comments", "delete_comments"],
  isSuperAdmin = false
)
let (response, httpResponse) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = createBody)
if response.isSome:
  let moderator = response.get()
  echo "Created moderator: ", $moderator

deleteModerator

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteModerator Voorbeeld

Copy

let (response, httpResponse) = client.deleteModerator(tenantId = "my-tenant-123", id = "moderator-456", sendEmail = "false")
if response.isSome:
  let flagResp = response.get()
  echo "Moderator deletion response: ", $flagResp
else:
  echo "No response body; HTTP status: ", $httpResponse.status

getModerator

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[GetModerator_200_response]

Voorbeeld

getModerator Voorbeeld

Copy

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

getModerators

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Retourneert: Option[GetModerators_200_response]

Voorbeeld

getModerators Voorbeeld

Copy

let (response, httpResponse) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let moderators = response.get()
  echo "Moderators fetched successfully"
  echo moderators

updateModerator

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateModerator Voorbeeld

Copy

let updateBody = UpdateModeratorBody(
  name: "Alicia Gomez",
  email: "alicia.gomez@dailynews.com",
  active: true,
  roles: @["moderator"]
)
let (response, httpResponse) = client.updateModerator(tenantId = "my-tenant-123", id = "moderator-789", updateModeratorBody = updateBody)
if response.isSome:
  let updated = response.get()
  echo "Moderator updated:", updated

deleteNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteNotificationCount Voorbeeld

Copy

let (response, httpResponse) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if response.isSome:
  let deleted = response.get()
  echo "Deleted notification count:", deleted
else:
  echo "No response body; HTTP response:", httpResponse

getCachedNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[GetCachedNotificationCount_200_response]

Voorbeeld

getCachedNotificationCount Voorbeeld

Copy

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

getNotificationCount

Parameters

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

Respons

Geeft terug: Option[GetNotificationCount_200_response]

Voorbeeld

getNotificationCount Voorbeeld

Copy

let (response, httpResponse) = client.getNotificationCount(
  tenantId = "acme-corp-tenant-12",
  userId = "user-84",
  urlId = "news/2026/market-update",
  fromCommentId = "cmt-20251234",
  viewed = false
)
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data"
else:
  echo "No notification data"

getNotifications

Parameters

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

Respons

Retourneert: Option[GetNotifications_200_response]

Voorbeeld

getNotifications Voorbeeld

Copy

let (response, httpResponse) = client.getNotifications(
  tenantId = "fastcomments-tenant-42",
  userId = "",
  urlId = "news/latest-tech-innovations",
  fromCommentId = "",
  viewed = false,
  skip = 0.0
)
if response.isSome:
  let notifications = response.get()
  echo "Received notifications: ", notifications
else:
  echo "No notifications, response: ", httpResponse

updateNotification

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateNotification Voorbeeld

Copy

let (response, httpResponse) = client.updateNotification(tenantId = "my-tenant-123",
  id = "notif-456",
  updateNotificationBody = UpdateNotificationBody(),
  userId = "user-789")
if response.isSome:
  let updated = response.get()
  echo "Updated notification id: ", $updated

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

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

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

Response

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deletePendingWebhookEvent Voorbeeld

Copy

let (response, httpResponse) = client.deletePendingWebhookEvent(tenantId = "my-tenant-123", id = "wh_evt_6f1e3b2a")
if response.isSome:
  let flagResp = response.get()
  discard flagResp

getPendingWebhookEventCount

Parameters

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

Antwoord

Geeft terug: Option[GetPendingWebhookEventCount_200_response]

Voorbeeld

getPendingWebhookEventCount Voorbeeld

Copy

let (response, httpResponse) = client.getPendingWebhookEventCount(
  tenantId = "my-tenant-123",
  commentId = "cmt-4567",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0
)
if response.isSome:
  let pending = response.get()
  echo "Received pending webhook event count response: ", $pending
else:
  echo "No pending webhook event count returned, HTTP response: ", $httpResponse

getPendingWebhookEvents

Parameters

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

Antwoord

Geeft terug: Option[GetPendingWebhookEvents_200_response]

Voorbeeld

getPendingWebhookEvents Voorbeeld

Copy

let (response, httpResponse) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0,
  skip = 0.0
)
if response.isSome:
  let pending = response.get()
  discard pending
  echo "Received pending webhook events"
else:
  echo "No pending webhook events"

createQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nee

Antwoord

Retourneert: Option[CreateQuestionConfig_200_response]

Voorbeeld

createQuestionConfig Voorbeeld

Copy

let body = CreateQuestionConfigBody(
  key = "recommendation",
  question = "Would you recommend this article to a friend?",
  required = false,
  inputType = "radio",
  options = @["Yes", "No", "Maybe"]
)
let (response, httpResponse) = client.createQuestionConfig(tenantId = "my-tenant-123", createQuestionConfigBody = body)
if response.isSome:
  let config = response.get()
  discard config

deleteQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteQuestionConfig Voorbeeld

Copy

let (response, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-456")
if response.isSome:
  let respVal = response.get()
  echo "Delete succeeded for tenant my-tenant-123"
else:
  echo "Delete returned no data (status: ", $httpResponse.status, ")"

getQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetQuestionConfig_200_response]

Voorbeeld

getQuestionConfig Voorbeeld

Copy

let (response, httpResponse) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-98765")
if response.isSome:
  let config = response.get()
  echo "Received question config for tenant:", " my-tenant-123"

getQuestionConfigs

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Antwoord

Retourneert: Option[GetQuestionConfigs_200_response]

Voorbeeld

getQuestionConfigs Voorbeeld

Copy

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

updateQuestionConfig

Parameters

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

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateQuestionConfig Voorbeeld

Copy

let (response, httpResponse) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "q-config-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if response.isSome:
  let updated = response.get()
  discard updated
  echo "Question config updated"
else:
  echo "Update did not return a result"

createQuestionResult

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nee

Respons

Geeft terug: Option[CreateQuestionResult_200_response]

Voorbeeld

createQuestionResult Voorbeeld

Copy

let (response, httpResponse) = client.createQuestionResult(tenantId = "my-tenant-123",
  createQuestionResultBody = CreateQuestionResultBody(questionId: "q-456",
    userId: "user-789",
    correct: true,
    score: 9,
    answers: @["B", "D"]))
if response.isSome:
  let result = response.get()
  echo result

deleteQuestionResult

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteQuestionResult Voorbeeld

Copy

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

getQuestionResult

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[GetQuestionResult_200_response]

Voorbeeld

getQuestionResult Voorbeeld

Copy

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

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

Respons

Geeft terug: Option[GetQuestionResults_200_response]

Voorbeeld

getQuestionResults Voorbeeld

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userId = "user-9876",
  startDate = "2024-01-01T00:00:00Z",
  questionId = "q-user-satisfaction",
  questionIds = "q-user-satisfaction,q-engagement",
  skip = 0.0
)
if response.isSome:
  let results = response.get()
  echo "Got question results: ", $results
else:
  echo "No results, HTTP status: ", httpResponse.status

updateQuestionResult

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateQuestionResult Voorbeeld

Copy

let (response, httpResponse) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody(
    result = "approved",
    reviewerId = "moderator-42",
    notes = "Valid question, no action required",
    isSpam = false
  )
)
if response.isSome:
  let flagResponse = response.get()
  discard flagResponse

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[AggregateQuestionResults_200_response]

Voorbeeld

aggregateQuestionResults Voorbeeld

Copy

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

bulkAggregateQuestionResults

Parameters

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

Respons

Geeft terug: Option[BulkAggregateQuestionResults_200_response]

Voorbeeld

bulkAggregateQuestionResults Voorbeeld

Copy

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

combineCommentsWithQuestionResults

Parameters

Name	Type	Required
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

Response

Retourneert: Option[CombineCommentsWithQuestionResults_200_response]

Voorbeeld

combineCommentsWithQuestionResults Voorbeeld

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "q-9876",
  questionIds = @["q-9876", "q-9877"],
  urlId = "news/article-title",
  startDate = "2025-01-01T00:00:00Z",
  forceRecalculate = false,
  minValue = 1.0,
  maxValue = 5.0,
  limit = 100.0
)
if response.isSome:
  let combined = response.get()
  discard combined

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

Antwoord

Retourneert: Option[GetSSOUsers_200_response]

Voorbeeld

getSSOUsers Voorbeeld

Copy

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

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

getTenantDailyUsages

Parameters

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

Respons

Geeft terug: Option[GetTenantDailyUsages_200_response]

Voorbeeld

getTenantDailyUsages Voorbeeld

Copy

let (response, httpResponse) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  yearNumber = 2025.0,
  monthNumber = 6.0,
  dayNumber = 15.0,
  skip = 0.0
)
if response.isSome:
  let usages = response.get()
  echo usages
else:
  echo "No daily usages returned"

createTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nee

Reactie

Retourneert: Option[CreateTenantPackage_200_response]

Voorbeeld

createTenantPackage Voorbeeld

Copy

let packageBody = CreateTenantPackageBody(
  packageName = "premium-comments",
  description = "Premium moderation package for news site",
  planId = "plan-pro-2024",
  seats = 100,
  enabled = true,
  features = @["moderation", "analytics", "sentiment"]
)
let (response, httpResponse) = client.createTenantPackage(tenantId = "my-tenant-123", createTenantPackageBody = packageBody)
if response.isSome:
  let pkg = response.get()
  echo "Created package ID: ", pkg.packageId
  echo "Package name: ", pkg.packageName
else:
  echo "Failed to create package, HTTP status: ", httpResponse.status.code

deleteTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteTenantPackage Voorbeeld

Copy

let (response, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-789")
if response.isSome:
  let deleted = response.get()
  echo "Successfully deleted tenant package"

getTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Retourneert: Option[GetTenantPackage_200_response]

Voorbeeld

getTenantPackage Voorbeeld

Copy

let (response, httpResponse) = client.getTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium-001")
if response.isSome:
  let pkg = response.get()
  echo pkg
else:
  echo "No package found for tenant"

getTenantPackages

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Antwoord

Retourneert: Option[GetTenantPackages_200_response]

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 packages for tenant:", " my-tenant-123"
  echo packages
else:
  echo "No packages found, status:", httpResponse.status

replaceTenantPackage

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

replaceTenantPackage Voorbeeld

Copy

let replaceBody = ReplaceTenantPackageBody(
  packageName = "Community Pro",
  seats = 500,
  enableModeration = true,
  features = @["moderation", "analytics", "single-sign-on"]
)
let (response, httpResponse) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "community-pro",
  replaceTenantPackageBody = replaceBody
)
if response.isSome:
  let flagResp = response.get()
  echo "Package replaced for tenant: ", "my-tenant-123"
  discard flagResp

updateTenantPackage

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateTenantPackage Voorbeeld

Copy

let (response, httpResponse) = client.updateTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium", updateTenantPackageBody = UpdateTenantPackageBody())
if response.isSome:
  let updated = response.get()
  echo "Updated package received:", updated
else:
  echo "Update failed, HTTP status: ", httpResponse.status

createTenantUser

Parameters

Name	Type	Required	Description
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Nee

Response

Retourneert: Option[CreateTenantUser_200_response]

Voorbeeld

createTenantUser Voorbeeld

Copy

let createBody = CreateTenantUserBody(
  email = "jane.doe@acmepub.com",
  displayName = "Jane Doe",
  password = "S3cur3P@ssw0rd",
  roles = @["moderator", "editor"],
  disabled = false
)
let (response, httpResponse) = client.createTenantUser(tenantId = "my-tenant-123", createTenantUserBody = createBody)
if response.isSome:
  let createdUser = response.get()
  echo createdUser

deleteTenantUser

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteTenantUser Voorbeeld

Copy

let (response, httpResponse) = client.deleteTenantUser(tenantId = "my-tenant-123", id = "user-456", deleteComments = "", commentDeleteMode = "")
if response.isSome:
  let flagResp = response.get()
  echo flagResp

getTenantUser

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetTenantUser_200_response]

Voorbeeld

getTenantUser Voorbeeld

Copy

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

getTenantUsers

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	float64	Nee

Respons

Retourneert: Option[GetTenantUsers_200_response]

Voorbeeld

getTenantUsers Voorbeeld

Copy

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

replaceTenantUser

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Nee
replaceTenantUserBody	ReplaceTenantUserBody	Nee
updateComments	string	Nee

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

replaceTenantUser Voorbeeld

Copy

let replaceBody = ReplaceTenantUserBody(name: "Jane Doe", email: "jane.doe@example.com", roles: @["moderator", "contributor"], banned: false)
let (response, httpResponse) = client.replaceTenantUser(tenantId = "my-tenant-123", id = "user-789", replaceTenantUserBody = replaceBody, updateComments = "true")
if response.isSome:
  let updated = response.get()
  echo updated
else:
  echo "No response returned"

sendLoginLink

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

sendLoginLink Voorbeeld

Copy

let (response, httpResponse) = client.sendLoginLink(tenantId = "fastcomments-tenant-42", id = "user-9876", redirectURL = "https://news.example.com/articles/2026/fastcomments-login")
if response.isSome:
  let loginResp = response.get()
  echo "Login link sent successfully"
else:
  echo "Failed to send login link"

updateTenantUser

Parameters

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

Response

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateTenantUser Voorbeeld

Copy

var body: UpdateTenantUserBody
body.email = "jane.doe@example.com"
body.displayName = "Jane Doe"
body.roles = @["moderator", "editor"]
body.isActive = true
let (response, httpResponse) = client.updateTenantUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateTenantUserBody = body,
  updateComments = "Promoted user to moderator and editor roles"
)
if response.isSome:
  let flagResp = response.get()
  echo flagResp
else:
  echo "Update failed, status: ", httpResponse.status

createTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantBody	CreateTenantBody	Nee

Respons

Retourneert: Option[CreateTenant_200_response]

Voorbeeld

createTenant Voorbeeld

Copy

let (response, httpResponse) = client.createTenant(tenantId = "my-tenant-123", createTenantBody = CreateTenantBody(
  name: "My Tenant 123",
  domain: "mytenant.example.com",
  plan: "pro",
  isActive: true,
  allowedOrigins: @["https://www.example.com", "https://admin.example.com"]
))
if response.isSome:
  let tenantInfo = response.get()
  discard tenantInfo

deleteTenant

Parameters

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

Respons

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

deleteTenant Voorbeeld

Copy

let (response, httpResponse) = client.deleteTenant(tenantId = "my-tenant-123", id = "", sure = "")
if response.isSome:
  let flagResp = response.get()
  echo "Tenant deletion response received for tenant: ", "my-tenant-123"
  discard flagResp
else:
  echo "No response body returned for tenant deletion"

getTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Geeft terug: Option[GetTenant_200_response]

Voorbeeld

getTenant Voorbeeld

Copy

let (response, httpResponse) = client.getTenant(tenantId = "my-tenant-123", id = "")
if response.isSome:
  let tenant = response.get()
  echo "Tenant retrieved"
  discard tenant
else:
  echo "No tenant found"
  echo "HTTP status:", httpResponse.status

getTenants

Parameters

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

Respons

Retourneert: Option[GetTenants_200_response]

Voorbeeld

getTenants Voorbeeld

Copy

let (response, httpResponse) = client.getTenants(tenantId = "my-tenant-123", meta = "include=details", skip = 0.0)
if response.isSome:
  let tenants = response.get()
  echo "Received tenants: ", repr(tenants)
else:
  echo "Failed to retrieve tenants"

updateTenant

Parameters

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

Antwoord

Retourneert: Option[FlagCommentPublic_200_response]

Voorbeeld

updateTenant Voorbeeld

Copy

let (response, httpResponse) = client.updateTenant(
  tenantId = "my-tenant-123",
  id = "tenant-456",
  updateTenantBody = UpdateTenantBody()
)
if response.isSome:
  let flagResponse = response.get()
  echo flagResponse
else:
  echo "No body returned; HTTP status: ", httpResponse.status

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	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetUserBadgeProgressById_200_response]

Voorbeeld

getUserBadgeProgressById Voorbeeld

Copy

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

getUserBadgeProgressByUserId

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
userId	string	No

Respons

Retourneert: Option[GetUserBadgeProgressById_200_response]

Voorbeeld

Voorbeeld van getUserBadgeProgressByUserId

Copy

let (response, httpResponse) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if response.isSome:
  let badgeProgress = response.get()
  echo "Badge progress retrieved for user-456"
else:
  echo "No badge progress found, HTTP status: ", $httpResponse.status

getUserBadgeProgressList

Parameters

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

Respons

Geeft terug: Option[GetUserBadgeProgressList_200_response]

Voorbeeld

getUserBadgeProgressList Voorbeeld

Copy

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

createUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nee

Respons

Retourneert: Option[CreateUserBadge_200_response]

Voorbeeld

createUserBadge Voorbeeld

Copy

let (response, httpResponse) = client.createUserBadge(tenantId = "my-tenant-123",
  createUserBadgeParams = CreateUserBadgeParams(userId = "user-987", badgeId = "top-commenter"))
if response.isSome:
  let createdBadge = response.get()
  echo "Created badge for user: ", createdBadge.userId
else:
  echo "Failed to create badge, status: ", $httpResponse.status

deleteUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Antwoord

Geeft terug: Option[UpdateUserBadge_200_response]

Voorbeeld

deleteUserBadge Voorbeeld

Copy

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

getUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Respons

Retourneert: Option[GetUserBadge_200_response]

Voorbeeld

getUserBadge Voorbeeld

Copy

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

getUserBadges

Parameters

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

Antwoord

Retourneert: Option[GetUserBadges_200_response]

Voorbeeld

getUserBadges Voorbeeld

Copy

let (response, httpResponse) = client.getUserBadges(
  tenantId = "my-tenant-123",
  userId = "user-789",
  badgeId = "top-commenter",
  displayedOnComments = true,
  limit = 50.0,
  skip = 0.0
)
if response.isSome:
  let badges = response.get()
  echo "Retrieved badges: ", $badges

updateUserBadge

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Nee
updateUserBadgeParams	UpdateUserBadgeParams	Nee

Response

Retourneert: Option[UpdateUserBadge_200_response]

Voorbeeld

updateUserBadge Voorbeeld

Copy

let updateParams = UpdateUserBadgeParams(
  name = "Top Contributor",
  description = "Awarded for consistent high-quality comments",
  active = true,
  tags = @["community", "milestone"]
)
let (response, httpResponse) = client.updateUserBadge(tenantId = "my-tenant-123", id = "badge-456", updateUserBadgeParams = updateParams)
if response.isSome:
  let updated = response.get()
  echo "Badge updated successfully"
else:
  echo "Failed to update badge, HTTP status: ", $httpResponse.status

getUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
sso	string	No

Antwoord

Retourneert: Option[GetUserNotificationCount_200_response]

Voorbeeld

getUserNotificationCount Voorbeeld

Copy

let (response, httpResponse) = client.getUserNotificationCount(tenantId = "my-tenant-123", sso = "")
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data: ", $notificationData
else:
  echo "No notification data returned. HTTP response: ", $httpResponse.status

getUserNotifications

Parameters

Naam	Type	Vereist
tenantId	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
sso	string	Nee

Respons

Retourneert: Option[GetUserNotifications_200_response]

Voorbeeld

getUserNotifications Voorbeeld

Copy

let (response, httpResponse) = client.getUserNotifications(
  tenantId = "my-tenant-123",
  pageSize = 50,
  afterId = "notif_9a1b2c3d",
  includeContext = true,
  afterCreatedAt = int64(1699999999000),
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  includeTranslations = false,
  sso = ""
)
if response.isSome:
  let notifications = response.get()
  discard notifications
else:
  discard httpResponse

resetUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string	Nee

Antwoord

Retourneert: Option[ResetUserNotifications_200_response]

Voorbeeld

resetUserNotificationCount Voorbeeld

Copy

let (response, httpResponse) = client.resetUserNotificationCount(tenantId = "my-tenant-123", sso = "sso-jwt-9a8b7c6d")
if response.isSome:
  let resetResult = response.get()
  echo resetResult
else:
  echo "Reset failed, status: ", httpResponse.status

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

Geeft terug: Option[ResetUserNotifications_200_response]

Voorbeeld

resetUserNotifications Voorbeeld

Copy

let (response, httpResponse) = client.resetUserNotifications(
  tenantId = "my-tenant-123",
  afterId = "",
  afterCreatedAt = int64(0),
  unreadOnly = false,
  dmOnly = false,
  noDm = false,
  sso = ""
)
if response.isSome:
  let result = response.get()

updateUserNotificationCommentSubscriptionStatus

Parameters

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

Antwoord

Retourneert: Option[UpdateUserNotificationStatus_200_response]

Voorbeeld

updateUserNotificationCommentSubscriptionStatus Voorbeeld

Copy

let (response, httpResponse) = client.updateUserNotificationCommentSubscriptionStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  optedInOrOut = "opted_in",
  commentId = "cmt-789",
  sso = "sso-token-abc"
)
if response.isSome:
  let updatedStatus = response.get()
  discard updatedStatus
else:
  discard httpResponse

updateUserNotificationPageSubscriptionStatus

Parameters

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

Respons

Retourneert: Option[UpdateUserNotificationStatus_200_response]

Voorbeeld

updateUserNotificationPageSubscriptionStatus Voorbeeld

Copy

let (response, httpResponse) = client.updateUserNotificationPageSubscriptionStatus(
  tenantId = "my-tenant-123",
  urlId = "news/article-2025-11-22",
  url = "https://example.com/news/article-2025-11-22",
  pageTitle = "Breaking News: Market Update",
  subscribedOrUnsubscribed = "subscribed",
  sso = "sso-token-abc123"
)
if response.isSome:
  let result = response.get()
  discard result

updateUserNotificationStatus

Parameters

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

Respons

Retourneert: Option[UpdateUserNotificationStatus_200_response]

Voorbeeld

updateUserNotificationStatus Voorbeeld

Copy

let (response, httpResponse) = client.updateUserNotificationStatus(
  tenantId = "my-tenant-123",
  notificationId = "notif-456",
  newStatus = "read",
  sso = "sso-abc-789"
)
if response.isSome:
  let updateResp = response.get()
  discard updateResp

getUserPresenceStatuses

Parameters

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

Antwoord

Retourneert: Option[GetUserPresenceStatuses_200_response]

Voorbeeld

getUserPresenceStatuses Voorbeeld

Copy

let (response, httpResponse) = client.getUserPresenceStatuses(
  tenantId = "my-tenant-123",
  urlIdWS = "news/2025/technology/ai-ethics",
  userIds = "user-789,user-456"
)
if response.isSome:
  let presence = response.get()
  echo "Presence received: ", presence
else:
  echo "No presence information returned, HTTP status: ", httpResponse.status.code

searchUsers

Parameteren

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Nee
mentionGroupIds	seq[string]	Nee
sso	string	Nee

Respons

Retourneert: Option[SearchUsers_200_response]

Voorbeeld

searchUsers Voorbeeld

Copy

let (response, httpResponse) = client.searchUsers(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  usernameStartsWith = "jo",
  mentionGroupIds = @["editors", "sports-team"],
  sso = "sso-abc-456"
)
if response.isSome:
  let users = response.get()
  echo "Users found: ", users
else:
  echo "No users found; HTTP status: ", httpResponse.status

getUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Nee

Response

Retourneert: Option[GetUser_200_response]

Voorbeeld

getUser Voorbeeld

Copy

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

createVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
direction	string	Nee
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: Option[VoteComment_200_response]

Voorbeeld

createVote Voorbeeld

Copy

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

deleteVote

Parameters

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

Antwoord

Geeft terug: Option[DeleteCommentVote_200_response]

Voorbeeld

deleteVote Voorbeeld

Copy

let (response, httpResponse) = client.deleteVote(tenantId = "my-tenant-123", id = "", editKey = "")
if response.isSome:
  let deleted = response.get()
  discard deleted

getVotes

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
urlId	string	Yes

Antwoord

Retourneert: Option[GetVotes_200_response]

Voorbeeld

getVotes Voorbeeld

Copy

let (response, httpResponse) = client.getVotes(tenantId = "my-tenant-123", urlId = "news/2026/major-update")
if response.isSome:
  let votes = response.get()
  discard votes
else:
  discard httpResponse

getVotesForUser

Parameters

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

Response

Retourneert: Option[GetVotesForUser_200_response]

Voorbeeld

getVotesForUser Voorbeeld

Copy

let (response, httpResponse) = client.getVotesForUser(
  tenantId = "my-tenant-123",
  urlId = "news/economy-update-2026",
  userId = "user-789",
  anonUserId = ""
)
if response.isSome:
  let votes = response.get()
  discard votes

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

Audit-logboeken

Blokkeren van reactie

Geblokkeerde reacties controleren

Reacties

Domeinconfiguraties

E-mailsjablonen

Gebeurtenislogboek

Feedberichten

Reactie markeren

Hashtags

Moderators

Aantal meldingen

Meldingen

Pagina's

Openstaande webhookgebeurtenissen

Vraagconfiguraties

Vraagresultaten

Aggregeren van vraagresultaten

SSO-gebruikers

Abonnementen

Dagelijks gebruik tenant

Tenantpakketten

Tenantgebruikers

Tenants

Afbeelding uploaden

Voortgang gebruikersbadge

Gebruikersbadges

Gebruikersmeldingen

Aanwezigheidsstatus gebruikers

Gebruiker zoeken

Gebruikers

Stemmen

FastComments Nim SDK

Repository

Vereisten

Installatie

Nimble gebruiken

Bouwen vanuit de bron

Inhoud van de bibliotheek

Openbare vs beveiligde API's

Snel aan de slag

Gebruik van geauthenticeerde API's (DefaultAPI)

Gebruik van openbare API's (PublicAPI)

Veelvoorkomende problemen

API-aanroepen maken

Voorbeeld: Reacties ophalen

Notities

Broadcast-id's

SSO (Single Sign-On)

SSO-gebruik

Eenvoudige SSO

Beveiligde SSO

Documentatie voor fastcomments

Documentatie voor fastcomments

Documentatie voor API-eindpunten

Documentatie voor modellen

Documentatie voor autorisatie

api_key

aggregate

Parameters

Respons

Voorbeeld

getAuditLogs

Parameters

Response

Voorbeeld

blockFromCommentPublic

Parameters

Respons

Voorbeeld

unBlockCommentPublic

Parameters

Antwoord

Voorbeeld