FastComments Nim SDK

Questo è l'SDK Nim ufficiale per FastComments.

SDK Nim ufficiale per l'API di FastComments

Repository

Requisiti

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installazione

Utilizzo di Nimble

nimble install fastcomments

Compilazione dal Sorgente

nimble build

Contenuto della libreria

Questa libreria contiene il client API generato e le utilità SSO per facilitare l'interazione con l'API.

API Client Library Docs

API pubbliche vs protette

Per il client API, ci sono due moduli API, api_default e api_public. api_default contiene metodi che richiedono la tua API key, e api_public contiene chiamate API che possono essere effettuate direttamente da un browser/dispositivo mobile/etc. senza autenticazione.

Avvio rapido

Utilizzo delle API Autenticate (DefaultAPI)

Importante: Gli endpoint autenticati richiedono che la tua chiave API sia impostata nell'intestazione x-api-key.

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"

# Effettua chiamate API autenticate
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"

Utilizzo delle API Pubbliche (PublicAPI)

Gli endpoint pubblici non richiedono autenticazione:

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Effettua chiamate API pubbliche
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"

Problemi comuni

Errore di autenticazione 401: Assicurati di impostare l'intestazione x-api-key sul tuo HttpClient prima di effettuare richieste DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Classe API errata: Usa api_default per richieste autenticate lato server, api_public per richieste lato client/pubbliche.

Effettuare chiamate API

Tutti i metodi API in questo SDK restituiscono tuple di (Option[ResponseType], Response). Il primo elemento contiene la risposta analizzata se ha successo, e il secondo elemento è la risposta HTTP grezza.

Esempio: Recupero dei commenti

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"

Note

ID di broadcast

Vedrai che dovrai passare un broadcastId in alcune chiamate API. Quando riceverai eventi, otterrai questo ID, così saprai di ignorare l'evento se prevedi di applicare le modifiche in modo ottimistico sul client (cosa che probabilmente vorrai fare poiché offre la migliore esperienza). Passa qui un UUID. L'ID dovrebbe essere abbastanza unico da non comparire due volte in una sessione del browser.

SSO (Single Sign-On)

Per esempi di SSO, vedi sotto.

Utilizzo SSO

SSO Semplice

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

SSO Sicuro

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

Documentazione per FastComments

Documentazione per fastcomments

Documentazione per gli endpoint API

All URIs are relative to https://fastcomments.com

Classe	Metodo	Richiesta HTTP	Descrizione
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	Aggrega i documenti raggruppandoli (se groupBy è fornito) e applicando più operazioni. Sono supportate diverse operazioni (es. sum, countDistinct, avg, ecc.).
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	richiede 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}	richiede tenantId, urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	richiede tenantId, urlId, userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	richiede tenantId, afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	richiede 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}	Abilita o disabilita le notifiche per uno specifico commento.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, le notifiche vengono create per i nuovi commenti principali, e anche
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Carica e ridimensiona un'immagine
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentazione per i Modelli

Documentazione per l'Autorizzazione

api_key

Tipo: Chiave API
Nome del parametro della chiave API: x-api-key
Posizione: Intestazione HTTP

Aggregazione

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
aggregationRequest	AggregationRequest	No
parentTenantId	string	No
includeStats	bool	No

Risposta

Restituisce: Option[AggregationResponse]

Esempio

Esempio di 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

Recupera log audit

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
limit	float64	No
skip	float64	No
order	SORTDIR	No
after	float64	No
before	float64	No

Risposta

Restituisce: Option[GetAuditLogs_200_response]

Esempio

Esempio di 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

Blocca da commento pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string	No

Risposta

Restituisce: Option[BlockFromCommentPublic_200_response]

Esempio

Esempio di blockFromCommentPublic

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

Sblocca commento pubblico

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
commentId	string	Sì
publicBlockFromCommentParams	PublicBlockFromCommentParams	No
sso	string	No

Risposta

Restituisce: Option[UnBlockCommentPublic_200_response]

Esempio

Esempio di 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

Verifica commenti bloccati

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentIds	string	No
sso	string	No

Risposta

Restituisce: Option[CheckedCommentsForBlocked_200_response]

Esempio

Esempio di 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, ")"

Blocca utente da commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[BlockFromCommentPublic_200_response]

Esempio

Esempio di blockUserFromComment

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"

Crea commento pubblico

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
broadcastId	string	No
commentData	CommentData	No
sessionId	string	No
sso	string	No

Risposta

Restituisce: Option[CreateCommentPublic_200_response]

Esempio

Esempio di createCommentPublic

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`

Elimina commento

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
id	string	No
contextUserId	string	No
isLive	bool	No

Risposta

Restituisce: Option[DeleteComment_200_response]

Esempio

Esempio di deleteComment

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"

Elimina commento pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	No
editKey	string	No
sso	string	No

Risposta

Restituisce: Option[DeleteCommentPublic_200_response]

Esempio

Esempio di 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

Elimina voto al commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
voteId	string	No
urlId	string	Sì
broadcastId	string	No
editKey	string	No
sso	string	No

Risposta

Restituisce: Option[DeleteCommentVote_200_response]

Esempio

Esempio di deleteCommentVote

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"

Segnala commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[FlagComment_200_response]

Esempio

Esempio di flagComment

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

Recupera commento

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetComment_200_response]

Esempio

Esempio di getComment

Copy

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

Recupera commenti

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
page	int	No
limit	int	No
skip	int	No
asTree	bool	No
skipChildren	int	No
limitChildren	int	No
maxTreeDepth	int	No
urlId	string	Sì
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No

Risposta

Restituisce: Option[GetComments_200_response]

Esempio

Esempio di getComments

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

Recupera commenti pubblici

Parametri

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

Risposta

Restituisce: Option[GetCommentsPublic_200_response]

Esempio

Esempio getCommentsPublic

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

Recupera testo del commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
editKey	string	No
sso	string	No

Risposta

Restituisce: Option[GetCommentText_200_response]

Esempio

Esempio di getCommentText

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"

Recupera nomi utenti che hanno votato il commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
dir	int	No
sso	string	No

Risposta

Restituisce: Option[GetCommentVoteUserNames_200_response]

Esempio

Esempio 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

Blocca commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[LockComment_200_response]

Esempio

Esempio di lockComment

Copy

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

Fissa commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[PinComment_200_response]

Esempio

Esempio di pinComment

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"

Salva commento

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
createCommentParams	CreateCommentParams	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool	No

Risposta

Restituisce: Option[SaveComment_200_response]

Esempio

Esempio di saveComment

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

Salva commenti in blocco

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createCommentParams	seq[CreateCommentParams]	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool): (Option[seq[SaveComment_200_response]]	No
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[UnBlockCommentPublic_200_response]

Esempio

Esempio di saveCommentsBulk

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

Imposta testo del commento

Parametri

Name	Type	Required
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
editKey	string	No
sso	string	No

Risposta

Restituisce: Option[SetCommentText_200_response]

Esempio

Esempio di 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()

Sblocca utente dal commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[UnBlockCommentPublic_200_response]

Esempio

Esempio di unBlockUserFromComment

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

Rimuovi segnalazione del commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[FlagComment_200_response]

Esempio

Esempio di unFlagComment

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"

Sblocca commento

Parametri

Name	Type	Required
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[LockComment_200_response]

Esempio

Esempio di unLockComment

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

Rimuovi fissaggio commento

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[PinComment_200_response]

Esempio

Esempio di unPinComment

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

Aggiorna commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updatableCommentParams	UpdatableCommentParams	No
contextUserId	string	No
doSpamCheck	bool	No
isLive	bool	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateComment

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

Vota commento

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
urlId	string	Sì
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
sessionId	string	No
sso	string	No

Risposta

Restituisce: Option[VoteComment_200_response]

Esempio

Esempio di voteComment

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"

Aggiungi configurazione dominio

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
addDomainConfigParams	AddDomainConfigParams	No

Risposta

Restituisce: Option[AddDomainConfig_200_response]

Esempio

Esempio di 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

Elimina configurazione dominio

Parametri

Name	Type	Required	Description
tenantId	string	Sì
domain	string	No

Risposta

Restituisce: Option[DeleteDomainConfig_200_response]

Esempio

Esempio di 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

Recupera configurazione dominio

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	No

Risposta

Restituisce: Option[GetDomainConfig_200_response]

Esempio

Esempio di getDomainConfig

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

Recupera configurazioni dominio

Parametri

Name	Type	Required	Description
tenantId	string	Sì

Risposta

Restituisce: Option[GetDomainConfigs_200_response]

Esempio

Esempio di getDomainConfigs

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

Applica patch a configurazione dominio

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Risposta

Restituisce: Option[GetDomainConfig_200_response]

Esempio

Esempio di patchDomainConfig

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"

Sostituisci configurazione dominio

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Risposta

Restituisce: Option[GetDomainConfig_200_response]

Esempio

Esempio di putDomainConfig

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

Crea modello email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createEmailTemplateBody	CreateEmailTemplateBody	No

Risposta

Restituisce: Option[CreateEmailTemplate_200_response]

Esempio

Esempio di 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

Elimina modello email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteEmailTemplate

Copy

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

Elimina errore di rendering del modello email

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
errorId	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteEmailTemplateRenderError

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

Recupera modello email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetEmailTemplate_200_response]

Esempio

Esempio di getEmailTemplate

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

Recupera definizioni modelli email

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì

Risposta

Restituisce: Option[GetEmailTemplateDefinitions_200_response]

Esempio

Esempio di getEmailTemplateDefinitions

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

Recupera errori di rendering dei modelli email

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
skip	float64	No

Risposta

Restituisce: Option[GetEmailTemplateRenderErrors_200_response]

Esempio

Esempio di getEmailTemplateRenderErrors

Copy

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

Recupera modelli email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetEmailTemplates_200_response]

Esempio

Esempio di getEmailTemplates

Copy

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

Renderizza modello email

Parametri

Name	Type	Required
tenantId	string	Sì
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string	No

Risposta

Restituisce: Option[RenderEmailTemplate_200_response]

Esempio

Esempio di renderEmailTemplate

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

Aggiorna modello email

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateEmailTemplate

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

Recupera registro eventi

Parametri

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Risposta

Restituisce: Option[GetEventLog_200_response]

Esempio

Esempio di getEventLog

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

Recupera registro eventi globale

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Risposta

Restituisce: Option[GetEventLog_200_response]

Esempio

Esempio di getGlobalEventLog

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"

Crea post feed

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
isLive	bool	No
doSpamCheck	bool	No
skipDupCheck	bool	No

Risposta

Restituisce: Option[CreateFeedPost_200_response]

Esempio

Esempio di createFeedPost

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

Crea post feed pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createFeedPostParams	CreateFeedPostParams	No
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[CreateFeedPostPublic_200_response]

Esempio

Esempio di createFeedPostPublic

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

Elimina post feed pubblico

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
postId	string	No
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[DeleteFeedPostPublic_200_response]

Esempio

Esempio di deleteFeedPostPublic

Copy

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

Recupera post feed

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
afterId	string	No
limit	int	No
tags	seq[string]	No

Risposta

Restituisce: Option[GetFeedPosts_200_response]

Esempio

Esempio getFeedPosts

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

Recupera post feed pubblici

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
afterId	string	No
limit	int	No
tags	seq[string]	No
sso	string	No
isCrawler	bool	No
includeUserInfo	bool	No

Risposta

Restituisce: Option[GetFeedPostsPublic_200_response]

Esempio

Esempio di 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

Recupera statistiche post feed

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
postIds	seq[string]	No
sso	string	No

Risposta

Restituisce: Option[GetFeedPostsStats_200_response]

Esempio

Esempio di getFeedPostsStats

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

Recupera reazioni degli utenti pubbliche

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
postIds	seq[string]	No
sso	string	No

Risposta

Restituisce: Option[GetUserReactsPublic_200_response]

Esempio

Esempio getUserReactsPublic

Copy

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

Reagisci a post feed pubblico

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
postId	string	No
reactBodyParams	ReactBodyParams	No
isUndo	bool	No
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[ReactFeedPostPublic_200_response]

Esempio

Esempio di 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

Aggiorna post feed

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
feedPost	FeedPost	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateFeedPost

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

Aggiorna post feed pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[CreateFeedPostPublic_200_response]

Esempio

Esempio di updateFeedPostPublic

Copy

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

Segnala commento pubblico

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
isFlagged	bool	No
sso	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di flagCommentPublic

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

Aggiungi hashtag

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createHashTagBody	CreateHashTagBody	No

Risposta

Restituisce: Option[AddHashTag_200_response]

Esempio

Esempio di addHashTag

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"

Aggiungi hashtag in blocco

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Risposta

Restituisce: Option[AddHashTagsBulk_200_response]

Esempio

Esempio di addHashTagsBulk

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

Elimina hashtag

Parametri

Name	Tipo	Obbligatorio
tag	string	No
tenantId	string	Sì
deleteHashTagRequest	DeleteHashTagRequest	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteHashTag

Copy

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

Recupera hashtag

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
page	float64	No

Risposta

Restituisce: Option[GetHashTags_200_response]

Esempio

Esempio di getHashTags

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"

Applica patch a hashtag

Parametri

Name	Type	Obbligatorio
tag	string	No
tenantId	string	Sì
updateHashTagBody	UpdateHashTagBody	No

Risposta

Restituisce: Option[PatchHashTag_200_response]

Esempio

Esempio di patchHashTag

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

Crea moderatore

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createModeratorBody	CreateModeratorBody	No

Risposta

Restituisce: Option[CreateModerator_200_response]

Esempio

Esempio di createModerator

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

Elimina moderatore

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
id	string	No
sendEmail	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteModerator

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

Recupera moderatore

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetModerator_200_response]

Esempio

Esempio getModerator

Copy

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

Recupera moderatori

Parametri

Name	Type	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetModerators_200_response]

Esempio

Esempio di 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

Aggiorna moderatore

Parametri

Nome	Tipo	Richiesto
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateModerator

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

Elimina conteggio notifiche

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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

Recupera conteggio notifiche in cache

Parametri

Name	Type	Required	Description
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetCachedNotificationCount_200_response]

Esempio

Esempio di getCachedNotificationCount

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

Recupera conteggio notifiche

Parametri

Nome	Type	Richiesto
tenantId	string	Sì
userId	string	No
urlId	string	Sì
fromCommentId	string	No
viewed	bool	No

Risposta

Restituisce: Option[GetNotificationCount_200_response]

Esempio

Esempio di getNotificationCount

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"

Recupera notifiche

Parametri

Name	Type	Required
tenantId	string	Sì
userId	string	No
urlId	string	Sì
fromCommentId	string	No
viewed	bool	No
skip	float64	No

Risposta

Restituisce: Option[GetNotifications_200_response]

Esempio

Esempio di getNotifications

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

Aggiorna notifica

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateNotificationBody	UpdateNotificationBody	No
userId	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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

Aggiungi pagina

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPIPageData	CreateAPIPageData	No

Risposta

Restituisce: Option[AddPageAPIResponse]

Esempio

Esempio di addPage

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

Elimina pagina

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[DeletePageAPIResponse]

Esempio

Esempio di deletePage

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

Recupera pagina per URL/ID

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
urlId	string	Sì

Risposta

Restituisce: Option[GetPageByURLIdAPIResponse]

Esempio

Esempio di getPageByURLId

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

Recupera pagine

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì

Risposta

Restituisce: Option[GetPagesAPIResponse]

Esempio

Esempio di getPages

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

Applica patch a pagina

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Risposta

Restituisce: Option[PatchPageAPIResponse]

Esempio

Esempio di patchPage

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

Elimina evento webhook in sospeso

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deletePendingWebhookEvent

Copy

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

Recupera conteggio eventi webhook in sospeso

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No

Risposta

Restituisce: Option[GetPendingWebhookEventCount_200_response]

Esempio

Esempio di 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

Recupera eventi webhook in sospeso

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No
skip	float64	No

Risposta

Restituisce: Option[GetPendingWebhookEvents_200_response]

Esempio

Esempio di 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"

Crea configurazione domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionConfigBody	CreateQuestionConfigBody	No

Risposta

Restituisce: Option[CreateQuestionConfig_200_response]

Esempio

Esempio di createQuestionConfig

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

Elimina configurazione domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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, ")"

Recupera configurazione domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetQuestionConfig_200_response]

Esempio

Esempio di getQuestionConfig

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"

Recupera configurazioni domande

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetQuestionConfigs_200_response]

Esempio

Esempio di getQuestionConfigs

Copy

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

Aggiorna configurazione domanda

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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"

Crea risultato domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionResultBody	CreateQuestionResultBody	No

Risposta

Restituisce: Option[CreateQuestionResult_200_response]

Esempio

Esempio di createQuestionResult

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

Elimina risultato domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteQuestionResult

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

Recupera risultato domanda

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetQuestionResult_200_response]

Esempio

Esempio di getQuestionResult

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"

Recupera risultati domande

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	float64	No

Risposta

Restituisce: Option[GetQuestionResults_200_response]

Esempio

Esempio getQuestionResults

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

Aggiorna risultato domanda

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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

Aggregazione risultati domande

Parametri

Name	Type	Required
tenantId	string	Sì
questionId	string	No
questionIds	seq[string]	No
urlId	string	Sì
timeBucket	AggregateTimeBucket	No
startDate	string	No
forceRecalculate	bool	No

Risposta

Restituisce: Option[AggregateQuestionResults_200_response]

Esempio

Esempio di aggregateQuestionResults

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

Aggregazione risultati domande in blocco

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

Risposta

Restituisce: Option[BulkAggregateQuestionResults_200_response]

Esempio

Esempio di 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

Combina commenti con risultati delle domande

Parametri

Name	Type	Richiesto
tenantId	string	Sì
questionId	string	No
questionIds	seq[string]	No
urlId	string	Sì
startDate	string	No
forceRecalculate	bool	No
minValue	float64	No
maxValue	float64	No
limit	float64	No

Risposta

Restituisce: Option[CombineCommentsWithQuestionResults_200_response]

Esempio

Esempio di combineCommentsWithQuestionResults

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

Aggiungi utente SSO

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createAPISSOUserData	CreateAPISSOUserData	No

Risposta

Restituisce: Option[AddSSOUserAPIResponse]

Esempio

Esempio di addSSOUser

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

Elimina utente SSO

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
deleteComments	bool	No
commentDeleteMode	string	No

Risposta

Restituisce: Option[DeleteSSOUserAPIResponse]

Esempio

Esempio di deleteSSOUser

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

Recupera utente SSO per email

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
email	string	No

Risposta

Restituisce: Option[GetSSOUserByEmailAPIResponse]

Esempio

Esempio getSSOUserByEmail

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

Recupera utente SSO per ID

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetSSOUserByIdAPIResponse]

Esempio

Esempio di 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

Recupera utenti SSO

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	int	No

Risposta

Restituisce: Option[GetSSOUsers_200_response]

Esempio

Esempio di getSSOUsers

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

Applica patch a utente SSO

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Risposta

Restituisce: Option[PatchSSOUserAPIResponse]

Esempio

Esempio patchSSOUser

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

Sostituisci utente SSO

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Risposta

Restituisce: Option[PutSSOUserAPIResponse]

Esempio

Esempio di putSSOUser

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

Crea sottoscrizione

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Risposta

Restituisce: Option[CreateSubscriptionAPIResponse]

Esempio

Esempio di createSubscription

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

Elimina sottoscrizione

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
userId	string	No

Risposta

Restituisce: Option[DeleteSubscriptionAPIResponse]

Esempio

Esempio di deleteSubscription

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"

Recupera sottoscrizioni

Parametri

Name	Type	Required	Description
tenantId	string	Sì
userId	string	No

Risposta

Restituisce: Option[GetSubscriptionsAPIResponse]

Esempio

Esempio di getSubscriptions

Copy

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

Recupera utilizzi giornalieri del tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
yearNumber	float64	No
monthNumber	float64	No
dayNumber	float64	No
skip	float64	No

Risposta

Restituisce: Option[GetTenantDailyUsages_200_response]

Esempio

Esempio di getTenantDailyUsages

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"

Crea pacchetto tenant

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
createTenantPackageBody	CreateTenantPackageBody	No

Risposta

Restituisce: Option[CreateTenantPackage_200_response]

Esempio

Esempio di createTenantPackage

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

Elimina pacchetto tenant

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteTenantPackage

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"

Recupera pacchetto tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantPackage_200_response]

Esempio

Esempio di getTenantPackage

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"

Recupera pacchetti tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetTenantPackages_200_response]

Esempio

Esempio 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

Sostituisci pacchetto tenant

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di replaceTenantPackage

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

Aggiorna pacchetto tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateTenantPackage

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

Crea utente tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createTenantUserBody	CreateTenantUserBody	No

Risposta

Restituisce: Option[CreateTenantUser_200_response]

Esempio

Esempio di createTenantUser

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

Elimina utente tenant

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
id	string	No
deleteComments	string	No
commentDeleteMode	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteTenantUser

Copy

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

Recupera utente tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantUser_200_response]

Esempio

Esempio di getTenantUser

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

Recupera utenti tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetTenantUsers_200_response]

Esempio

Esempio getTenantUsers

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

Sostituisci utente tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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"

Invia link di accesso

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
redirectURL	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di sendLoginLink

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"

Aggiorna utente tenant

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di 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

Crea tenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createTenantBody	CreateTenantBody	No

Risposta

Restituisce: Option[CreateTenant_200_response]

Esempio

Esempio di createTenant

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

Elimina tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
sure	string	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di deleteTenant

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"

Recupera tenant

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenant_200_response]

Esempio

Esempio di getTenant

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

Recupera tenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
meta	string	No
skip	float64	No

Risposta

Restituisce: Option[GetTenants_200_response]

Esempio

Esempio di 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"

Aggiorna tenant

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	No
updateTenantBody	UpdateTenantBody	No

Risposta

Restituisce: Option[FlagCommentPublic_200_response]

Esempio

Esempio di updateTenant

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

Carica immagine

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
file	string	No
sizePreset	SizePreset	No
urlId	string	Sì

Risposta

Restituisce: Option[UploadImageResponse]

Esempio

Esempio di uploadImage

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

Recupera progresso badge utente per ID

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetUserBadgeProgressById_200_response]

Esempio

Esempio di 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

Recupera progresso badge utente per user ID

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
userId	string	No

Risposta

Restituisce: Option[GetUserBadgeProgressById_200_response]

Esempio

Esempio getUserBadgeProgressByUserId

Copy

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

Recupera lista progressi badge utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
limit	float64	No
skip	float64	No

Risposta

Restituisce: Option[GetUserBadgeProgressList_200_response]

Esempio

Esempio di getUserBadgeProgressList

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

Crea badge utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createUserBadgeParams	CreateUserBadgeParams	No

Risposta

Restituisce: Option[CreateUserBadge_200_response]

Esempio

Esempio di createUserBadge

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

Elimina badge utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[UpdateUserBadge_200_response]

Esempio

deleteUserBadge Esempio

Copy

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

Recupera badge utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetUserBadge_200_response]

Esempio

Esempio di getUserBadge

Copy

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

Recupera badge utente

Parametri

Name	Type	Required
tenantId	string	Sì
userId	string	No
badgeId	string	No
displayedOnComments	bool	No
limit	float64	No
skip	float64	No

Risposta

Restituisce: Option[GetUserBadges_200_response]

Esempio

Esempio di getUserBadges

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

Aggiorna badge utente

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Risposta

Restituisce: Option[UpdateUserBadge_200_response]

Esempio

Esempio di updateUserBadge

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

Recupera conteggio notifiche utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string	No

Risposta

Restituisce: Option[GetUserNotificationCount_200_response]

Esempio

Esempio di getUserNotificationCount

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

Recupera notifiche utente

Parametri

Name	Type	Required
tenantId	string	Sì
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

Risposta

Restituisce: Option[GetUserNotifications_200_response]

Esempio

Esempio di getUserNotifications

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

Reimposta conteggio notifiche utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string	No

Risposta

Restituisce: Option[ResetUserNotifications_200_response]

Esempio

Esempio di resetUserNotificationCount

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

Reimposta notifiche utente

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
afterId	string	No
afterCreatedAt	int64	No
unreadOnly	bool	No
dmOnly	bool	No
noDm	bool	No
sso	string	No

Risposta

Restituisce: Option[ResetUserNotifications_200_response]

Esempio

Esempio di resetUserNotifications

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

Aggiorna stato sottoscrizione notifiche commento utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
notificationId	string	No
optedInOrOut	string	No
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[UpdateUserNotificationStatus_200_response]

Esempio

Esempio di 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

Aggiorna stato sottoscrizione notifiche pagina utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string	No

Risposta

Restituisce: Option[UpdateUserNotificationStatus_200_response]

Esempio

Esempio di updateUserNotificationPageSubscriptionStatus

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

Aggiorna stato notifica utente

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
notificationId	string	No
newStatus	string	No
sso	string	No

Risposta

Restituisce: Option[UpdateUserNotificationStatus_200_response]

Esempio

Esempio di updateUserNotificationStatus

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

Recupera stati di presenza utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlIdWS	string	No
userIds	string	No

Risposta

Restituisce: Option[GetUserPresenceStatuses_200_response]

Esempio

Esempio di getUserPresenceStatuses

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

Cerca utenti

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
usernameStartsWith	string	No
mentionGroupIds	seq[string]	No
sso	string	No

Risposta

Restituisce: Option[SearchUsers_200_response]

Esempio

Esempio di searchUsers

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

Recupera utente

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetUser_200_response]

Esempio

Esempio di getUser

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

Crea voto

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
direction	string	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[VoteComment_200_response]

Esempio

Esempio di createVote

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

Elimina voto

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
editKey	string	No

Risposta

Restituisce: Option[DeleteCommentVote_200_response]

Esempio

Esempio di deleteVote

Copy

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

Recupera voti

Parametri

Name	Type	Required	Description
tenantId	string	Sì
urlId	string	Sì

Risposta

Restituisce: Option[GetVotes_200_response]

Esempio

Esempio di getVotes

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

Recupera voti per utente

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[GetVotesForUser_200_response]

Esempio

Esempio di getVotesForUser

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

Hai bisogno di aiuto?

Se riscontri problemi o hai domande sul Nim SDK, per favore:

Contribuire

I contributi sono benvenuti! Visita il repository GitHub per le linee guida sui contributi.

Lingua 🇮🇹 Italiano

Documentazione

Primi passi

Riferimento API

Utilizzo

Aggregazione

Log di audit

Blocco dal commento

Verifica commenti bloccati

Commenti

Configurazioni dominio

Modelli email

Registro eventi

Post feed

Segnala commento

Hashtag

Moderatori

Conteggio notifiche

Notifiche

Pagine

Eventi webhook in sospeso

Configurazioni domande

Risultati domande

Aggregazione risultati domande

Utenti SSO

Sottoscrizioni

Utilizzo giornaliero del tenant

Pacchetti tenant

Utenti tenant

Tenant

Carica immagine

Progresso badge utente

Badge utente

Notifiche utente

Stato presenza utente

Ricerca utenti

Utenti

Voti

FastComments Nim SDK

Repository

Requisiti

Installazione

Utilizzo di Nimble

Compilazione dal Sorgente

Contenuto della libreria

API pubbliche vs protette

Avvio rapido

Utilizzo delle API Autenticate (DefaultAPI)

Utilizzo delle API Pubbliche (PublicAPI)

Problemi comuni

Effettuare chiamate API

Esempio: Recupero dei commenti

Note

ID di broadcast

SSO (Single Sign-On)

Per esempi di SSO, vedi sotto.

Utilizzo SSO

SSO Semplice

SSO Sicuro

Documentazione per FastComments

Documentazione per fastcomments

Documentazione per gli endpoint API

Documentazione per i Modelli

Documentazione per l'Autorizzazione

api_key

Aggregazione

Parametri

Risposta

Esempio

Recupera log audit

Parametri

Risposta

Esempio

Blocca da commento pubblico

Parametri

Risposta

Esempio

Sblocca commento pubblico

Parametri

Risposta