FastComments Nim SDK

Dies ist das offizielle Nim-SDK für FastComments.

Offizielles Nim-SDK für die FastComments-API

Repository

Voraussetzungen

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installation

Verwendung von Nimble

nimble install fastcomments

Aus dem Quellcode bauen

nimble build

Inhalt der Bibliothek

Diese Bibliothek enthält den generierten API-Client und die SSO-Dienstprogramme, um die Arbeit mit der API zu vereinfachen.

Dokumentation der API-Client-Bibliothek

Öffentliche vs. gesicherte APIs

Für den API-Client gibt es drei API-Module, api_default, api_public, und api_moderation. Das api_default enthält Methoden, die Ihren API-Schlüssel erfordern, und api_public enthält API-Aufrufe die direkt aus einem Browser/mobilem Gerät/etc. ohne Authentifizierung ausgeführt werden können. Das api_moderation-Modul enthält Methoden für das Moderatoren-Dashboard.

Die api_moderation-Methoden decken das Auflisten, Zählen, Suchen und Exportieren von Kommentaren und deren Protokollen ab; Moderationsaktionen wie Entfernen/Wiederherstellen von Kommentaren, Markieren, Festlegen des Review-/Spam-/Genehmigungsstatus, Anpassen von Stimmen und Wiederöffnen/Schließen von Threads; Sperren (einen Benutzer von einem Kommentar sperren, eine Sperre rückgängig machen, Vor-Sperr-Zusammenfassungen, Sperrstatus und -einstellungen sowie Anzahl gesperrter Benutzer); und Abzeichen & Vertrauen (Verleihen/Entfernen eines Abzeichens, Auflisten manueller Abzeichen, Abrufen/Setzen des Vertrauensfaktors eines Benutzers und Abrufen des internen Profils eines Benutzers). Jede api_moderation-Methode akzeptiert einen sso-Parameter, sodass der Aufruf als SSO-Moderator authentifiziert wird.

Schnellstart

Verwendung authentifizierter APIs (DefaultAPI)

Wichtig: Authentifizierte Endpunkte erfordern, dass Ihr API-Schlüssel als Header x-api-key gesetzt ist.

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"

# Authentifizierte API-Aufrufe durchführen
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"

Verwendung öffentlicher APIs (PublicAPI)

Öffentliche Endpunkte erfordern keine Authentifizierung:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Öffentliche API-Aufrufe durchführen
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"

Verwendung der Moderations-APIs (ModerationAPI)

Moderations-Endpunkte versorgen das Moderatoren-Dashboard und werden mit einem SSO-Token für den handelnden Moderator authentifiziert:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Kommentare im Moderations-Dashboard auflisten
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Häufige Probleme

401-Authentifizierungsfehler: Stellen Sie sicher, dass Sie den Header x-api-key auf Ihrem HttpClient setzen, bevor Sie DefaultAPI-Anfragen stellen: client.headers["x-api-key"] = "your-api-key"
Falsche API-Klasse: Verwenden Sie api_default für serverseitige authentifizierte Anfragen, api_public für clientseitige/öffentliche Anfragen, und api_moderation für Anfragen des Moderations-Dashboards.

API-Aufrufe

Alle API-Methoden in diesem SDK geben Tupel von (Option[ResponseType], Response) zurück. Das erste Element enthält die geparste Antwort, falls erfolgreich, und das zweite Element ist die rohe HTTP-Antwort.

Beispiel: Kommentare abrufen

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"

Hinweise

Broadcast-IDs

Sie werden sehen, dass Sie in einigen API-Aufrufen ein broadcastId übergeben sollen. Wenn Sie Ereignisse erhalten, bekommen Sie diese ID zurück, sodass Sie das Ereignis ignorieren können, falls Sie Änderungen optimistisch auf dem Client anwenden möchten (was Sie wahrscheinlich tun werden, da es die beste Nutzererfahrung bietet). Übergeben Sie hier eine UUID. Die ID sollte eindeutig genug sein, um in einer Browsersitzung nicht zweimal aufzutreten.

SSO (Single Sign-On)

Für SSO-Beispiele siehe unten.

SSO-Verwendung

Einfaches 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

Sicheres SSO

import fastcomments/sso

let user = newSecureSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  username = "johndoe",
  avatar = "https://example.com/avatar.jpg"
)

let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()

echo "Secure SSO Token: ", token

Dokumentation für FastComments

Dokumentation der API-Endpunkte

Alle URIs sind relativ zu https://fastcomments.com

Klasse	Methode	HTTP-Anfrage	Beschreibung
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregiert Dokumente, indem sie gruppiert werden (wenn groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg, etc.) werden unterstützt.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	benötigt tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	benötigt tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	benötigt tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	benötigt tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	benötigt tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Frühere Kommentatoren der Seite, die AKTUELL NICHT online sind. Sortiert nach displayName. Verwenden Sie dies, nachdem Sie /users/online ausgeschöpft haben, um einen „Mitglieder“-Abschnitt darzustellen. Cursor-Paginierung nach commenterName: Der Server durchsucht den partiellen {tenantId, urlId, commenterName}-Index vorwärts von afterName via $gt, kein $skip-Kosten.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Aktuell online Besucher einer Seite: Personen, deren Websocket-Sitzung derzeit auf die Seite abonniert ist. Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Zuschauer, die nicht einzeln aufgeführt werden).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Listet Seiten für einen Tenant auf. Wird vom FChat Desktop-Client verwendet, um seine Raumliste zu befüllen. Erfordert `enableFChat` als true in der aufgelösten benutzerdefinierten Konfiguration für jede Seite. Seiten, die SSO erfordern, werden anhand des Gruppen-Zugriffs des anfragenden Benutzers gefiltert.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Benutzerinformationen in großer Menge für einen Tenant. Gegeben userIds, werden Anzeigedaten aus User / SSOUser zurückgegeben. Wird vom Kommentar-Widget verwendet, um Benutzer anzureichern, die gerade durch ein Präsenz-Ereignis erschienen sind. Kein Seitenkontext: Privatsphäre wird einheitlich durchgesetzt (private Profile werden maskiert).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Aktiviert oder deaktiviert Benachrichtigungen für einen bestimmten Kommentar.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Aktiviert oder deaktiviert Benachrichtigungen für eine Seite. Wenn Benutzer eine Seite abonniert haben, werden Benachrichtigungen für neue Wurzelkommentare erstellt und ebenfalls
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Bild hochladen und skalieren
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentation der Modelle

aggregate

Fasst Dokumente zusammen, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
aggregationRequest	AggregationRequest	Nein
parentTenantId	string	Nein
includeStats	bool	Nein

Antwort

Gibt zurück: Option[AggregateResponse]

Beispiel

aggregate Beispiel

Copy

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

getAuditLogs

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
limit	float64	Nein
skip	float64	Nein
order	SORTDIR	Nein
after	float64	Nein
before	float64	Nein

Antwort

Gibt zurück: Option[GetAuditLogsResponse]

Beispiel

getAuditLogs Beispiel

Copy

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

logoutPublic

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

logoutPublic Beispiel

Copy

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

blockFromCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[BlockSuccess]

Beispiel

blockFromCommentPublic Beispiel

Copy

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

unBlockCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nein
sso	string	Nein

Response

Gibt zurück: Option[UnblockSuccess]

Beispiel

unBlockCommentPublic Beispiel

Copy

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

checkedCommentsForBlocked

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentIds	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[CheckBlockedCommentsResponse]

Beispiel

checkedCommentsForBlocked Beispiel

Copy

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

blockUserFromComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
blockFromCommentParams	BlockFromCommentParams	Nein
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[BlockSuccess]

Beispiel

Beispiel für blockUserFromComment

Copy

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

createCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Nein
commentData	CommentData	Nein
sessionId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[SaveCommentsResponseWithPresence]

Beispiel

createCommentPublic Beispiel

Copy

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

deleteComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
contextUserId	string	Nein
isLive	bool	Nein

Antwort

Gibt zurück: Option[DeleteCommentResult]

Beispiel

deleteComment Beispiel

Copy

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

deleteCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nein
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[PublicAPIDeleteCommentResponse]

Beispiel

deleteCommentPublic Beispiel

Copy

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

deleteCommentVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
voteId	string	Nein
urlId	string	Ja
broadcastId	string	Nein
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[VoteDeleteResponse]

Beispiel

deleteCommentVote Beispiel

Copy

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

flagComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[FlagCommentResponse]

Beispiel

flagComment Beispiel

Copy

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

getComment

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIGetCommentResponse]

Beispiel

getComment Beispiel

Copy

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

getComments

Parameter

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

Antwort

Gibt zurück: Option[APIGetCommentsResponse]

Beispiel

getComments Beispiel

Copy

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

getCommentsPublic

req tenantId urlId

Parameter

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

Antwort

Gibt zurück: Option[GetCommentsResponseWithPresencePublicComment]

Beispiel

getCommentsPublic Beispiel

Copy

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

getCommentText

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[PublicAPIGetCommentTextResponse]

Beispiel

getCommentText Beispiel

Copy

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

getCommentVoteUserNames

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
dir	int	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[GetCommentVoteUserNamesSuccessResponse]

Beispiel

getCommentVoteUserNames Beispiel

Copy

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

lockComment

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

lockComment Beispiel

Copy

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

pinComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ChangeCommentPinStatusResponse]

Beispiel

pinComment Beispiel

Copy

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

saveComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	CreateCommentParams	Nein
isLive	bool	Nein
doSpamCheck	bool	Nein
sendEmails	bool	Nein
populateNotifications	bool	Nein

Antwort

Gibt zurück: Option[APISaveCommentResponse]

Beispiel

Beispiel für saveComment

Copy

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

saveCommentsBulk

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nein
isLive	bool	Nein
doSpamCheck	bool	Nein
sendEmails	bool	Nein
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	Nein
id	string	Nein
fromName	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

saveCommentsBulk Beispiel

Copy

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

setCommentText

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nein
commentTextUpdateRequest	CommentTextUpdateRequest	Nein
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[PublicAPISetCommentTextResponse]

Beispiel

Beispiel für setCommentText

Copy

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

unBlockUserFromComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
unBlockFromCommentParams	UnBlockFromCommentParams	Nein
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[UnblockSuccess]

Beispiel

Beispiel für unBlockUserFromComment

Copy

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

unFlagComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[FlagCommentResponse]

Beispiel

unFlagComment Beispiel

Copy

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

unLockComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

unLockComment Beispiel

Copy

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

unPinComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ChangeCommentPinStatusResponse]

Beispiel

unPinComment Beispiel

Copy

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

updateComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updatableCommentParams	UpdatableCommentParams	Nein
contextUserId	string	Nein
doSpamCheck	bool	Nein
isLive	bool	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für updateComment

Copy

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

voteComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Nein
voteBodyParams	VoteBodyParams	Nein
sessionId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[VoteResponse]

Beispiel

voteComment Beispiel

Copy

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

getCommentsForUser

Parameter

Name	Typ	Erforderlich
userId	string	Nein
direction	SortDirections	Nein
repliesToUserId	string	Nein
page	float64	Nein
includei10n	bool	Nein
locale	string	Nein
isCrawler	bool	Nein

Antwort

Gibt zurück: Option[GetCommentsForUserResponse]

Beispiel

Beispiel für getCommentsForUser

Copy

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

addDomainConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	No

Antwort

Gibt zurück: Option[AddDomainConfigResponse]

Beispiel

addDomainConfig Beispiel

Copy

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

deleteDomainConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Nein

Antwort

Gibt zurück: Option[DeleteDomainConfigResponse]

Beispiel

Beispiel für deleteDomainConfig

Copy

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

getDomainConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Nein

Antwort

Gibt zurück: Option[GetDomainConfigResponse]

Beispiel

getDomainConfig Beispiel

Copy

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

getDomainConfigs

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetDomainConfigsResponse]

Beispiel

getDomainConfigs Beispiel

Copy

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

patchDomainConfig

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
domainToUpdate	string	Nein
patchDomainConfigParams	PatchDomainConfigParams	Nein

Antwort

Gibt zurück: Option[PatchDomainConfigResponse]

Beispiel

patchDomainConfig-Beispiel

Copy

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

putDomainConfig

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
domainToUpdate	string	Nein
updateDomainConfigParams	UpdateDomainConfigParams	Nein

Antwort

Gibt zurück: Option[PutDomainConfigResponse]

Beispiel

putDomainConfig Beispiel

Copy

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

createEmailTemplate

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Nein

Antwort

Gibt zurück: Option[CreateEmailTemplateResponse]

Beispiel

createEmailTemplate Beispiel

Copy

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

deleteEmailTemplate

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
errorId	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteEmailTemplateRenderError Beispiel

Copy

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

getEmailTemplate

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetEmailTemplateResponse]

Beispiel

getEmailTemplate Beispiel

Copy

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

getEmailTemplateDefinitions

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetEmailTemplateDefinitionsResponse]

Beispiel

Beispiel für getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[GetEmailTemplateRenderErrorsResponse]

Beispiel

getEmailTemplateRenderErrors Beispiel

Copy

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

getEmailTemplates

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Rückgabe: Option[GetEmailTemplatesResponse]

Beispiel

getEmailTemplates Beispiel

Copy

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

renderEmailTemplate

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Nein
locale	string	Nein

Antwort

Gibt zurück: Option[RenderEmailTemplateResponse]

Beispiel

renderEmailTemplate Beispiel

Copy

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

updateEmailTemplate

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateEmailTemplate Beispiel

Copy

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

getEventLog

req tenantId urlId userIdWS

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Nein
startTime	int64	Nein
endTime	int64	Nein

Antwort

Gibt zurück: Option[GetEventLogResponse]

Beispiel

getEventLog Beispiel

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Nein
startTime	int64	Nein
endTime	int64	Nein

Antwort

Gibt zurück: Option[GetEventLogResponse]

Beispiel

getGlobalEventLog Beispiel

Copy

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

createFeedPost

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nein
broadcastId	string	Nein
isLive	bool	Nein
doSpamCheck	bool	Nein
skipDupCheck	bool	Nein

Antwort

Gibt zurück: Option[CreateFeedPostsResponse]

Beispiel

createFeedPost Beispiel

Copy

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

createFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nein
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[CreateFeedPostResponse]

Beispiel

createFeedPostPublic Beispiel

Copy

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

deleteFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Nein
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[DeleteFeedPostPublicResponse]

Beispiel

deleteFeedPostPublic Beispiel

Copy

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

getFeedPosts

req tenantId afterId

Parameter

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

Antwort

Gibt zurück: Option[GetFeedPostsResponse]

Beispiel

Beispiel für getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
limit	int	Nein
tags	seq[string]	Nein
sso	string	Nein
isCrawler	bool	Nein
includeUserInfo	bool	Nein

Antwort

Gibt zurück: Option[PublicFeedPostsResponse]

Beispiel

Beispiel für getFeedPostsPublic

Copy

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

getFeedPostsStats

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postIds	seq[string]	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[FeedPostsStatsResponse]

Beispiel

getFeedPostsStats Beispiel

Copy

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

getUserReactsPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postIds	seq[string]	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[UserReactsResponse]

Beispiel

getUserReactsPublic Beispiel

Copy

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

reactFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Nein
reactBodyParams	ReactBodyParams	Nein
isUndo	bool	Nein
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ReactFeedPostResponse]

Beispiel

Beispiel für reactFeedPostPublic

Copy

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

updateFeedPost

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
feedPost	FeedPost	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateFeedPost Beispiel

Copy

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

updateFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Nein
updateFeedPostParams	UpdateFeedPostParams	Nein
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[CreateFeedPostResponse]

Beispiel

Beispiel für updateFeedPostPublic

Copy

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

flagCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
isFlagged	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

flagCommentPublic Beispiel

Copy

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

getGifLarge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
largeInternalURLSanitized	string	Nein

Antwort

Gibt zurück: Option[GifGetLargeResponse]

Beispiel

Beispiel für getGifLarge

Copy

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

getGifsSearch

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
search	string	Nein
locale	string	Nein
rating	string	Nein
page	float64	Nein

Antwort

Gibt zurück: Option[GetGifsSearchResponse]

Beispiel

getGifsSearch Beispiel

Copy

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

getGifsTrending

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
locale	string	Nein
rating	string	Nein
page	float64	Nein

Antwort

Gibt zurück: Option[GetGifsTrendingResponse]

Beispiel

getGifsTrending Beispiel

Copy

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

addHashTag

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createHashTagBody	CreateHashTagBody	Nein

Antwort

Gibt zurück: Option[CreateHashTagResponse]

Beispiel

addHashTag Beispiel

Copy

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

addHashTagsBulk

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nein

Antwort

Gibt zurück: Option[BulkCreateHashTagsResponse]

Beispiel

addHashTagsBulk Beispiel

Copy

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

deleteHashTag

Parameter

Name	Typ	Erforderlich
tag	string	Nein
tenantId	string	Ja
deleteHashTagRequestBody	DeleteHashTagRequestBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteHashTag Beispiel

Copy

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

getHashTags

Parameter

Name	Type	Required	Description
tenantId	string	Ja
page	float64	Nein

Antwort

Gibt zurück: Option[GetHashTagsResponse]

Beispiel

Beispiel: getHashTags

Copy

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

patchHashTag

Parameter

Name	Typ	Erforderlich
tag	string	Nein
tenantId	string	Ja
updateHashTagBody	UpdateHashTagBody	Nein

Antwort

Gibt zurück: Option[UpdateHashTagResponse]

Beispiel

patchHashTag Beispiel

Copy

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

deleteModerationVote

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
voteId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[VoteDeleteResponse]

Beispiel

deleteModerationVote Beispiel

Copy

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

getApiComments

Parameter

Name	Typ	Erforderlich
page	float64	Nein
count	float64	Nein
textSearch	string	Nein
byIPFromComment	string	Nein
filters	string	Nein
searchFilters	string	Nein
sorts	string	Nein
demo	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPIGetCommentsResponse]

Beispiel

getApiComments Beispiel

Copy

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

getApiExportStatus

Parameter

Name	Typ	Erforderlich	Beschreibung
batchJobId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationExportStatusResponse]

Beispiel

getApiExportStatus Beispiel

Copy

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

getApiIds

Parameter

Name	Typ	Erforderlich
textSearch	string	Nein
byIPFromComment	string	Nein
filters	string	Nein
searchFilters	string	Nein
afterId	string	Nein
demo	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPIGetCommentIdsResponse]

Beispiel

getApiIds Beispiel

Copy

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

getBanUsersFromComment

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[GetBannedUsersFromCommentResponse]

Beispiel

Beispiel für getBanUsersFromComment

Copy

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

getCommentBanStatus

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[GetCommentBanStatusResponse]

Beispiel

getCommentBanStatus Beispiel

Copy

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

getCommentChildren

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPIChildCommentsResponse]

Beispiel

getCommentChildren Beispiel

Copy

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

getCount

Parameter

Name	Typ	Erforderlich
textSearch	string	Nein
byIPFromComment	string	Nein
filter	string	Nein
searchFilters	string	Nein
demo	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPICountCommentsResponse]

Beispiel

getCount Beispiel

Copy

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

getCounts

Parameter

Name	Typ	Erforderlich	Beschreibung
sso	string	Nein

Antwort

Gibt zurück: Option[GetBannedUsersCountResponse]

Beispiel

getCounts-Beispiel

Copy

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

getLogs

Parameter

Name	Type	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPIGetLogsResponse]

Beispiel

Beispiel für getLogs

Copy

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

getManualBadges

Parameter

Name	Typ	Erforderlich	Beschreibung
sso	string	Nein

Antwort

Gibt zurück: Option[GetTenantManualBadgesResponse]

Beispiel

getManualBadges Beispiel

Copy

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

getManualBadgesForUser

Parameter

Name	Typ	Erforderlich
badgesUserId	string	Nein
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[GetUserManualBadgesResponse]

Beispiel

getManualBadgesForUser Beispiel

Copy

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

getModerationComment

Parameter

Name	Type	Required
commentId	string	Ja
includeEmail	bool	Nein
includeIP	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPICommentResponse]

Beispiel

getModerationComment Beispiel

Copy

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

getModerationCommentText

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[GetCommentTextResponse]

Beispiel

Beispiel für getModerationCommentText

Copy

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

getPreBanSummary

Parameter

Name	Type	Required
commentId	string	Ja
includeByUserIdAndEmail	bool	Nein
includeByIP	bool	Nein
includeByEmailDomain	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[PreBanSummary]

Beispiel

Beispiel für getPreBanSummary

Copy

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

getSearchCommentsSummary

Parameter

Name	Typ	Erforderlich
value	string	Nein
filters	string	Nein
searchFilters	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationCommentSearchResponse]

Beispiel

getSearchCommentsSummary Beispiel

Copy

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

getSearchPages

Parameter

Name	Typ	Erforderlich	Beschreibung
value	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationPageSearchResponse]

Beispiel

getSearchPages Beispiel

Copy

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

getSearchSites

Parameter

Name	Typ	Erforderlich	Beschreibung
value	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationSiteSearchResponse]

Beispiel

getSearchSites Beispiel

Copy

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

getSearchSuggest

Parameter

Name	Typ	Erforderlich	Beschreibung
textSearch	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationSuggestResponse]

Beispiel

getSearchSuggest Beispiel

Copy

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

getSearchUsers

Parameter

Name	Typ	Erforderlich	Beschreibung
value	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationUserSearchResponse]

Beispiel

getSearchUsers Beispiel

Copy

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

getTrustFactor

Parameter

Name	Typ	Erforderlich	Beschreibung
userId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[GetUserTrustFactorResponse]

Beispiel

getTrustFactor Beispiel

Copy

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

getUserBanPreference

Parameter

Name	Typ	Erforderlich	Beschreibung
sso	string	Nein

Antwort

Gibt zurück: Option[APIModerateGetUserBanPreferencesResponse]

Beispiel

getUserBanPreference Beispiel

Copy

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

getUserInternalProfile

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Rückgabe: Option[GetUserInternalProfileResponse]

Beispiel

getUserInternalProfile Beispiel

Copy

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

postAdjustCommentVotes

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
adjustCommentVotesParams	AdjustCommentVotesParams	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[AdjustVotesResponse]

Beispiel

postAdjustCommentVotes Beispiel

Copy

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

postApiExport

Parameter

Name	Typ	Erforderlich
textSearch	string	Nein
byIPFromComment	string	Nein
filters	string	Nein
searchFilters	string	Nein
sorts	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationExportResponse]

Beispiel

postApiExport Beispiel

Copy

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

postBanUserFromComment

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
banEmail	bool	Nein
banEmailDomain	bool	Nein
banIP	bool	Nein
deleteAllUsersComments	bool	Nein
bannedUntil	string	Nein
isShadowBan	bool	Nein
updateId	string	Nein
banReason	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[BanUserFromCommentResult]

Beispiel

postBanUserFromComment Beispiel

Copy

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

postBanUserUndo

Parameter

Name	Typ	Erforderlich	Beschreibung
banUserUndoParams	BanUserUndoParams	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

postBanUserUndo Beispiel

Copy

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

postBulkPreBanSummary

Parameter

Name	Typ	Erforderlich
bulkPreBanParams	BulkPreBanParams	Nein
includeByUserIdAndEmail	bool	Nein
includeByIP	bool	Nein
includeByEmailDomain	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[BulkPreBanSummary]

Beispiel

Beispiel für postBulkPreBanSummary

Copy

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

postCommentsByIds

Parameter

Name	Typ	Erforderlich	Beschreibung
commentsByIdsParams	CommentsByIdsParams	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ModerationAPIChildCommentsResponse]

Beispiel

Beispiel für postCommentsByIds

Copy

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

postFlagComment

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

postFlagComment Beispiel

Copy

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

postRemoveComment

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[PostRemoveCommentResponse]

Beispiel

postRemoveComment Beispiel

Copy

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

postRestoreDeletedComment

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

postRestoreDeletedComment Beispiel

Copy

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

postSetCommentApprovalStatus

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
approved	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[SetCommentApprovedResponse]

Beispiel

postSetCommentApprovalStatus Beispiel

Copy

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

postSetCommentReviewStatus

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
reviewed	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

postSetCommentReviewStatus Beispiel

Copy

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

postSetCommentSpamStatus

Parameters

Name	Typ	Erforderlich
commentId	string	Ja
spam	bool	Nein
permNotSpam	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

postSetCommentSpamStatus Beispiel

Copy

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

postSetCommentText

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
setCommentTextParams	SetCommentTextParams	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[SetCommentTextResponse]

Beispiel

postSetCommentText Beispiel

Copy

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

postUnFlagComment

Parameter

Name	Typ	Erforderlich	Beschreibung
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für postUnFlagComment

Copy

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

postVote

Parameter

Name	Typ	Erforderlich
commentId	string	Ja
direction	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[VoteResponse]

Beispiel

postVote Beispiel

Copy

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

putAwardBadge

Parameter

Name	Typ	Erforderlich
badgeId	string	Nein
userId	string	Nein
commentId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[AwardUserBadgeResponse]

Beispiel

putAwardBadge Beispiel

Copy

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

putCloseThread

Parameter

Name	Typ	Erforderlich	Beschreibung
urlId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

putCloseThread Beispiel

Copy

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

putRemoveBadge

Parameter

Name	Typ	Erforderlich
badgeId	string	Nein
userId	string	Nein
commentId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[RemoveUserBadgeResponse]

Beispiel

putRemoveBadge Beispiel

Copy

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

putReopenThread

Parameter

Name	Typ	Erforderlich	Beschreibung
urlId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

putReopenThread Beispiel

Copy

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

setTrustFactor

Parameter

Name	Typ	Erforderlich
userId	string	Nein
trustFactor	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[SetUserTrustFactorResponse]

Beispiel

Beispiel für setTrustFactor

Copy

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

createModerator

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Nein

Antwort

Gibt zurück: Option[CreateModeratorResponse]

Beispiel

createModerator Beispiel

Copy

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

deleteModerator

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
sendEmail	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteModerator Beispiel

Copy

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

getModerator

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetModeratorResponse]

Beispiel

getModerator Beispiel

Copy

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

getModerators

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetModeratorsResponse]

Beispiel

getModerators-Beispiel

Copy

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

updateModerator

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateModeratorBody	UpdateModeratorBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für updateModerator

Copy

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

deleteNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteNotificationCount Beispiel

Copy

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

getCachedNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetCachedNotificationCountResponse]

Beispiel

Beispiel für getCachedNotificationCount

Copy

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

getNotificationCount

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
urlId	string	Ja
fromCommentId	string	Nein
viewed	bool	Nein

Antwort

Gibt zurück: Option[GetNotificationCountResponse]

Beispiel

getNotificationCount Beispiel

Copy

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

getNotifications

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
urlId	string	Ja
fromCommentId	string	Nein
viewed	bool	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[GetNotificationsResponse]

Beispiel

getNotifications Beispiel

Copy

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

updateNotification

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateNotificationBody	UpdateNotificationBody	Nein
userId	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für updateNotification

Copy

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

createV1PageReact

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
urlId	string	Yes
title	string	No

Antwort

Gibt zurück: Option[CreateV1PageReact]

Beispiel

createV1PageReact Beispiel

Copy

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

createV2PageReact

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
id	string	Nein
title	string	Nein

Antwort

Gibt zurück: Option[CreateV1PageReact]

Beispiel

createV2PageReact Beispiel

Copy

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

deleteV1PageReact

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[CreateV1PageReact]

Beispiel

deleteV1PageReact Beispiel

Copy

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

deleteV2PageReact

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[CreateV1PageReact]

Beispiel

deleteV2PageReact Beispiel

Copy

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

getV1PageLikes

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[GetV1PageLikes]

Beispiel

Beispiel für getV1PageLikes

Copy

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

getV2PageReacts

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[GetV2PageReacts]

Beispiel

getV2PageReacts Beispiel

Copy

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

getV2PageReactUsers

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetV2PageReactUsersResponse]

Beispiel

getV2PageReactUsers Beispiel

Copy

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

addPage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Nein

Antwort

Gibt zurück: Option[AddPageAPIResponse]

Beispiel

addPage Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[DeletePageAPIResponse]

Beispiel

deletePage Beispiel

Copy

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

getOfflineUsers

Frühere Kommentierende auf der Seite, die momentan NICHT online sind. Sortiert nach displayName. Verwenden Sie dies, nachdem Sie /users/online abgefragt haben, um einen "Members"-Abschnitt anzuzeigen. Cursor-Paginierung auf commenterName: Der Server durchläuft den partiellen Index {tenantId, urlId, commenterName} index ab afterName vorwärts mittels $gt, ohne $skip-Kosten.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nein
afterUserId	string	Nein

Antwort

Gibt zurück: Option[PageUsersOfflineResponse]

Beispiel

getOfflineUsers Beispiel

Copy

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

getOnlineUsers

Momentan online befindliche Betrachter einer Seite: Personen, deren WebSocket-Sitzung zurzeit auf die Seite abonniert ist. Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Betrachter, die wir nicht aufzählen).

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nein
afterUserId	string	Nein

Antwort

Gibt zurück: Option[PageUsersOnlineResponse]

Beispiel

getOnlineUsers Beispiel

Copy

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

getPageByURLId

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[GetPageByURLIdAPIResponse]

Beispiel

getPageByURLId Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetPagesAPIResponse]

Beispiel

getPages Beispiel

Copy

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

getPagesPublic

Listet Seiten für einen Mandanten. Wird vom FChat-Desktop-Client verwendet, um dessen Raumliste zu füllen. Erfordert, dass enableFChat für jede Seite in der aufgelösten Custom-Konfiguration auf true gesetzt ist. Seiten, die SSO benötigen, werden anhand des Gruppen-Zugriffs des anfragenden Benutzers gefiltert.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
cursor	string	Nein
limit	int	Nein
q	string	Nein
sortBy	PagesSortBy	Nein
hasComments	bool	Nein

Antwort

Gibt zurück: Option[GetPublicPagesResponse]

Beispiel

getPagesPublic Beispiel

Copy

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

getUsersInfo

Massenbenutzerinformationen für einen Mandanten. Anhand der userIds werden Anzeigeinformationen aus User / SSOUser zurückgegeben. Vom Kommentar-Widget verwendet, um Benutzer anzureichern, die gerade durch ein Presence-Ereignis erschienen sind. Kein Seitenkontext: der Datenschutz wird einheitlich durchgesetzt (private Profile werden maskiert).

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
ids	string	Nein

Antwort

Gibt zurück: Option[PageUsersInfoResponse]

Beispiel

getUsersInfo Beispiel

Copy

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

patchPage

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateAPIPageData	UpdateAPIPageData	Nein

Antwort

Gibt zurück: Option[PatchPageAPIResponse]

Beispiel

patchPage Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deletePendingWebhookEvent Beispiel

Copy

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

getPendingWebhookEventCount

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
externalId	string	Nein
eventType	string	Nein
domain	string	Nein
attemptCountGT	float64	Nein

Antwort

Gibt zurück: Option[GetPendingWebhookEventCountResponse]

Beispiel

Beispiel für getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
externalId	string	Nein
eventType	string	Nein
domain	string	Nein
attemptCountGT	float64	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[GetPendingWebhookEventsResponse]

Beispiel

getPendingWebhookEvents Beispiel

Copy

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

createQuestionConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nein

Antwort

Gibt zurück: Option[CreateQuestionConfigResponse]

Beispiel

createQuestionConfig Beispiel

Copy

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

deleteQuestionConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteQuestionConfig Beispiel

Copy

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

getQuestionConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetQuestionConfigResponse]

Beispiel

getQuestionConfig Beispiel

Copy

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

getQuestionConfigs

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetQuestionConfigsResponse]

Beispiel

Beispiel für getQuestionConfigs

Copy

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

updateQuestionConfig

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateQuestionConfigBody	UpdateQuestionConfigBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateQuestionConfig Beispiel

Copy

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

createQuestionResult

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nein

Antwort

Gibt zurück: Option[CreateQuestionResultResponse]

Beispiel

createQuestionResult Beispiel

Copy

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

deleteQuestionResult

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für deleteQuestionResult

Copy

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

getQuestionResult

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetQuestionResultResponse]

Beispiel

getQuestionResult Beispiel

Copy

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

getQuestionResults

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userId	string	Nein
startDate	string	Nein
questionId	string	Nein
questionIds	string	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[GetQuestionResultsResponse]

Beispiel

getQuestionResults Beispiel

Copy

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

updateQuestionResult

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateQuestionResultBody	UpdateQuestionResultBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateQuestionResult Beispiel

Copy

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

aggregateQuestionResults

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
questionId	string	Nein
questionIds	seq[string]	Nein
urlId	string	Ja
timeBucket	AggregateTimeBucket	Nein
startDate	string	Nein
forceRecalculate	bool	Nein

Antwort

Gibt zurück: Option[AggregateQuestionResultsResponse]

Beispiel

aggregateQuestionResults Beispiel

Copy

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

bulkAggregateQuestionResults

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Nein
forceRecalculate	bool	Nein

Antwort

Gibt zurück: Option[BulkAggregateQuestionResultsResponse]

Beispiel

Beispiel für bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
questionId	string	Nein
questionIds	seq[string]	Nein
urlId	string	Ja
startDate	string	Nein
forceRecalculate	bool	Nein
minValue	float64	Nein
maxValue	float64	Nein
limit	float64	Nein

Antwort

Gibt zurück: Option[CombineQuestionResultsWithCommentsResponse]

Beispiel

Beispiel für combineCommentsWithQuestionResults

Copy

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

addSSOUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Nein

Antwort

Gibt zurück: Option[AddSSOUserAPIResponse]

Beispiel

addSSOUser Beispiel

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

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
deleteComments	bool	Nein
commentDeleteMode	string	Nein

Antwort

Gibt zurück: Option[DeleteSSOUserAPIResponse]

Beispiel

deleteSSOUser Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
email	string	Nein

Antwort

Gibt zurück: Option[GetSSOUserByEmailAPIResponse]

Beispiel

getSSOUserByEmail Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetSSOUserByIdAPIResponse]

Beispiel

Beispiel für getSSOUserById

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	int	Nein

Antwort

Gibt zurück: Option[GetSSOUsersResponse]

Beispiel

getSSOUsers Beispiel

Copy

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

patchSSOUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateAPISSOUserData	UpdateAPISSOUserData	Nein
updateComments	bool	Nein

Antwort

Gibt zurück: Option[PatchSSOUserAPIResponse]

Beispiel

patchSSOUser Beispiel

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

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateAPISSOUserData	UpdateAPISSOUserData	Nein
updateComments	bool	Nein

Antwort

Gibt zurück: Option[PutSSOUserAPIResponse]

Beispiel

putSSOUser Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nein

Antwort

Gibt zurück: Option[CreateSubscriptionAPIResponse]

Beispiel

createSubscription Beispiel

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

Parameter

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

Antwort

Gibt zurück: Option[DeleteSubscriptionAPIResponse]

Beispiel

deleteSubscription Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Nein

Antwort

Gibt zurück: Option[GetSubscriptionsAPIResponse]

Beispiel

getSubscriptions Beispiel

Copy

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

updateSubscription

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Nein
userId	string	Nein

Antwort

Gibt zurück: Option[UpdateSubscriptionAPIResponse]

Beispiel

Beispiel für updateSubscription

Copy

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

getTenantDailyUsages

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
yearNumber	float64	Nein
monthNumber	float64	Nein
dayNumber	float64	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[GetTenantDailyUsagesResponse]

Beispiel

getTenantDailyUsages Beispiel

Copy

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

createTenantPackage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nein

Antwort

Gibt zurück: Option[CreateTenantPackageResponse]

Beispiel

createTenantPackage Beispiel

Copy

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

deleteTenantPackage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteTenantPackage Beispiel

Copy

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

getTenantPackage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetTenantPackageResponse]

Beispiel

getTenantPackage Beispiel

Copy

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

getTenantPackages

Parameter

Name	Type	Required	Description
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetTenantPackagesResponse]

Beispiel

getTenantPackages Beispiel

Copy

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

replaceTenantPackage

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
replaceTenantPackageBody	ReplaceTenantPackageBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

replaceTenantPackage Beispiel

Copy

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

updateTenantPackage

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateTenantPackageBody	UpdateTenantPackageBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateTenantPackage Beispiel

Copy

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

createTenantUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Nein

Antwort

Gibt zurück: Option[CreateTenantUserResponse]

Beispiel

createTenantUser Beispiel

Copy

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

deleteTenantUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
deleteComments	string	Nein
commentDeleteMode	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

Beispiel für deleteTenantUser

Copy

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

getTenantUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetTenantUserResponse]

Beispiel

getTenantUser Beispiel

Copy

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

getTenantUsers

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetTenantUsersResponse]

Beispiel

getTenantUsers Beispiel

Copy

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

replaceTenantUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
replaceTenantUserBody	ReplaceTenantUserBody	Nein
updateComments	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

replaceTenantUser Beispiel

Copy

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

sendLoginLink

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
redirectURL	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

sendLoginLink Beispiel

Copy

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

updateTenantUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateTenantUserBody	UpdateTenantUserBody	Nein
updateComments	string	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateTenantUser Beispiel

Copy

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

createTenant

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantBody	CreateTenantBody	Nein

Antwort

Gibt zurück: Option[CreateTenantResponse]

Beispiel

createTenant Beispiel

Copy

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

deleteTenant

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
sure	string	No

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

deleteTenant Beispiel

Copy

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

getTenant

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetTenantResponse]

Beispiel

getTenant-Beispiel

Copy

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

getTenants

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
meta	string	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[GetTenantsResponse]

Beispiel

getTenants Beispiel

Copy

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

updateTenant

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateTenantBody	UpdateTenantBody	Nein

Antwort

Gibt zurück: Option[APIEmptyResponse]

Beispiel

updateTenant Beispiel

Copy

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

changeTicketState

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
id	string	Nein
changeTicketStateBody	ChangeTicketStateBody	Nein

Antwort

Gibt zurück: Option[ChangeTicketStateResponse]

Beispiel

changeTicketState Beispiel

Copy

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

createTicket

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
createTicketBody	CreateTicketBody	Nein

Antwort

Gibt zurück: Option[CreateTicketResponse]

Beispiel

createTicket Beispiel

Copy

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

getTicket

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
userId	string	Nein

Antwort

Gibt zurück: Option[GetTicketResponse]

Beispiel

getTicket Beispiel

Copy

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

getTickets

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
state	float64	Nein
skip	float64	Nein
limit	float64	Nein

Antwort

Gibt zurück: Option[GetTicketsResponse]

Beispiel

Beispiel für getTickets

Copy

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

getTranslations

Parameter

Name	Typ	Erforderlich
namespace	string	Nein
component	string	Nein
locale	string	Nein
useFullTranslationIds	bool	Nein

Antwort

Gibt zurück: Option[GetTranslationsResponse]

Beispiel

getTranslations Beispiel

Copy

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

uploadImage

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
file	string	Nein
sizePreset	SizePreset	Nein
urlId	string	Ja

Antwort

Gibt zurück: Option[UploadImageResponse]

Beispiel

uploadImage Beispiel

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

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIGetUserBadgeProgressResponse]

Beispiel

Beispiel für getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Nein

Antwort

Gibt zurück: Option[APIGetUserBadgeProgressResponse]

Beispiel

Beispiel für getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
limit	float64	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[APIGetUserBadgeProgressListResponse]

Beispiel

Beispiel für getUserBadgeProgressList

Copy

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

createUserBadge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nein

Antwort

Gibt zurück: Option[APICreateUserBadgeResponse]

Beispiel

createUserBadge Beispiel

Copy

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

deleteUserBadge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[APIEmptySuccessResponse]

Beispiel

deleteUserBadge Beispiel

Copy

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

getUserBadge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIGetUserBadgeResponse]

Beispiel

getUserBadge Beispiel

Copy

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

getUserBadges

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
badgeId	string	Nein
displayedOnComments	bool	Nein
limit	float64	Nein
skip	float64	Nein

Antwort

Gibt zurück: Option[APIGetUserBadgesResponse]

Beispiel

getUserBadges Beispiel

Copy

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

updateUserBadge

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateUserBadgeParams	UpdateUserBadgeParams	Nein

Antwort

Gibt zurück: Option[APIEmptySuccessResponse]

Beispiel

updateUserBadge Beispiel

Copy

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

getUserNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[GetUserNotificationCountResponse]

Beispiel

getUserNotificationCount Beispiel

Copy

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

getUserNotifications

Parameter

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
pageSize	int	Nein
afterId	string	Nein
includeContext	bool	Nein
afterCreatedAt	int64	Nein
unreadOnly	bool	Nein
dmOnly	bool	Nein
noDm	bool	Nein
includeTranslations	bool	Nein
includeTenantNotifications	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[GetMyNotificationsResponse]

Beispiel

getUserNotifications Beispiel

Copy

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

resetUserNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[ResetUserNotificationsResponse]

Beispiel

Beispiel für resetUserNotificationCount

Copy

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

resetUserNotifications

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
afterCreatedAt	int64	Nein
unreadOnly	bool	Nein
dmOnly	bool	Nein
noDm	bool	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[ResetUserNotificationsResponse]

Beispiel

Beispiel für resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
notificationId	string	Nein
optedInOrOut	string	Nein
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Beispiel

updateUserNotificationCommentSubscriptionStatus Beispiel

Copy

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

updateUserNotificationPageSubscriptionStatus

Benachrichtigungen für eine Seite aktivieren oder deaktivieren. Wenn Benutzer für eine Seite abonniert sind, werden Benachrichtigungen erstellt für neue Root-Kommentare, und auch

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
url	string	Nein
pageTitle	string	Nein
subscribedOrUnsubscribed	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Beispiel

updateUserNotificationPageSubscriptionStatus Beispiel

Copy

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

updateUserNotificationStatus

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
notificationId	string	Nein
newStatus	string	Nein
sso	string	Nein

Antwort

Gibt zurück: Option[UpdateUserNotificationStatusResponse]

Beispiel

updateUserNotificationStatus Beispiel

Copy

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

getUserPresenceStatuses

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlIdWS	string	Nein
userIds	string	Nein

Antwort

Gibt zurück: Option[GetUserPresenceStatusesResponse]

Beispiel

getUserPresenceStatuses Beispiel

Copy

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

searchUsers

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Nein
mentionGroupIds	seq[string]	Nein
sso	string	Nein
searchSection	string	Nein

Antwort

Gibt zurück: Option[SearchUsersResult]

Beispiel

searchUsers Beispiel

Copy

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

getUser

Parameter

Name	Type	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetUserResponse]

Beispiel

getUser Beispiel

Copy

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

createVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
direction	string	Nein
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[VoteResponse]

Beispiel

createVote Beispiel

Copy

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

deleteVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
editKey	string	Nein

Antwort

Gibt zurück: Option[VoteDeleteResponse]

Beispiel

deleteVote Beispiel

Copy

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

getVotes

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[GetVotesResponse]

Beispiel

getVotes Beispiel

Copy

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

getVotesForUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[GetVotesForUserResponse]

Beispiel

getVotesForUser Beispiel

Copy

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

Benötigen Sie Hilfe?

Wenn Sie auf Probleme stoßen oder Fragen zum Nim SDK haben, bitte:

Mitwirken

Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für Beitragsrichtlinien.

Sprache 🇩🇪 Deutsch

Dokumentation

Erste Schritte

API-Referenz

Verwendung

Aggregation

Audit-Protokolle

Authentifizierung

Vom Kommentar blockieren

Gesperrte Kommentare prüfen

Kommentare

Kommentare für Benutzer

Domain-Konfigurationen

E-Mail-Vorlagen

Ereignisprotokoll

Feed-Beiträge

Kommentar melden

GIFs

Hashtags

Moderation

Moderatoren

Benachrichtigungsanzahl

Benachrichtigungen

Seitenreaktionen

Seiten

Ausstehende Webhook-Ereignisse

Fragekonfigurationen

Frageergebnisse

Aggregation der Frageergebnisse

SSO-Benutzer

Abonnements

Tägliche Nutzung des Mandanten

Mandantenpakete

Mandantenbenutzer

Mandanten

Tickets

Übersetzungen

Bild hochladen

Fortschritt der Benutzerabzeichen

Benutzerabzeichen

Benutzerbenachrichtigungen

Benutzer-Anwesenheitsstatus

Benutzersuche

Benutzer

Abstimmungen

FastComments Nim SDK

Repository

Voraussetzungen

Installation

Verwendung von Nimble

Aus dem Quellcode bauen

Inhalt der Bibliothek

Öffentliche vs. gesicherte APIs

Schnellstart

Verwendung authentifizierter APIs (DefaultAPI)

Verwendung öffentlicher APIs (PublicAPI)

Verwendung der Moderations-APIs (ModerationAPI)

Häufige Probleme

API-Aufrufe

Beispiel: Kommentare abrufen

Hinweise

Broadcast-IDs

SSO (Single Sign-On)

SSO-Verwendung

Einfaches SSO

Sicheres SSO

Dokumentation für FastComments

Dokumentation der API-Endpunkte

Dokumentation der Modelle

aggregate

Parameter

Antwort

Beispiel

getAuditLogs

Parameter

Antwort

Beispiel

logoutPublic

Antwort

Beispiel