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

Bibliotheksinhalt

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

API Client Library Docs

Ö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 benötigen, und api_public enthält API‑Aufrufe, die direkt von einem Browser/Mobilgerät/etc. ohne Authentifizierung durchgeführt werden können. Das api_moderation‑Modul enthält Methoden für das Moderator‑Dashboard.

Das api_moderation‑Modul bietet eine umfangreiche Suite von Live‑ und schnellen Moderations‑APIs. Jede api_moderation‑Methode akzeptiert einen sso‑Parameter und kann über SSO oder ein FastComments.com‑Session‑Cookie authentifiziert werden.

Schnellstart

Verwendung authentifizierter APIs (DefaultAPI)

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

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.
# Erforderliche Parameter (und der Anfrage‑Body) sind positional; optionale
# Parameter werden über das Options‑Objekt der Operation übergeben.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

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.
# tenantId und urlId sind erforderlich (positional); alles andere ist optional.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Verwendung von Moderations‑APIs (ModerationAPI)

Moderations‑Endpunkte versorgen das Moderator‑Dashboard und sind 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.
# Diese Operation hat keine erforderlichen Parameter, daher ist alles optional.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Häufige Probleme

401 Authentifizierungsfehler: Stellen Sie sicher, dass Sie den Header x-api-key in 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 an das Moderator‑Dashboard.

API-Aufrufe

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

Erforderliche Parameter und der Request‑Body werden positionsbasiert übergeben. Die übrigen optionalen Parameter werden in einem einzelnen Api<Operation>Options‑Objekt gesammelt, das das letzte Argument ist. Vorgänge ohne optionale Parameter benötigen kein Options‑Objekt.

Beispiel: Abrufen von Kommentaren

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

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

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

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

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 für 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 nach Gruppen zusammengefasst werden (wenn groupBy angegeben ist) und mehrere Operationen angewendet werden. Unterschiedliche Operationen (z. B. sum, countDistinct, avg usw.) 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	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
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}	Aktivieren oder deaktivieren von Benachrichtigungen für einen bestimmten Kommentar.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Aktivieren oder deaktivieren von Benachrichtigungen für eine Seite. Wenn Benutzer eine Seite abonniert haben, werden Benachrichtigungen für neue Hauptkommentare erstellt, und außerdem
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Ein Bild hochladen und skalieren
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentation für Modelle

aggregate

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

Parameters

Name	Type	Required
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Response

Returns: Option[AggregateResponse]

Example

Aggregationsbeispiel

Copy

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

getAuditLogs

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetAuditLogsOptions	Nein

Antwort

Rückgabe: Option[GetAuditLogsResponse]

Beispiel

getAuditLogs Beispiel

Copy

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

logoutPublic

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

logoutPublic Beispiel

Copy

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

blockFromCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string = ""	No

Antwort

Rückgabe: Option[BlockSuccess]

Beispiel

blockFromCommentPublic Beispiel

Copy

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

unBlockCommentPublic

Parameter

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Nein
sso	string = ""	Nein

Antwort

Rückgabe: Option[UnblockSuccess]

Beispiel

unBlockCommentPublic Beispiel

Copy

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

checkedCommentsForBlocked

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentIds	string	No
sso	string = ""	No

Antwort

Rückgabe: Option[CheckBlockedCommentsResponse]

Beispiel

checkedCommentsForBlocked Beispiel

Copy

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

blockUserFromComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

Antwort

Rückgabe: Option[BlockSuccess]

Beispiel

blockUserFromComment Beispiel

Copy

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

createCommentPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Antwort

Rückgabe: Option[SaveCommentsResponseWithPresence]

Beispiel

createCommentPublic Beispiel

Copy

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

deleteComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
options	DeleteCommentOptions	No

Antwort

Rückgabe: Option[DeleteCommentResult]

Beispiel

deleteComment Beispiel

Copy

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

deleteCommentPublic

Parameter

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Antwort

Returns: Option[PublicAPIDeleteCommentResponse]

Beispiel

deleteCommentPublic Beispiel

Copy

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

deleteCommentVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
voteId	string	Nein
urlId	string	Ja
broadcastId	string	Nein
options	DeleteCommentVoteOptions	Nein

Antwort

Rückgabe: Option[VoteDeleteResponse]

Beispiel

deleteCommentVote Beispiel

Copy

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

flagComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
options	FlagCommentOptions	Nein

Antwort

Rückgabe: Option[FlagCommentResponse]

Beispiel

flagComment Beispiel

Copy

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

getComment

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIGetCommentResponse]

Beispiel

getComment Beispiel

Copy

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

getComments

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
options	GetCommentsOptions	No

Antwort

Rückgabe: Option[APIGetCommentsResponse]

Beispiel

getComments Beispiel

Copy

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

getCommentsPublic

req tenantId urlId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
options	GetCommentsPublicOptions	Nein

Antwort

Rückgabe: Option[GetCommentsResponseWithPresencePublicComment]

Beispiel

getCommentsPublic Beispiel

Copy

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

getCommentText

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	GetCommentTextOptions	Nein

Antwort

Rückgabe: Option[PublicAPIGetCommentTextResponse]

Beispiel

getCommentText Beispiel

Copy

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

getCommentVoteUserNames

Parameter

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

Antwort

Rückgabe: Option[GetCommentVoteUserNamesSuccessResponse]

Beispiel

getCommentVoteUserNames Beispiel

Copy

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

lockComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Antwort

Returns: Option[APIEmptyResponse]

Beispiel

lockComment Beispiel

Copy

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

pinComment

Parameter

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

Antwort

Rückgabe: Option[ChangeCommentPinStatusResponse]

Beispiel

pinComment Beispiel

Copy

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

saveComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	CreateCommentParams	Nein
options	SaveCommentOptions	Nein

Antwort

Rückgabe: Option[APISaveCommentResponse]

Beispiel

saveComment Beispiel

Copy

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

saveCommentsBulk

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nein
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	Nein
id	string	Nein
fromName	string	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

saveCommentsBulk Beispiel

Copy

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

setCommentText

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

Antwort

Rückgabe: Option[PublicAPISetCommentTextResponse]

Beispiel

setCommentText Beispiel

Copy

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

unBlockUserFromComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
unBlockFromCommentParams	UnBlockFromCommentParams	Nein
options	UnBlockUserFromCommentOptions	Nein

Antwort

Rückgabe: Option[UnblockSuccess]

Beispiel

unBlockUserFromComment Beispiel

Copy

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

unFlagComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
options	UnFlagCommentOptions	No

Antwort

Rückgabe: Option[FlagCommentResponse]

Beispiel

unFlagComment Beispiel

Copy

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

unLockComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

unLockComment Beispiel

Copy

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

unPinComment

Parameter

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

Antwort

Rückgabe: Option[ChangeCommentPinStatusResponse]

Beispiel

unPinComment Beispiel

Copy

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

updateComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updatableCommentParams	UpdatableCommentParams	Nein
options	UpdateCommentOptions	Nein

Antwort

Returns: Option[APIEmptyResponse]

Beispiel

updateComment Beispiel

Copy

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

voteComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Nein
voteBodyParams	VoteBodyParams	Nein
options	VoteCommentOptions	Nein

Antwort

Rückgabe: Option[VoteResponse]

Beispiel

voteComment Beispiel

Copy

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

getCommentsForUser

Parameter

Name	Type	Erforderlich	Beschreibung
options	GetCommentsForUserOptions	No

Antwort

Rückgabe: Option[GetCommentsForUserResponse]

Beispiel

getCommentsForUser Beispiel

Copy

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

addDomainConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Nein

Antwort

Rückgabe: Option[AddDomainConfigResponse]

Beispiel

addDomainConfig Beispiel

Copy

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

deleteDomainConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Nein

Antwort

Rückgabe: Option[DeleteDomainConfigResponse]

Beispiel

deleteDomainConfig Beispiel

Copy

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

getDomainConfig

Parameter

Name	Type	Required	Description
tenantId	string	Yes
domain	string	No

Antwort

Rückgabe: Option[GetDomainConfigResponse]

Beispiel

getDomainConfig Beispiel

Copy

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

getDomainConfigs

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Rückgabe: Option[GetDomainConfigsResponse]

Beispiel

getDomainConfigs Beispiel

Copy

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

patchDomainConfig

Parameter

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

Antwort

Rückgabe: Option[PatchDomainConfigResponse]

Beispiel

patchDomainConfig Beispiel

Copy

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

putDomainConfig

Parameter

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

Antwort

Rückgabe: Option[PutDomainConfigResponse]

Beispiel

putDomainConfig Beispiel

Copy

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

createEmailTemplate

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Nein

Antwort

Rückgabe: Option[CreateEmailTemplateResponse]

Beispiel

createEmailTemplate Beispiel

Copy

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

deleteEmailTemplate

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteEmailTemplate Beispiel

Copy

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

deleteEmailTemplateRenderError

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteEmailTemplateRenderError Beispiel

Copy

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

getEmailTemplate

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetEmailTemplateResponse]

Beispiel

getEmailTemplate Beispiel

Copy

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

getEmailTemplateDefinitions

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Rückgabe: Option[GetEmailTemplateDefinitionsResponse]

Beispiel

getEmailTemplateDefinitions Beispiel

Copy

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

getEmailTemplateRenderErrors

Parameters

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

Response

Rückgabe: Option[GetEmailTemplateRenderErrorsResponse]

Example

Beispiel für getEmailTemplateRenderErrors

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # resp nach Bedarf verwenden
else:
  # fehlende Antwort behandeln
  discard

getEmailTemplates

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Rückgabe: Option[GetEmailTemplatesResponse]

Beispiel

getEmailTemplates Beispiel

Copy

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

renderEmailTemplate

Parameter

Name	Type	Required
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Antwort

Rückgabe: Option[RenderEmailTemplateResponse]

Beispiel

renderEmailTemplate Beispiel

Copy

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

updateEmailTemplate

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
updateEmailTemplateBody	UpdateEmailTemplateBody	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateEmailTemplate Beispiel

Copy

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

getEventLog

req tenantId urlId userIdWS

Parameter

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

Antwort

Rückgabe: Option[GetEventLogResponse]

Beispiel

Beispiel für getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parameter

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

Antwort

Rückgabe: Option[GetEventLogResponse]

Beispiel

getGlobalEventLog Beispiel

Copy

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

createFeedPost

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nein
options	CreateFeedPostOptions	Nein

Antwort

Rückgabe: Option[CreateFeedPostsResponse]

Beispiel

createFeedPost Beispiel

Copy

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

createFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Nein
options	CreateFeedPostPublicOptions	Nein

Antwort

Gibt zurück: Option[CreateFeedPostResponse]

Beispiel

createFeedPostPublic Beispiel

Copy

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

deleteFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Nein
options	DeleteFeedPostPublicOptions	Nein

Antwort

Rückgabe: Option[DeleteFeedPostPublicResponse]

Beispiel

deleteFeedPostPublic Beispiel

Copy

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

getFeedPosts

req tenantId afterId

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetFeedPostsOptions	Nein

Antwort

Rückgabe: Option[GetFeedPostsResponse]

Beispiel

getFeedPosts Beispiel

Copy

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

getFeedPostsPublic

req tenantId afterId

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetFeedPostsPublicOptions	Nein

Antwort

Rückgabe: Option[PublicFeedPostsResponse]

Beispiel

getFeedPostsPublic Beispiel

Copy

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

getFeedPostsStats

Parameter

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

Antwort

Rückgabe: Option[FeedPostsStatsResponse]

Beispiel

getFeedPostsStats Beispiel

Copy

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

getUserReactsPublic

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetUserReactsPublicOptions	Nein

Antwort

Rückgabe: Option[UserReactsResponse]

Beispiel

getUserReactsPublic Beispiel

Copy

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

reactFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Antwort

Rückgabe: Option[ReactFeedPostResponse]

Beispiel

reactFeedPostPublic Beispiel

Copy

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

updateFeedPost

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateFeedPost Beispiel

Copy

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

updateFeedPostPublic

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Antwort

Rückgabe: Option[CreateFeedPostResponse]

Beispiel

updateFeedPostPublic Beispiel

Copy

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

flagCommentPublic

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

flagCommentPublic Beispiel

Copy

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

getGifLarge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
largeInternalURLSanitized	string	No

Antwort

Rückgabe: Option[GifGetLargeResponse]

Beispiel

getGifLarge Beispiel

Copy

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

getGifsSearch

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
search	string	Nein
options	GetGifsSearchOptions	Nein

Antwort

Rückgabe: Option[GetGifsSearchResponse]

Beispiel

getGifsSearch Beispiel

Copy

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

getGifsTrending

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetGifsTrendingOptions	Nein

Antwort

Rückgabe: Option[GetGifsTrendingResponse]

Beispiel

getGifsTrending Beispiel

Copy

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

addHashTag

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createHashTagBody	CreateHashTagBody	Nein

Antwort

Rückgabe: Option[CreateHashTagResponse]

Beispiel

addHashTag Beispiel

Copy

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

addHashTagsBulk

Parameter

Name	Type	Required	Description
tenantId	string	Yes
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Antwort

Rückgabe: Option[BulkCreateHashTagsResponse]

Beispiel

addHashTagsBulk Beispiel

Copy

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

deleteHashTag

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteHashTag Beispiel

Copy

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

getHashTags

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
page	float64	No

Antwort

Rückgabe: Option[GetHashTagsResponse]

Beispiel

Beispiel für getHashTags

Copy

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

patchHashTag

Parameter

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

Antwort

Rückgabe: Option[UpdateHashTagResponse]

Beispiel

patchHashTag Beispiel

Copy

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

deleteModerationVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
options	DeleteModerationVoteOptions	No

Antwort

Rückgabe: Option[VoteDeleteResponse]

Beispiel

deleteModerationVote Beispiel

Copy

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

getApiComments

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetApiCommentsOptions	Nein

Antwort

Rückgabe: Option[ModerationAPIGetCommentsResponse]

Beispiel

getApiComments Beispiel

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # Weiterverarbeitung kann mit `resp` durchgeführt werden

getApiExportStatus

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetApiExportStatusOptions	Nein

Antwort

Rückgabe: Option[ModerationExportStatusResponse]

Beispiel

Beispiel für getApiExportStatus

Copy

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

getApiIds

Parameter

Name	Type	Required	Description
tenantId	string	Yes
options	GetApiIdsOptions	No

Antwort

Rückgabe: Option[ModerationAPIGetCommentIdsResponse]

Beispiel

getApiIds Beispiel

Copy

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

getBanUsersFromComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[GetBannedUsersFromCommentResponse]

Beispiel

Beispiel für getBanUsersFromComment

Copy

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

getCommentBanStatus

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Antwort

Rückgabe: Option[GetCommentBanStatusResponse]

Beispiel

Beispiel für getCommentBanStatus

Copy

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

getCommentChildren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[ModerationAPIChildCommentsResponse]

Beispiel

getCommentChildren Beispiel

Copy

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

getCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetCountOptions	Nein

Antwort

Rückgabe: Option[ModerationAPICountCommentsResponse]

Beispiel

getCount Beispiel

Copy

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

getCounts

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[GetBannedUsersCountResponse]

Beispiel

getCounts Beispiel

Copy

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

getLogs

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[ModerationAPIGetLogsResponse]

Beispiel

getLogs Beispiel

Copy

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

getManualBadges

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[GetTenantManualBadgesResponse]

Beispiel

getManualBadges Beispiel

Copy

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

getManualBadgesForUser

Parameter

Name	Type	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetManualBadgesForUserOptions	Nein

Antwort

Rückgabe: Option[GetUserManualBadgesResponse]

Beispiel

getManualBadgesForUser Beispiel

Copy

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

getModerationComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	GetModerationCommentOptions	Nein

Antwort

Rückgabe: Option[ModerationAPICommentResponse]

Beispiel

getModerationComment Beispiel

Copy

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

getModerationCommentText

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[GetCommentTextResponse]

Beispiel

getModerationCommentText Beispiel

Copy

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

getPreBanSummary

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
options	GetPreBanSummaryOptions	No

Antwort

Rückgabe: Option[PreBanSummary]

Beispiel

Beispiel für getPreBanSummary

Copy

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

getSearchCommentsSummary

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

Antwort

Rückgabe: Option[ModerationCommentSearchResponse]

Beispiel

getSearchCommentsSummary Beispiel

Copy

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

getSearchPages

Parameter

Name	Type	Required	Description
tenantId	string	Ja
options	GetSearchPagesOptions	Nein

Antwort

Rückgabe: Option[ModerationPageSearchResponse]

Beispiel

getSearchPages Beispiel

Copy

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

getSearchSites

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetSearchSitesOptions	Nein

Antwort

Rückgabe: Option[ModerationSiteSearchResponse]

Beispiel

getSearchSites Beispiel

Copy

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

getSearchSuggest

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetSearchSuggestOptions	Nein

Antwort

Rückgabe: Option[ModerationSuggestResponse]

Beispiel

getSearchSuggest Beispiel

Copy

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

getSearchUsers

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetSearchUsersOptions	Nein

Antwort

Rückgabe: Option[ModerationUserSearchResponse]

Beispiel

getSearchUsers Beispiel

Copy

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

getTrustFactor

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetTrustFactorOptions	Nein

Antwort

Rückgabe: Option[GetUserTrustFactorResponse]

Beispiel

getTrustFactor Beispiel

Copy

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

getUserBanPreference

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
sso	string = ""	No

Rückgabe

Rückgabe: Option[APIModerateGetUserBanPreferencesResponse]

Beispiel

Beispiel für getUserBanPreference

Copy

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

getUserInternalProfile

Parameter

Name	Type	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetUserInternalProfileOptions	Nein

Antwort

Rückgabe: Option[GetUserInternalProfileResponse]

Beispiel

getUserInternalProfile Beispiel

Copy

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

postAdjustCommentVotes

Parameter

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
adjustCommentVotesParams	AdjustCommentVotesParams	Nein
options	PostAdjustCommentVotesOptions	Nein

Antwort

Rückgabe: Option[AdjustVotesResponse]

Beispiel

postAdjustCommentVotes Beispiel

Copy

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

postApiExport

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	PostApiExportOptions	Nein

Antwort

Rückgabe: Option[ModerationExportResponse]

Beispiel

postApiExport Beispiel

Copy

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

postBanUserFromComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	PostBanUserFromCommentOptions	Nein

Antwort

Rückgabe: Option[BanUserFromCommentResult]

Beispiel

postBanUserFromComment Beispiel

Copy

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

postBanUserUndo

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
banUserUndoParams	BanUserUndoParams	Nein
sso	string = ""	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

postBanUserUndo Beispiel

Copy

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

postBulkPreBanSummary

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Antwort

Rückgabe: Option[BulkPreBanSummary]

Beispiel

postBulkPreBanSummary Beispiel

Copy

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

postCommentsByIds

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentsByIdsParams	CommentsByIdsParams	Nein
sso	string = ""	Nein

Antwort

Rückgabe: Option[ModerationAPIChildCommentsResponse]

Beispiel

postCommentsByIds Beispiel

Copy

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

postFlagComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	PostFlagCommentOptions	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

postFlagComment Beispiel

Copy

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

postRemoveComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
options	PostRemoveCommentOptions	No

Antwort

Rückgabe: Option[PostRemoveCommentApiResponse]

Beispiel

postRemoveComment Beispiel

Copy

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

postRestoreDeletedComment

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	PostRestoreDeletedCommentOptions	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

postRestoreDeletedComment Beispiel

Copy

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

postSetCommentApprovalStatus

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentApprovalStatusOptions	No

Antwort

Rückgabe: Option[SetCommentApprovedResponse]

Beispiel

postSetCommentApprovalStatus Beispiel

Copy

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

postSetCommentReviewStatus

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

postSetCommentReviewStatus Beispiel

Copy

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

postSetCommentSpamStatus

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

postSetCommentSpamStatus Beispiel

Copy

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

postSetCommentText

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
setCommentTextParams	SetCommentTextParams	Nein
options	PostSetCommentTextOptions	Nein

Antwort

Rückgabe: Option[SetCommentTextResponse]

Beispiel

postSetCommentText Beispiel

Copy

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

postUnFlagComment

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	PostUnFlagCommentOptions	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

postUnFlagComment Beispiel

Copy

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

postVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
options	PostVoteOptions	Nein

Antwort

Rückgabe: Option[VoteResponse]

Beispiel

postVote Beispiel

Copy

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

putAwardBadge

Parameter

Name	Type	Required
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

Antwort

Rückgabe: Option[AwardUserBadgeResponse]

Beispiel

putAwardBadge Beispiel

Copy

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

putCloseThread

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

putCloseThread Beispiel

Copy

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

putRemoveBadge

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
badgeId	string	Nein
options	PutRemoveBadgeOptions	Nein

Antwort

Rückgabe: Option[RemoveUserBadgeResponse]

Beispiel

putRemoveBadge Beispiel

Copy

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

putReopenThread

Parameters

Name	Typ	Erforderlich
tenantId	string	Yes
urlId	string	Yes
sso	string = ""	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

putReopenThread Beispiel

Copy

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

setTrustFactor

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	SetTrustFactorOptions	Nein

Antwort

Rückgabe: Option[SetUserTrustFactorResponse]

Beispiel

setTrustFactor Beispiel

Copy

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

createModerator

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	No

Antwort

Rückgabe: Option[CreateModeratorResponse]

Beispiel

createModerator Beispiel

Copy

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

deleteModerator

Parameter

Name	Type	Required
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

Antwort

Returns: Option[APIEmptyResponse]

Beispiel

deleteModerator Beispiel

Copy

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

getModerator

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	No

Antwort

Rückgabe: Option[GetModeratorResponse]

Beispiel

getModerator Beispiel

Copy

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

getModerators

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Rückgabe: Option[GetModeratorsResponse]

Beispiel

getModerators Beispiel

Copy

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

updateModerator

Parameter

Name	Type	Required
tenantId	string	Ja
id	string	Nein
updateModeratorBody	UpdateModeratorBody	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateModerator Beispiel

Copy

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

deleteNotificationCount

Parameter

Name	Type	Required	Description
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteNotificationCount Beispiel

Copy

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

getCachedNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetCachedNotificationCountResponse]

Beispiel

getCachedNotificationCount Beispiel

Copy

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

getNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetNotificationCountOptions	Nein

Antwort

Rückgabe: Option[GetNotificationCountResponse]

Beispiel

getNotificationCount Beispiel

Copy

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

getNotifications

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetNotificationsOptions	Nein

Antwort

Rückgabe: Option[GetNotificationsResponse]

Beispiel

getNotifications Beispiel

Copy

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

updateNotification

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string = ""	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateNotification Beispiel

Copy

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

createV1PageReact

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
title	string = ""	Nein

Antwort

Gibt zurück: Option[CreateV1PageReact]

Beispiel

createV1PageReact Beispiel

Copy

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

createV2PageReact

Parameter

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

Antwort

Rückgabe: Option[CreateV1PageReact]

Beispiel

createV2PageReact Beispiel

Copy

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

deleteV1PageReact

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Rückgabe: Option[CreateV1PageReact]

Beispiel

deleteV1PageReact Beispiel

Copy

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

deleteV2PageReact

Parameter

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

Antwort

Rückgabe: Option[CreateV1PageReact]

Beispiel

deleteV2PageReact Beispiel

Copy

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

getV1PageLikes

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
urlId	string	Yes

Antwort

Rückgabe: Option[GetV1PageLikes]

Beispiel

getV1PageLikes Beispiel

Copy

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

getV2PageReacts

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Rückgabe: Option[GetV2PageReacts]

Beispiel

getV2PageReacts Beispiel

Copy

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

getV2PageReactUsers

Parameter

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

Antwort

Rückgabe: Option[GetV2PageReactUsersResponse]

Beispiel

getV2PageReactUsers Beispiel

Copy

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

addPage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Nein

Antwort

Rückgabe: Option[AddPageAPIResponse]

Beispiel

addPage Beispiel

Copy

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

deletePage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[DeletePageAPIResponse]

Beispiel

deletePage Beispiel

Copy

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

getOfflineUsers

Past commenters on the page who are NOT currently online. Sorted by displayName.
Frühere Kommentatoren auf der Seite, die nicht gerade online sind. Sortiert nach Anzeigename.

Use this after exhausting /users/online to render a "Members" section.
Verwenden Sie dies, nachdem /users/online erschöpft ist, um einen „Mitglieder“-Abschnitt zu rendern.

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Cursor-Paginierung bei commenterName: Der Server durchläuft den Teil {tenantId, urlId, commenterName} vom Index nach afterName vorwärts mittels $gt, ohne $skip-Kosten.

Parameters

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

Response

Rückgabe: Option[PageUsersOfflineResponse]

Example

getOfflineUsers Beispiel

Copy

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

getOnlineUsers

Derzeit online Viewer einer Seite: Personen, deren Websocket‑Session gerade auf die Seite abonniert ist.
Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Viewer, die wir nicht aufzählen).

Parameters

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

Response

Returns: Option[PageUsersOnlineResponse]

Example

getOnlineUsers Beispiel

Copy

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

getPageByURLId

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Rückgabe: Option[GetPageByURLIdAPIResponse]

Beispiel

getPageByURLId Beispiel

Copy

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

getPages

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetPagesAPIResponse]

Beispiel

getPages Beispiel

Copy

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

getPagesPublic

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

Parameters

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetPagesPublicOptions	Nein

Response

Rückgabe: Option[GetPublicPagesResponse]

Beispiel

getPagesPublic Beispiel

Copy

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

getUsersInfo

Bulk-Benutzerinformationen für einen Mandanten. Bei gegebenen userIds werden Anzeigendaten aus User / SSOUser zurückgegeben.
Wird vom Kommentar‑Widget verwendet, um Benutzer, die gerade über ein Präsenz‑Ereignis erschienen sind, anzureichern.
Kein Seitenkontext: Die Privatsphäre wird einheitlich durchgesetzt (private Profile werden maskiert).

Parameters

Name	Type	Required	Description
tenantId	string	Ja
ids	string	Nein

Response

Rückgabe: Option[PageUsersInfoResponse]

Example

getUsersInfo Beispiel

Copy

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

patchPage

Parameter

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

Antwort

Rückgabe: Option[PatchPageAPIResponse]

Beispiel

patchPage Beispiel

Copy

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

deletePendingWebhookEvent

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deletePendingWebhookEvent Beispiel

Copy

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

getPendingWebhookEventCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetPendingWebhookEventCountOptions	Nein

Antwort

Rückgabe: Option[GetPendingWebhookEventCountResponse]

Beispiel

getPendingWebhookEventCount Beispiel

Copy

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

getPendingWebhookEvents

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetPendingWebhookEventsOptions	Nein

Antwort

Rückgabe: Option[GetPendingWebhookEventsResponse]

Beispiel

getPendingWebhookEvents Beispiel

Copy

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

createQuestionConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nein

Antwort

Rückgabe: Option[CreateQuestionConfigResponse]

Beispiel

createQuestionConfig Beispiel

Copy

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

deleteQuestionConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteQuestionConfig Beispiel

Copy

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

getQuestionConfig

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	No

Antwort

Rückgabe: Option[GetQuestionConfigResponse]

Beispiel

getQuestionConfig Beispiel

Copy

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

getQuestionConfigs

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Rückgabe: Option[GetQuestionConfigsResponse]

Beispiel

getQuestionConfigs Beispiel

Copy

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

updateQuestionConfig

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateQuestionConfig Beispiel

Copy

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

createQuestionResult

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nein

Antwort

Rückgabe: Option[CreateQuestionResultResponse]

Beispiel

createQuestionResult Beispiel

Copy

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

deleteQuestionResult

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteQuestionResult Beispiel

Copy

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

getQuestionResult

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetQuestionResultResponse]

Beispiel

Beispiel für getQuestionResult

Copy

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

getQuestionResults

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetQuestionResultsOptions	Nein

Antwort

Rückgabe: Option[GetQuestionResultsResponse]

Beispiel

getQuestionResults Beispiel

Copy

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

updateQuestionResult

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateQuestionResult Beispiel

Copy

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

aggregateQuestionResults

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	AggregateQuestionResultsOptions	Nein

Antwort

Rückgabe: Option[AggregateQuestionResultsResponse]

Beispiel

aggregateQuestionResults Beispiel

Copy

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

bulkAggregateQuestionResults

Parameters

Name	Typ	Erforderlich
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Antwort

Rückgabe: Option[BulkAggregateQuestionResultsResponse]

Beispiel

bulkAggregateQuestionResults Beispiel

Copy

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

combineCommentsWithQuestionResults

Parameter

Name	Type	Required	Description
tenantId	string	Yes
options	CombineCommentsWithQuestionResultsOptions	No

Antwort

Rückgabe: Option[CombineQuestionResultsWithCommentsResponse]

Beispiel

combineCommentsWithQuestionResults Beispiel

Copy

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

addSSOUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Nein

Antwort

Rückgabe: Option[AddSSOUserAPIResponse]

Beispiel

addSSOUser Beispiel

Copy

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

deleteSSOUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
options	DeleteSSOUserOptions	Nein

Antwort

Rückgabe: Option[DeleteSSOUserAPIResponse]

Beispiel

deleteSSOUser Beispiel

Copy

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

getSSOUserByEmail

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
email	string	Nein

Antwort

Rückgabe: Option[GetSSOUserByEmailAPIResponse]

Beispiel

getSSOUserByEmail Beispiel

Copy

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

getSSOUserById

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetSSOUserByIdAPIResponse]

Beispiel

getSSOUserById Beispiel

Copy

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

getSSOUsers

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	int	Nein

Antwort

Rückgabe: Option[GetSSOUsersResponse]

Beispiel

getSSOUsers Beispiel

Copy

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

patchSSOUser

Parameter

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

Antwort

Rückgabe: Option[PatchSSOUserAPIResponse]

Beispiel

patchSSOUser Beispiel

Copy

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

putSSOUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Antwort

Rückgabe: Option[PutSSOUserAPIResponse]

Beispiel

putSSOUser Beispiel

Copy

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

createSubscription

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nein

Antwort

Rückgabe: Option[CreateSubscriptionAPIResponse]

Beispiel

createSubscription Beispiel

Copy

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

deleteSubscription

Parameter

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

Antwort

Rückgabe: Option[DeleteSubscriptionAPIResponse]

Beispiel

deleteSubscription Beispiel

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # Verwenden Sie apiResult nach Bedarf

getSubscriptions

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
userId	string = ""	No

Antwort

Rückgabe: Option[GetSubscriptionsAPIResponse]

Beispiel

getSubscriptions Beispiel

Copy

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

updateSubscription

Parameter

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

Antwort

Rückgabe: Option[UpdateSubscriptionAPIResponse]

Beispiel

updateSubscription Beispiel

Copy

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

getTenantDailyUsages

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetTenantDailyUsagesOptions	Nein

Antwort

Rückgabe: Option[GetTenantDailyUsagesResponse]

Beispiel

getTenantDailyUsages Beispiel

Copy

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

createTenantPackage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nein

Antwort

Rückgabe: Option[CreateTenantPackageResponse]

Beispiel

createTenantPackage Beispiel

Copy

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

deleteTenantPackage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteTenantPackage Beispiel

Copy

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

getTenantPackage

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetTenantPackageResponse]

Beispiel

getTenantPackage Beispiel

Copy

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

getTenantPackages

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Returns: Option[GetTenantPackagesResponse]

Beispiel

getTenantPackages Beispiel

Copy

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

replaceTenantPackage

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

replaceTenantPackage Beispiel

Copy

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

updateTenantPackage

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateTenantPackage Beispiel

Copy

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

createTenantUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Nein

Antwort

Rückgabe: Option[CreateTenantUserResponse]

Beispiel

createTenantUser Beispiel

Copy

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

deleteTenantUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
options	DeleteTenantUserOptions	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteTenantUser Beispiel

Copy

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

getTenantUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetTenantUserResponse]

Beispiel

getTenantUser Beispiel

Copy

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

getTenantUsers

Parameter

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Antwort

Rückgabe: Option[GetTenantUsersResponse]

Beispiel

getTenantUsers Beispiel

Copy

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

replaceTenantUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

replaceTenantUser Beispiel

Copy

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

sendLoginLink

Parameter

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

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

sendLoginLink Beispiel

Copy

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

updateTenantUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

updateTenantUser Beispiel

Copy

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

createTenant

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantBody	CreateTenantBody	Nein

Antwort

Rückgabe: Option[CreateTenantResponse]

Beispiel

createTenant Beispiel

Copy

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

deleteTenant

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Nein
sure	string = ""	Nein

Antwort

Rückgabe: Option[APIEmptyResponse]

Beispiel

deleteTenant Beispiel

Copy

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

getTenant

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	No

Antwort

Rückgabe: Option[GetTenantResponse]

Beispiel

getTenant Beispiel

Copy

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

getTenants

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetTenantsOptions	Nein

Antwort

Rückgabe: Option[GetTenantsResponse]

Beispiel

getTenants Beispiel

Copy

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

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

changeTicketState

Parameter

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

Antwort

Rückgabe: Option[ChangeTicketStateResponse]

Beispiel

changeTicketState Beispiel

Copy

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

createTicket

Parameter

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

Antwort

Rückgabe: Option[CreateTicketResponse]

Beispiel

createTicket Beispiel

Copy

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

getTicket

Parameter

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

Antwort

Rückgabe: Option[GetTicketResponse]

Beispiel

getTicket Beispiel

Copy

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

getTickets

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetTicketsOptions	Nein

Antwort

Rückgabe: Option[GetTicketsResponse]

Beispiel

getTickets Beispiel

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # Verwende Tickets nach Bedarf

getTranslations

Parameter

Name	Typ	Erforderlich
namespace	string	Nein
component	string	Nein
options	GetTranslationsOptions	Nein

Antwort

Rückgabe: Option[GetTranslationsResponse]

Beispiel

getTranslations Beispiel

Copy

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

uploadImage

Upload and resize an image

Parameters

Name	Typ	Erforderlich
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Response

Rückgabe: Option[UploadImageResponse]

Example

uploadImage Beispiel

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # Ergebnis nach Bedarf verwenden

getUserBadgeProgressById

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIGetUserBadgeProgressResponse]

Beispiel

getUserBadgeProgressById Beispiel

Copy

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

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 (badgeProgressOpt, httpResp) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if badgeProgressOpt.isSome:
  let progress = badgeProgressOpt.get()
  echo progress

getUserBadgeProgressList

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetUserBadgeProgressListOptions	Nein

Antwort

Rückgabe: Option[APIGetUserBadgeProgressListResponse]

Beispiel

getUserBadgeProgressList Beispiel

Copy

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

createUserBadge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nein

Antwort

Rückgabe: Option[APICreateUserBadgeResponse]

Beispiel

createUserBadge Beispiel

Copy

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

deleteUserBadge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIEmptySuccessResponse]

Beispiel

deleteUserBadge Beispiel

Copy

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

getUserBadge

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[APIGetUserBadgeResponse]

Beispiel

getUserBadge Beispiel

Copy

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

getUserBadges

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
options	GetUserBadgesOptions	No

Antwort

Rückgabe: Option[APIGetUserBadgesResponse]

Beispiel

getUserBadges Beispiel

Copy

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

updateUserBadge

Parameter

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

Antwort

Rückgabe: Option[APIEmptySuccessResponse]

Beispiel

updateUserBadge Beispiel

Copy

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

getUserNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
sso	string = ""	No

Antwort

Rückgabe: Option[GetUserNotificationCountResponse]

Beispiel

getUserNotificationCount Beispiel

Copy

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

getUserNotifications

Parameters

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
options	GetUserNotificationsOptions	Nein

Response

Rückgabe: Option[GetMyNotificationsResponse]

Beispiel

getUserNotifications Beispiel

Copy

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

resetUserNotificationCount

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string = ""	Nein

Antwort

Rückgabe: Option[ResetUserNotificationsResponse]

Beispiel

resetUserNotificationCount Beispiel

Copy

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

resetUserNotifications

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
options	ResetUserNotificationsOptions	No

Antwort

Rückgabe: Option[ResetUserNotificationsResponse]

Beispiel

resetUserNotifications Beispiel

Copy

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

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

Name	Typ	Erforderlich
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string = ""	No

Antwort

Rückgabe: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Beispiel

updateUserNotificationCommentSubscriptionStatus Beispiel

Copy

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

updateUserNotificationPageSubscriptionStatus

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Antwort

Rückgabe: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Beispiel

updateUserNotificationPageSubscriptionStatus Beispiel

Copy

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

updateUserNotificationStatus

Parameter

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

Antwort

Rückgabe: Option[UpdateUserNotificationStatusResponse]

Beispiel

updateUserNotificationStatus Beispiel

Copy

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

getUserPresenceStatuses

Parameter

Name	Type	Required
tenantId	string	Ja
urlIdWS	string	Nein
userIds	string	Nein

Antwort

Rückgabe: Option[GetUserPresenceStatusesResponse]

Beispiel

getUserPresenceStatuses Beispiel

Copy

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

searchUsers

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

Antwort

Rückgabe: Option[SearchUsersResult]

Beispiel

searchUsers Beispiel

Copy

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

getUser

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Rückgabe: Option[GetUserResponse]

Beispiel

getUser Beispiel

Copy

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

createVote

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
direction	string	Nein
options	CreateVoteOptions	Nein

Antwort

Rückgabe: Option[VoteResponse]

Beispiel

createVote Beispiel

Copy

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

deleteVote

Parameter

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

Antwort

Returns: Option[VoteDeleteResponse]

Beispiel

deleteVote Beispiel

Copy

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

getVotes

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Rückgabe: Option[GetVotesResponse]

Beispiel

getVotes Beispiel

Copy

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

getVotesForUser

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
options	GetVotesForUserOptions	Nein

Antwort

Rückgabe: Option[GetVotesForUserResponse]

Beispiel

getVotesForUser Beispiel

Copy

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

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

Bibliotheksinhalt

Öffentliche vs gesicherte APIs

Schnellstart

Verwendung authentifizierter APIs (DefaultAPI)

Verwendung öffentlicher APIs (PublicAPI)

Verwendung von Moderations‑APIs (ModerationAPI)

Häufige Probleme

API-Aufrufe

Beispiel: Abrufen von Kommentaren

Hinweise

Broadcast-IDs

SSO (Single Sign-On)

SSO-Verwendung

Einfaches SSO

Sicheres SSO

Dokumentation für FastComments

Dokumentation für API-Endpunkte

Dokumentation für Modelle

aggregate

Parameters

Response

Example

getAuditLogs

Parameter

Antwort

Beispiel

logoutPublic

Antwort

Beispiel