FastComments Nim SDK

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

Offizielles Nim-SDK für die FastComments-API

Repository

Voraussetzungen

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installation

Verwendung von Nimble

nimble install fastcomments

Aus dem Quellcode bauen

nimble build

Inhalt der Bibliothek

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

Dokumentation der API-Client-Bibliothek

Öffentliche vs. gesicherte APIs

Für den API-Client gibt es zwei API-Module, api_default und api_public. Das api_default enthält Methoden, die Ihren API-Schlüssel erfordern, und api_public enthält API-Aufrufe, die direkt aus einem Browser/Mobilgerät/etc. ohne Authentifizierung vorgenommen werden können.

Schnellstart

Verwendung authentifizierter APIs (DefaultAPI)

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

import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data

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

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

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

Verwendung öffentlicher APIs (PublicAPI)

Öffentliche Endpunkte erfordern keine Authentifizierung:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

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

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

Häufige Probleme

401 Authentifizierungsfehler: Stellen Sie sicher, dass Sie den x-api-key-Header 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.

API-Aufrufe durchführen

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

Beispiel: Kommentare abrufen

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

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

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

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

Hinweise

Broadcast-IDs

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

SSO (Single Sign-On)

Für SSO-Beispiele siehe unten.

SSO-Nutzung

Einfaches SSO

import fastcomments/sso

let user = newSimpleSSOUserData(
  userId = "user-123",
  email = "user@example.com",
  avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()

echo "SSO Token: ", token

Sicheres SSO

import fastcomments/sso

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

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

echo "Secure SSO Token: ", token

Dokumentation für fastcomments

Dokumentation der API-Endpunkte

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

Klasse	Methode	HTTP-Anfrage	Beschreibung
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Fasst Dokumente zusammen, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg, usw.) werden unterstützt.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	erforderlich tenantId afterId
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsPublic	GET /comments/{tenantId}	erforderlich tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	erforderlich tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	erforderlich tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	erforderlich tenantId urlId userIdWS
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	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 für eine Seite abonniert sind, werden Benachrichtigungen für neue Root-Kommentare erstellt, und auch
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Bild hochladen und skalieren
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Dokumentation der Modelle

Dokumentation zur Autorisierung

api_key

Typ: API-Schlüssel
Name des API-Schlüssel-Parameters: x-api-key
Ort: HTTP-Header

Aggregation

Parameter

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

Antwort

Gibt zurück: Option[AggregationResponse]

Beispiel

Beispiel für aggregate

Copy

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

Audit-Logs abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetAuditLogs_200_response]

Beispiel

Beispiel für getAuditLogs

Copy

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

Vom Kommentar blockieren (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[BlockFromCommentPublic_200_response]

Beispiel

blockFromCommentPublic Beispiel

Copy

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

Blockierung für Kommentar aufheben (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[UnBlockCommentPublic_200_response]

Beispiel

Beispiel für unBlockCommentPublic

Copy

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

Kommentare auf Sperrung prüfen

Parameter

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

Antwort

Gibt zurück: Option[CheckedCommentsForBlocked_200_response]

Beispiel

Beispiel für checkedCommentsForBlocked

Copy

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

Benutzer vom Kommentar blockieren

Parameter

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

Antwort

Gibt zurück: Option[BlockFromCommentPublic_200_response]

Beispiel

blockUserFromComment Beispiel

Copy

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

Kommentar erstellen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[CreateCommentPublic_200_response]

Beispiel

createCommentPublic Beispiel

Copy

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

Kommentar löschen

Parameter

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

Antwort

Gibt zurück: Option[DeleteComment_200_response]

Beispiel

deleteComment Beispiel

Copy

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

Kommentar löschen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[DeleteCommentPublic_200_response]

Beispiel

Beispiel für deleteCommentPublic

Copy

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

Kommentar-Vote löschen

Parameter

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

Antwort

Gibt zurück: Option[DeleteCommentVote_200_response]

Beispiel

deleteCommentVote Beispiel

Copy

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

Kommentar melden

Parameter

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

Antwort

Gibt zurück: Option[FlagComment_200_response]

Beispiel

flagComment Beispiel

Copy

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

Kommentar abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetComment_200_response]

Beispiel

getComment-Beispiel

Copy

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

Kommentare abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetComments_200_response]

Beispiel

getComments Beispiel

Copy

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

Kommentare abrufen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[GetCommentsPublic_200_response]

Beispiel

getCommentsPublic Beispiel

Copy

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

Kommentartext abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetCommentText_200_response]

Beispiel

getCommentText Beispiel

Copy

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

Benutzernamen von Kommentar-Votes abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetCommentVoteUserNames_200_response]

Beispiel

Beispiel für getCommentVoteUserNames

Copy

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

Kommentar sperren

Parameter

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

Antwort

Gibt zurück: Option[LockComment_200_response]

Beispiel

lockComment-Beispiel

Copy

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

Kommentar anpinnen

Parameter

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

Antwort

Gibt zurück: Option[PinComment_200_response]

Beispiel

pinComment Beispiel

Copy

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

Kommentar speichern

Parameter

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

Antwort

Gibt zurück: Option[SaveComment_200_response]

Beispiel

saveComment Beispiel

Copy

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

Kommentare (Batch) speichern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	seq[CreateCommentParams]	Nein
isLive	bool	Nein
doSpamCheck	bool	Nein
sendEmails	bool	Nein
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	Nein
id	string	Nein
unBlockFromCommentParams	UnBlockFromCommentParams	Nein
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: Option[UnBlockCommentPublic_200_response]

Beispiel

saveCommentsBulk Beispiel

Copy

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

Kommentartext setzen

Parameter

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

Antwort

Gibt zurück: Option[SetCommentText_200_response]

Beispiel

Beispiel für setCommentText

Copy

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

Benutzer vom Kommentar entsperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Antwort

Gibt zurück: Option[UnBlockCommentPublic_200_response]

Beispiel

unBlockUserFromComment Beispiel

Copy

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

Kommentar-Meldung entfernen

Parameter

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

Antwort

Gibt zurück: Option[FlagComment_200_response]

Beispiel

unFlagComment Beispiel

Copy

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

Kommentar entsperren

Parameter

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

Antwort

Gibt zurück: Option[LockComment_200_response]

Beispiel

unLockComment Beispiel

Copy

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

Anpinnen aufheben

Parameter

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

Antwort

Gibt zurück: Option[PinComment_200_response]

Beispiel

unPinComment Beispiel

Copy

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

Kommentar aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

updateComment Beispiel

Copy

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

Kommentar bewerten

Parameter

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

Antwort

Gibt zurück: Option[VoteComment_200_response]

Beispiel

voteComment Beispiel

Copy

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

Domain-Konfiguration hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Nein

Antwort

Gibt zurück: Option[AddDomainConfig_200_response]

Beispiel

Beispiel für addDomainConfig

Copy

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

Domain-Konfiguration löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Nein

Antwort

Gibt zurück: Option[DeleteDomainConfig_200_response]

Beispiel

Beispiel für deleteDomainConfig

Copy

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

Domain-Konfiguration abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Nein

Antwort

Gibt zurück: Option[GetDomainConfig_200_response]

Beispiel

getDomainConfig Beispiel

Copy

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

Domain-Konfigurationen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetDomainConfigs_200_response]

Beispiel

getDomainConfigs Beispiel

Copy

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

Domain-Konfiguration teilweise aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Antwort

Gibt zurück: Option[GetDomainConfig_200_response]

Beispiel

patchDomainConfig Beispiel

Copy

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

Domain-Konfiguration ersetzen

Parameter

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

Antwort

Gibt zurück: Option[GetDomainConfig_200_response]

Beispiel

putDomainConfig Beispiel

Copy

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

E-Mail-Vorlage erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Nein

Antwort

Gibt zurück: Option[CreateEmailTemplate_200_response]

Beispiel

Beispiel für createEmailTemplate

Copy

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

E-Mail-Vorlage löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für deleteEmailTemplate

Copy

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

Renderfehler der E-Mail-Vorlage löschen

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

deleteEmailTemplateRenderError Beispiel

Copy

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

E-Mail-Vorlage abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetEmailTemplate_200_response]

Beispiel

getEmailTemplate Beispiel

Copy

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

Definitionen der E-Mail-Vorlagen abrufen

Parameter

Name	Type	Required	Description
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetEmailTemplateDefinitions_200_response]

Beispiel

getEmailTemplateDefinitions Beispiel

Copy

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

Renderfehler der E-Mail-Vorlagen abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetEmailTemplateRenderErrors_200_response]

Beispiel

getEmailTemplateRenderErrors Beispiel

Copy

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

E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetEmailTemplates_200_response]

Beispiel

getEmailTemplates Beispiel

Copy

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

E-Mail-Vorlage rendern

Parameter

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

Antwort

Gibt zurück: Option[RenderEmailTemplate_200_response]

Beispiel

renderEmailTemplate Beispiel

Copy

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

E-Mail-Vorlage aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

updateEmailTemplate Beispiel

Copy

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

Ereignisprotokoll abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetEventLog_200_response]

Beispiel

getEventLog Beispiel

Copy

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

Globales Ereignisprotokoll abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetEventLog_200_response]

Beispiel

getGlobalEventLog Beispiel

Copy

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

Feed-Beitrag erstellen

Parameter

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

Antwort

Gibt zurück: Option[CreateFeedPost_200_response]

Beispiel

createFeedPost Beispiel

Copy

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

Feed-Beitrag erstellen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[CreateFeedPostPublic_200_response]

Beispiel

createFeedPostPublic Beispiel

Copy

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

Feed-Beitrag löschen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[DeleteFeedPostPublic_200_response]

Beispiel

deleteFeedPostPublic Beispiel

Copy

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

Feed-Beiträge abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
limit	int	Nein
tags	seq[string]	Nein

Antwort

Gibt zurück: Option[GetFeedPosts_200_response]

Beispiel

getFeedPosts Beispiel

Copy

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

Feed-Beiträge abrufen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[GetFeedPostsPublic_200_response]

Beispiel

Beispiel für getFeedPostsPublic

Copy

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

Statistiken zu Feed-Beiträgen abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetFeedPostsStats_200_response]

Beispiel

getFeedPostsStats Beispiel

Copy

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

Benutzerreaktionen abrufen (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[GetUserReactsPublic_200_response]

Beispiel

getUserReactsPublic Beispiel

Copy

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

Auf Feed-Beitrag reagieren (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[ReactFeedPostPublic_200_response]

Beispiel

Beispiel für reactFeedPostPublic

Copy

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

Feed-Beitrag aktualisieren

Parameter

Name	Type	Required
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

updateFeedPost Beispiel

Copy

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

Feed-Beitrag aktualisieren (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[CreateFeedPostPublic_200_response]

Beispiel

updateFeedPostPublic Beispiel

Copy

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

Kommentar melden (öffentlich)

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

flagCommentPublic Beispiel

Copy

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

Hashtag hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createHashTagBody	CreateHashTagBody	Nein

Antwort

Gibt zurück: Option[AddHashTag_200_response]

Beispiel

addHashTag Beispiel

Copy

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

Hashtags (Batch) hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nein

Antwort

Gibt zurück: Option[AddHashTagsBulk_200_response]

Beispiel

addHashTagsBulk Beispiel

Copy

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

Hashtag löschen

Parameter

Name	Typ	Erforderlich
tag	string	Nein
tenantId	string	Ja
deleteHashTagRequest	DeleteHashTagRequest	Nein

Antwort

Rückgabe: Option[FlagCommentPublic_200_response]

Beispiel

deleteHashTag Beispiel

Copy

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

Hashtags abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
page	float64	Nein

Antwort

Gibt zurück: Option[GetHashTags_200_response]

Beispiel

getHashTags Beispiel

Copy

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

Hashtag teilweise aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[PatchHashTag_200_response]

Beispiel

patchHashTag Beispiel

Copy

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

Moderator erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Nein

Antwort

Gibt zurück: Option[CreateModerator_200_response]

Beispiel

createModerator Beispiel

Copy

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

Moderator löschen

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

deleteModerator Beispiel

Copy

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

Moderator abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetModerator_200_response]

Beispiel

getModerator Beispiel

Copy

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

Moderatoren abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetModerators_200_response]

Beispiel

Beispiel für getModerators

Copy

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

Moderator aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

updateModerator-Beispiel

Copy

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

Benachrichtigungszähler löschen

Parameters

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für deleteNotificationCount

Copy

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

Zwischengespeicherten Benachrichtigungszähler abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetCachedNotificationCount_200_response]

Beispiel

getCachedNotificationCount Beispiel

Copy

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

Benachrichtigungszähler abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetNotificationCount_200_response]

Beispiel

getNotificationCount Beispiel

Copy

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

Benachrichtigungen abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetNotifications_200_response]

Beispiel

getNotifications Beispiel

Copy

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

Benachrichtigung aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für updateNotification

Copy

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

Seite hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Nein

Antwort

Gibt zurück: Option[AddPageAPIResponse]

Beispiel

addPage Beispiel

Copy

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

Seite löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[DeletePageAPIResponse]

Beispiel

deletePage Beispiel

Copy

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

Seite nach URL-ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[GetPageByURLIdAPIResponse]

Beispiel

getPageByURLId Beispiel

Copy

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

Seiten abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: Option[GetPagesAPIResponse]

Beispiel

getPages Beispiel

Copy

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

Seite teilweise aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[PatchPageAPIResponse]

Beispiel

patchPage Beispiel

Copy

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

Ausstehendes Webhook-Ereignis löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	No

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für deletePendingWebhookEvent

Copy

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

Anzahl ausstehender Webhook-Ereignisse abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No

Antwort

Gibt zurück: Option[GetPendingWebhookEventCount_200_response]

Beispiel

Beispiel für getPendingWebhookEventCount

Copy

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

Ausstehende Webhook-Ereignisse abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetPendingWebhookEvents_200_response]

Beispiel

Beispiel für getPendingWebhookEvents

Copy

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

Fragekonfiguration erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Nein

Antwort

Gibt zurück: Option[CreateQuestionConfig_200_response]

Beispiel

createQuestionConfig Beispiel

Copy

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

Fragekonfiguration löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für deleteQuestionConfig

Copy

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

Fragekonfiguration abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetQuestionConfig_200_response]

Beispiel

getQuestionConfig Beispiel

Copy

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

Fragekonfigurationen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetQuestionConfigs_200_response]

Beispiel

getQuestionConfigs Beispiel

Copy

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

Fragekonfiguration aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für updateQuestionConfig

Copy

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

Frageergebnis erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Nein

Antwort

Gibt zurück: Option[CreateQuestionResult_200_response]

Beispiel

createQuestionResult Beispiel

Copy

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

Frageergebnis löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

deleteQuestionResult Beispiel

Copy

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

Frageergebnis abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetQuestionResult_200_response]

Beispiel

getQuestionResult Beispiel

Copy

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

Frageergebnisse abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetQuestionResults_200_response]

Beispiel

getQuestionResults Beispiel

Copy

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

Frageergebnis aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für updateQuestionResult

Copy

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

Frageergebnisse aggregieren

Parameter

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

Antwort

Gibt zurück: Option[AggregateQuestionResults_200_response]

Beispiel

aggregateQuestionResults Beispiel

Copy

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

Frageergebnisse (Batch) aggregieren

Parameter

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

Antwort

Gibt zurück: Option[BulkAggregateQuestionResults_200_response]

Beispiel

Beispiel für bulkAggregateQuestionResults

Copy

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

Kommentare mit Frageergebnissen kombinieren

Parameter

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

Antwort

Gibt zurück: Option[CombineCommentsWithQuestionResults_200_response]

Beispiel

combineCommentsWithQuestionResults Beispiel

Copy

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

SSO-Benutzer hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Nein

Antwort

Gibt zurück: Option[AddSSOUserAPIResponse]

Beispiel

addSSOUser Beispiel

Copy

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

SSO-Benutzer löschen

Parameter

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

Antwort

Gibt zurück: Option[DeleteSSOUserAPIResponse]

Beispiel

deleteSSOUser Beispiel

Copy

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

SSO-Benutzer nach E-Mail abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
email	string	Nein

Antwort

Gibt zurück: Option[GetSSOUserByEmailAPIResponse]

Beispiel

getSSOUserByEmail Beispiel

Copy

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

SSO-Benutzer nach ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetSSOUserByIdAPIResponse]

Beispiel

Beispiel für getSSOUserById

Copy

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

SSO-Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	int	Nein

Antwort

Gibt zurück: Option[GetSSOUsers_200_response]

Beispiel

getSSOUsers Beispiel

Copy

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

SSO-Benutzer teilweise aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[PatchSSOUserAPIResponse]

Beispiel

patchSSOUser Beispiel

Copy

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

SSO-Benutzer ersetzen

Parameter

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

Antwort

Gibt zurück: Option[PutSSOUserAPIResponse]

Beispiel

putSSOUser Beispiel

Copy

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

Abonnement erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Nein

Antwort

Gibt zurück: Option[CreateSubscriptionAPIResponse]

Beispiel

createSubscription Beispiel

Copy

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

Abonnement löschen

Parameter

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

Antwort

Gibt zurück: Option[DeleteSubscriptionAPIResponse]

Beispiel

deleteSubscription Beispiel

Copy

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

Abonnements abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Nein

Antwort

Gibt zurück: Option[GetSubscriptionsAPIResponse]

Beispiel

getSubscriptions Beispiel

Copy

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

Tägliche Nutzungen des Mandanten abrufen

Parameter

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

Antwort

Rückgabe: Option[GetTenantDailyUsages_200_response]

Beispiel

getTenantDailyUsages Beispiel

Copy

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

Mandantenpaket erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Nein

Antwort

Gibt zurück: Option[CreateTenantPackage_200_response]

Beispiel

createTenantPackage Beispiel

Copy

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

Mandantenpaket löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

deleteTenantPackage Beispiel

Copy

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

Mandantenpaket abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetTenantPackage_200_response]

Beispiel

getTenantPackage Beispiel

Copy

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

Mandantenpakete abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetTenantPackages_200_response]

Beispiel

Beispiel für getTenantPackages

Copy

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

Mandantenpaket ersetzen

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

replaceTenantPackage Beispiel

Copy

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

Mandantenpaket aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

updateTenantPackage Beispiel

Copy

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

Mandantenbenutzer erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Nein

Antwort

Gibt zurück: Option[CreateTenantUser_200_response]

Beispiel

createTenantUser Beispiel

Copy

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

Mandantenbenutzer löschen

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

deleteTenantUser Beispiel

Copy

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

Mandantenbenutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetTenantUser_200_response]

Beispiel

getTenantUser Beispiel

Copy

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

Mandantenbenutzer abrufen

Parameter

Name	Type	Erforderlich	Beschreibung
tenantId	string	Ja
skip	float64	Nein

Antwort

Gibt zurück: Option[GetTenantUsers_200_response]

Beispiel

getTenantUsers Beispiel

Copy

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

Mandantenbenutzer ersetzen

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für replaceTenantUser

Copy

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

Login-Link senden

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

sendLoginLink Beispiel

Copy

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

Mandantenbenutzer aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

Beispiel für updateTenantUser

Copy

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

Mandant erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantBody	CreateTenantBody	Nein

Antwort

Gibt zurück: Option[CreateTenant_200_response]

Beispiel

createTenant Beispiel

Copy

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

Mandant löschen

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

deleteTenant Beispiel

Copy

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

Mandant abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetTenant_200_response]

Beispiel

getTenant Beispiel

Copy

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

Mandanten abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
meta	string	No
skip	float64	No

Antwort

Gibt zurück: Option[GetTenants_200_response]

Beispiel

Beispiel für getTenants

Copy

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

Mandant aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[FlagCommentPublic_200_response]

Beispiel

updateTenant Beispiel

Copy

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

Bild hochladen

Parameter

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

Antwort

Gibt zurück: Option[UploadImageResponse]

Beispiel

uploadImage Beispiel

Copy

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

Benutzerbadge-Fortschritt nach ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetUserBadgeProgressById_200_response]

Beispiel

Beispiel für getUserBadgeProgressById

Copy

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

Benutzerbadge-Fortschritt nach Benutzer-ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Nein

Antwort

Gibt zurück: Option[GetUserBadgeProgressById_200_response]

Beispiel

getUserBadgeProgressByUserId Beispiel

Copy

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

Liste des Benutzerbadge-Fortschritts abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetUserBadgeProgressList_200_response]

Beispiel

getUserBadgeProgressList Beispiel

Copy

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

Benutzerabzeichen erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Nein

Antwort

Gibt zurück: Option[CreateUserBadge_200_response]

Beispiel

createUserBadge Beispiel

Copy

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

Benutzerabzeichen löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[UpdateUserBadge_200_response]

Beispiel

deleteUserBadge Beispiel

Copy

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

Benutzerabzeichen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetUserBadge_200_response]

Beispiel

getUserBadge Beispiel

Copy

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

Benutzerabzeichen abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetUserBadges_200_response]

Beispiel

getUserBadges Beispiel

Copy

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

Benutzerabzeichen aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[UpdateUserBadge_200_response]

Beispiel

updateUserBadge Beispiel

Copy

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

Benutzer-Benachrichtigungszähler abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[GetUserNotificationCount_200_response]

Beispiel

getUserNotificationCount Beispiel

Copy

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

Benutzerbenachrichtigungen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
pageSize	int	No
afterId	string	No
includeContext	bool	No
afterCreatedAt	int64	No
unreadOnly	bool	No
dmOnly	bool	No
noDm	bool	No
includeTranslations	bool	No
sso	string	No

Antwort

Gibt zurück: Option[GetUserNotifications_200_response]

Beispiel

getUserNotifications Beispiel

Copy

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

Benutzer-Benachrichtigungszähler zurücksetzen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: Option[ResetUserNotifications_200_response]

Beispiel

resetUserNotificationCount Beispiel

Copy

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

Benutzerbenachrichtigungen zurücksetzen

Parameter

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

Antwort

Gibt zurück: Option[ResetUserNotifications_200_response]

Beispiel

resetUserNotifications Beispiel

Copy

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

Kommentar-Abonnementstatus des Benutzers aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[UpdateUserNotificationStatus_200_response]

Beispiel

Beispiel für updateUserNotificationCommentSubscriptionStatus

Copy

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

Seiten-Abonnementstatus des Benutzers aktualisieren

Parameter

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

Antwort

Gibt zurück: Option[UpdateUserNotificationStatus_200_response]

Beispiel

updateUserNotificationPageSubscriptionStatus Beispiel

Copy

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

Benachrichtigungsstatus des Benutzers aktualisieren

Parameter

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

Response

Rückgabe: Option[UpdateUserNotificationStatus_200_response]

Beispiel

updateUserNotificationStatus Beispiel

Copy

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

Status der Benutzeranwesenheit abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetUserPresenceStatuses_200_response]

Beispiel

getUserPresenceStatuses Beispiel

Copy

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

Benutzer suchen

Parameter

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

Antwort

Gibt zurück: Option[SearchUsers_200_response]

Beispiel

searchUsers Beispiel

Copy

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

Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Nein

Antwort

Gibt zurück: Option[GetUser_200_response]

Beispiel

getUser Beispiel

Copy

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

Abstimmung erstellen

Parameter

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

Antwort

Gibt zurück: Option[VoteComment_200_response]

Beispiel

createVote Beispiel

Copy

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

Abstimmung löschen

Parameter

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

Antwort

Gibt zurück: Option[DeleteCommentVote_200_response]

Beispiel

deleteVote Beispiel

Copy

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

Abstimmungen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: Option[GetVotes_200_response]

Beispiel

getVotes Beispiel

Copy

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

Abstimmungen für Benutzer abrufen

Parameter

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

Antwort

Gibt zurück: Option[GetVotesForUser_200_response]

Beispiel

getVotesForUser Beispiel

Copy

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

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-Logs

Vom Kommentar blockieren

Gesperrte Kommentare prüfen

Kommentare

Domain-Konfigurationen

E-Mail-Vorlagen

Ereignisprotokoll

Feed-Beiträge

Kommentar melden

Hashtags

Moderatoren

Benachrichtigungszähler

Benachrichtigungen

Seiten

Ausstehende Webhook-Ereignisse

Fragekonfigurationen

Frageergebnisse

Aggregation von Frageergebnissen

SSO-Benutzer

Abonnements

Tägliche Nutzung des Mandanten

Mandantenpakete

Mandantenbenutzer

Mandanten

Bild hochladen

Fortschritt von Benutzerabzeichen

Benutzerabzeichen

Benutzerbenachrichtigungen

Status der Benutzeranwesenheit

Benutzersuche

Benutzer

Abstimmungen

FastComments Nim SDK

Repository

Voraussetzungen

Installation

Verwendung von Nimble

Aus dem Quellcode bauen

Inhalt der Bibliothek

Öffentliche vs. gesicherte APIs

Schnellstart

Verwendung authentifizierter APIs (DefaultAPI)

Verwendung öffentlicher APIs (PublicAPI)

Häufige Probleme

API-Aufrufe durchführen

Beispiel: Kommentare abrufen

Hinweise

Broadcast-IDs

SSO (Single Sign-On)

SSO-Nutzung

Einfaches SSO

Sicheres SSO

Dokumentation für fastcomments

Dokumentation für fastcomments

Dokumentation der API-Endpunkte

Dokumentation der Modelle

Dokumentation zur Autorisierung

api_key

Aggregation

Parameter

Antwort

Beispiel

Audit-Logs abrufen

Parameter

Antwort

Beispiel

Vom Kommentar blockieren (öffentlich)

Parameter

Antwort

Beispiel

Blockierung für Kommentar aufheben (öffentlich)

Parameter

Antwort

Beispiel