FastComments SDK per Nim

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 semplificare il lavoro con l'API.

Documentazione della libreria client API

API pubbliche vs protette

Per il client API, ci sono tre moduli API, api_default, api_public, e api_moderation. api_default contiene i 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. Il modulo api_moderation contiene i metodi per la dashboard dei moderatori.

I metodi di api_moderation coprono elenchi, conteggi, ricerche ed esportazioni di commenti e dei loro log; azioni di moderazione come rimozione/restore dei commenti, segnalazione, impostazione dello stato di revisione/spam/approvazione, modifica dei voti e riapertura/chiusura dei thread; ban (bandire un utente da un commento, annullare un ban, riepiloghi pre-ban, stato e preferenze del ban e conteggi degli utenti bannati); e badge e fiducia (assegnazione/rimozione di un badge, elenco dei badge manuali, ottenere/impostare il fattore di fiducia di un utente e recuperare il profilo interno di un utente). Ogni metodo di api_moderation accetta un parametro sso in modo che la chiamata sia autenticata come moderatore SSO.

Guida rapida

Utilizzo delle API autenticate (DefaultAPI)

Importante: Gli endpoint autenticati richiedono che la tua chiave API sia impostata nell'header 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"

Utilizzo delle API di moderazione (ModerationAPI)

Gli endpoint di moderazione alimentano la dashboard dei moderatori e sono autenticati con un token SSO per il moderatore che agisce:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Elenca i commenti nella dashboard di moderazione
let (response, httpResponse) = getApiComments(
  httpClient = client,
  page = 0,
  count = 30,
  textSearch = "",
  byIPFromComment = "",
  filters = "",
  searchFilters = "",
  sorts = "",
  demo = false,
  sso = "your-sso-token"
)

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

Problemi comuni

401 authentication error: Assicurati di impostare l'header x-api-key sul tuo HttpClient prima di effettuare richieste a DefaultAPI: client.headers["x-api-key"] = "your-api-key"
Wrong API class: Usa api_default per le richieste autenticate lato server, api_public per le richieste lato client/pubbliche e api_moderation per le richieste della dashboard dei moderatori.

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 degli endpoint API

Tutti gli URI sono relativi a https://fastcomments.com

Classe	Metodo	Richiesta HTTP	Descrizione
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggrega i documenti raggruppandoli (se groupBy è fornito) e applicando più operazioni. Sono supportate diverse operazioni (ad 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	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Commentatori passati nella pagina che NON sono attualmente online. Ordinati per displayName. Usare questo dopo aver esaurito /users/online per mostrare una sezione "Membri". Paginazione cursore su commenterName: il server percorre l'indice parziale {tenantId, urlId, commenterName} da afterName in avanti tramite $gt, nessun costo $skip.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Visualizzatori attualmente online di una pagina: persone la cui sessione websocket è attualmente sottoscritta alla pagina. Restituisce anonCount + totalCount (abbonati dell'intera stanza, inclusi i visitatori anonimi che non elenchiamo).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Elenca le pagine per un tenant. Utilizzato dal client desktop FChat per popolare la lista delle stanze. Richiede che `enableFChat` sia true nella configurazione personalizzata risolta per ogni pagina. Le pagine che richiedono SSO sono filtrate in base all'accesso ai gruppi dell'utente richiedente.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Informazioni utenti in bulk per un tenant. Dato userIds, restituisce le info visualizzazione da User / SSOUser. Usato dal widget dei commenti per arricchire gli utenti che sono appena apparsi tramite un evento di presenza. Nessun contesto di pagina: la privacy viene applicata in modo uniforme (i profili privati sono mascherati).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Abilita o disabilita le notifiche per un commento specifico.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono sottoscritti a una pagina, vengono create delle notifiche per i nuovi commenti radice 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 dei Modelli

aggregate

Aggrega i documenti raggruppandoli (se viene fornito groupBy) e applicando più operazioni. Sono supportate diverse operazioni (es. sum, countDistinct, avg, ecc.).

Parametri

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

Risposta

Restituisce: Option[AggregateResponse]

Esempio

Esempio di aggregate

Copy

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

getAuditLogs

Parametri

Name	Type	Required
tenantId	string	Sì
limit	float64	No
skip	float64	No
order	SORTDIR	No
after	float64	No
before	float64	No

Risposta

Restituisce: Option[GetAuditLogsResponse]

Esempio

Esempio di getAuditLogs

Copy

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

logoutPublic

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di logoutPublic

Copy

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

blockFromCommentPublic

Parametri

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

Risposta

Restituisce: Option[BlockSuccess]

Esempio

Esempio di blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parametri

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

Risposta

Restituisce: Option[UnblockSuccess]

Esempio

Esempio di unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Parametri

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

Risposta

Restituisce: Option[CheckBlockedCommentsResponse]

Esempio

Esempio di checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parametri

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

Risposta

Restituisce: Option[BlockSuccess]

Esempio

Esempio blockUserFromComment

Copy

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

createCommentPublic

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

Esempio

Esempio di createCommentPublic

Copy

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

deleteComment

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	No
contextUserId	string	No
isLive	bool	No

Risposta

Restituisce: Option[DeleteCommentResult]

Esempio

Esempio di deleteComment

Copy

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

deleteCommentPublic

Parametri

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

Risposta

Restituisce: Option[PublicAPIDeleteCommentResponse]

Esempio

Esempio di deleteCommentPublic

Copy

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

deleteCommentVote

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

Esempio

Esempio di deleteCommentVote

Copy

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

flagComment

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[FlagCommentResponse]

Esempio

Esempio flagComment

Copy

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

getComment

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIGetCommentResponse]

Esempio

Esempio getComment

Copy

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

getComments

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
fromDate	int64	No
toDate	int64	No

Risposta

Restituisce: Option[APIGetCommentsResponse]

Esempio

Esempio getComments

Copy

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

getCommentsPublic

req tenantId urlId

Parametri

Name	Type	Obbligatorio
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[GetCommentsResponseWithPresencePublicComment]

Esempio

Esempio di getCommentsPublic

Copy

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

getCommentText

Parametri

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

Risposta

Restituisce: Option[PublicAPIGetCommentTextResponse]

Esempio

Esempio di getCommentText

Copy

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

getCommentVoteUserNames

Parametri

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

Risposta

Restituisce: Option[GetCommentVoteUserNamesSuccessResponse]

Esempio

Esempio getCommentVoteUserNames

Copy

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

lockComment

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di lockComment

Copy

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

pinComment

Parametri

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

Risposta

Restituisce: Option[ChangeCommentPinStatusResponse]

Esempio

Esempio di pinComment

Copy

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

saveComment

Parametri

Name	Type	Required
tenantId	string	Sì
createCommentParams	CreateCommentParams	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool	No

Response

Restituisce: Option[APISaveCommentResponse]

Esempio

Esempio di saveComment

Copy

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

saveCommentsBulk

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createCommentParams	seq[CreateCommentParams]	No
isLive	bool	No
doSpamCheck	bool	No
sendEmails	bool	No
populateNotifications	bool): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di saveCommentsBulk

Copy

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

setCommentText

Parametri

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

Risposta

Restituisce: Option[PublicAPISetCommentTextResponse]

Esempio

Esempio di setCommentText

Copy

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

unBlockUserFromComment

Parametri

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

Risposta

Restituisce: Option[UnblockSuccess]

Esempio

Esempio di unBlockUserFromComment

Copy

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

unFlagComment

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
userId	string	No
anonUserId	string	No

Risposta

Restituisce: Option[FlagCommentResponse]

Esempio

Esempio di unFlagComment

Copy

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

unLockComment

Parametri

Nome	Tipo	Richiesto
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di unLockComment

Copy

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

unPinComment

Parametri

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

Risposta

Restituisce: Option[ChangeCommentPinStatusResponse]

Esempio

Esempio di unPinComment

Copy

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

updateComment

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

Esempio

Esempio di updateComment

Copy

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

voteComment

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

Esempio

Esempio di voteComment

Copy

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

getCommentsForUser

Parametri

Name	Type	Required
userId	string	No
direction	SortDirections	No
repliesToUserId	string	No
page	float64	No
includei10n	bool	No
locale	string	No
isCrawler	bool	No

Risposta

Restituisce: Option[GetCommentsForUserResponse]

Esempio

Esempio di getCommentsForUser

Copy

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

addDomainConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
addDomainConfigParams	AddDomainConfigParams	No

Risposta

Restituisce: Option[AddDomainConfigResponse]

Esempio

Esempio di addDomainConfig

Copy

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

deleteDomainConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	No

Risposta

Restituisce: Option[DeleteDomainConfigResponse]

Esempio

Esempio di deleteDomainConfig

Copy

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

getDomainConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	No

Risposta

Restituisce: Option[GetDomainConfigResponse]

Esempio

Esempio di getDomainConfig

Copy

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

getDomainConfigs

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì

Risposta

Restituisce: Option[GetDomainConfigsResponse]

Esempio

Esempio di getDomainConfigs

Copy

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

patchDomainConfig

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Risposta

Restituisce: Option[PatchDomainConfigResponse]

Esempio

Esempio di patchDomainConfig

Copy

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

putDomainConfig

Parametri

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

Risposta

Restituisce: Option[PutDomainConfigResponse]

Esempio

Esempio di putDomainConfig

Copy

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

createEmailTemplate

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createEmailTemplateBody	CreateEmailTemplateBody	No

Risposta

Restituisce: Option[CreateEmailTemplateResponse]

Esempio

Esempio di createEmailTemplate

Copy

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

deleteEmailTemplate

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteEmailTemplateRenderError

Copy

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

getEmailTemplate

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetEmailTemplateResponse]

Esempio

Esempio getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì

Risposta

Restituisce: Option[GetEmailTemplateDefinitionsResponse]

Esempio

Esempio di getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
id	string	No
skip	float64	No

Risposta

Restituisce: Option[GetEmailTemplateRenderErrorsResponse]

Esempio

Esempio di getEmailTemplateRenderErrors

Copy

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

getEmailTemplates

Parametri

Name	Type	Required	Description
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetEmailTemplatesResponse]

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 email templates available"

renderEmailTemplate

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string	No

Risposta

Restituisce: Option[RenderEmailTemplateResponse]

Esempio

Esempio di renderEmailTemplate

Copy

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

updateEmailTemplate

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateEmailTemplate

Copy

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

getEventLog

req tenantId urlId userIdWS

Parametri

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

Risposta

Restituisce: Option[GetEventLogResponse]

Esempio

Esempio di getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parametri

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

Risposta

Restituisce: Option[GetEventLogResponse]

Esempio

Esempio di getGlobalEventLog

Copy

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

createFeedPost

Parametri

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

Risposta

Restituisce: Option[CreateFeedPostsResponse]

Esempio

Esempio di createFeedPost

Copy

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

createFeedPostPublic

Parametri

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

Risposta

Restituisce: Option[CreateFeedPostResponse]

Esempio

Esempio di createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parametri

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

Risposta

Restituisce: Option[DeleteFeedPostPublicResponse]

Esempio

Esempio di deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parametri

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

Risposta

Restituisce: Option[GetFeedPostsResponse]

Esempio

Esempio getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parametri

Nome	Tipo	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[PublicFeedPostsResponse]

Esempio

Esempio getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametri

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

Risposta

Restituisce: Option[FeedPostsStatsResponse]

Esempio

Esempio di getFeedPostsStats

Copy

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

getUserReactsPublic

Parametri

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

Risposta

Restituisce: Option[UserReactsResponse]

Esempio

getUserReactsPublic Esempio

Copy

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

reactFeedPostPublic

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
postId	string	No
reactBodyParams	ReactBodyParams	No
isUndo	bool	No
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[ReactFeedPostResponse]

Esempio

Esempio di reactFeedPostPublic

Copy

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

updateFeedPost

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateFeedPost

Copy

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

updateFeedPostPublic

Parametri

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

Risposta

Restituisce: Option[CreateFeedPostResponse]

Esempio

Esempio di updateFeedPostPublic

Copy

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

flagCommentPublic

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio flagCommentPublic

Copy

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

getGifLarge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
largeInternalURLSanitized	string	No

Risposta

Restituisce: Option[GifGetLargeResponse]

Esempio

Esempio di getGifLarge

Copy

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

getGifsSearch

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
search	string	No
locale	string	No
rating	string	No
page	float64	No

Risposta

Restituisce: Option[GetGifsSearchResponse]

Esempio

Esempio di getGifsSearch

Copy

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

getGifsTrending

Parametri

Name	Type	Required
tenantId	string	Sì
locale	string	No
rating	string	No
page	float64	No

Risposta

Restituisce: Option[GetGifsTrendingResponse]

Esempio

Esempio di getGifsTrending

Copy

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

addHashTag

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createHashTagBody	CreateHashTagBody	No

Risposta

Restituisce: Option[CreateHashTagResponse]

Esempio

Esempio di addHashTag

Copy

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

addHashTagsBulk

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Risposta

Restituisce: Option[BulkCreateHashTagsResponse]

Esempio

Esempio di addHashTagsBulk

Copy

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

deleteHashTag

Parametri

Nome	Tipo	Obbligatorio
tag	string	No
tenantId	string	Sì
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteHashTag

Copy

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

getHashTags

Parametri

Name	Type	Required	Description
tenantId	string	Sì
page	float64	No

Risposta

Restituisce: Option[GetHashTagsResponse]

Esempio

Esempio di getHashTags

Copy

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

patchHashTag

Parametri

Nome	Tipo	Obbligatorio
tag	string	No
tenantId	string	Sì
updateHashTagBody	UpdateHashTagBody	No

Risposta

Restituisce: Option[UpdateHashTagResponse]

Esempio

Esempio di patchHashTag

Copy

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

deleteModerationVote

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
voteId	string	No
sso	string	No

Risposta

Restituisce: Option[VoteDeleteResponse]

Esempio

Esempio di deleteModerationVote

Copy

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

getApiComments

Parametri

Nome	Tipo	Obbligatorio
page	float64	No
count	float64	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	bool	No
sso	string	No

Risposta

Restituisce: Option[ModerationAPIGetCommentsResponse]

Esempio

Esempio di getApiComments

Copy

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

getApiExportStatus

Parametri

Nome	Tipo	Obbligatorio	Descrizione
batchJobId	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationExportStatusResponse]

Esempio

Esempio di getApiExportStatus

Copy

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

getApiIds

Parametri

Nome	Tipo	Obbligatorio
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	bool	No
sso	string	No

Risposta

Restituisce: Option[ModerationAPIGetCommentIdsResponse]

Esempio

Esempio di getApiIds

Copy

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

getBanUsersFromComment

Parametri

Nome	Tipo	Richiesto	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[GetBannedUsersFromCommentResponse]

Esempio

Esempio di getBanUsersFromComment

Copy

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

getCommentBanStatus

Parametri

Name	Type	Required	Description
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[GetCommentBanStatusResponse]

Esempio

Esempio di getCommentBanStatus

Copy

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

getCommentChildren

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[ModerationAPIChildCommentsResponse]

Esempio

Esempio di getCommentChildren

Copy

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

getCount

Parametri

Nome	Tipo	Obbligatorio
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	bool	No
sso	string	No

Risposta

Restituisce: Option[ModerationAPICountCommentsResponse]

Esempio

Esempio di getCount

Copy

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

getCounts

Parametri

Nome	Tipo	Obbligatorio	Descrizione
sso	string	No

Risposta

Restituisce: Option[GetBannedUsersCountResponse]

Esempio

Esempio di getCounts

Copy

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

getLogs

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[ModerationAPIGetLogsResponse]

Esempio

Esempio di getLogs

Copy

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

getManualBadges

Parametri

Name	Type	Required	Description
sso	string	No

Risposta

Restituisce: Option[GetTenantManualBadgesResponse]

Esempio

Esempio getManualBadges

Copy

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

getManualBadgesForUser

Parametri

Nome	Tipo	Obbligatorio
badgesUserId	string	No
commentId	string	Yes
sso	string	No

Risposta

Restituisce: Option[GetUserManualBadgesResponse]

Esempio

Esempio di getManualBadgesForUser

Copy

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

getModerationComment

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
includeEmail	bool	No
includeIP	bool	No
sso	string	No

Risposta

Restituisce: Option[ModerationAPICommentResponse]

Esempio

Esempio di getModerationComment

Copy

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

getModerationCommentText

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[GetCommentTextResponse]

Esempio

getModerationCommentText Example

Copy

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

getPreBanSummary

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
includeByUserIdAndEmail	bool	No
includeByIP	bool	No
includeByEmailDomain	bool	No
sso	string	No

Risposta

Restituisce: Option[PreBanSummary]

Esempio

Esempio getPreBanSummary

Copy

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

getSearchCommentsSummary

Parametri

Nome	Tipo	Obbligatorio
value	string	No
filters	string	No
searchFilters	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationCommentSearchResponse]

Esempio

Esempio di getSearchCommentsSummary

Copy

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

getSearchPages

Parametri

Nome	Tipo	Richiesto	Descrizione
value	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationPageSearchResponse]

Esempio

Esempio di getSearchPages

Copy

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

getSearchSites

Parametri

Name	Type	Required	Description
value	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationSiteSearchResponse]

Esempio

Esempio di getSearchSites

Copy

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

getSearchSuggest

Parametri

Name	Type	Required	Description
textSearch	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationSuggestResponse]

Esempio

Esempio di getSearchSuggest

Copy

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

getSearchUsers

Parametri

Nome	Tipo	Obbligatorio	Descrizione
value	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationUserSearchResponse]

Esempio

Esempio di getSearchUsers

Copy

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

getTrustFactor

Parametri

Nome	Tipo	Obbligatorio	Descrizione
userId	string	No
sso	string	No

Risposta

Restituisce: Option[GetUserTrustFactorResponse]

Esempio

Esempio getTrustFactor

Copy

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

getUserBanPreference

Parametri

Nome	Tipo	Obbligatorio	Descrizione
sso	string	No

Risposta

Restituisce: Option[APIModerateGetUserBanPreferencesResponse]

Esempio

Esempio di getUserBanPreference

Copy

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

getUserInternalProfile

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[GetUserInternalProfileResponse]

Esempio

Esempio di getUserInternalProfile

Copy

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

postAdjustCommentVotes

Parametri

Name	Type	Required
commentId	string	Sì
adjustCommentVotesParams	AdjustCommentVotesParams	No
sso	string	No

Risposta

Restituisce: Option[AdjustVotesResponse]

Esempio

Esempio di postAdjustCommentVotes

Copy

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

postApiExport

Parametri

Nome	Tipo	Obbligatorio
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
sso	string	No

Risposta

Restituisce: Option[ModerationExportResponse]

Esempio

Esempio postApiExport

Copy

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

postBanUserFromComment

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
banEmail	bool	No
banEmailDomain	bool	No
banIP	bool	No
deleteAllUsersComments	bool	No
bannedUntil	string	No
isShadowBan	bool	No
updateId	string	No
banReason	string	No
sso	string	No

Risposta

Restituisce: Option[BanUserFromCommentResult]

Esempio

Esempio di postBanUserFromComment

Copy

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

postBanUserUndo

Parametri

Nome	Tipo	Obbligatorio	Descrizione
banUserUndoParams	BanUserUndoParams	No
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di postBanUserUndo

Copy

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

postBulkPreBanSummary

Parametri

Nome	Tipo	Obbligatorio
bulkPreBanParams	BulkPreBanParams	No
includeByUserIdAndEmail	bool	No
includeByIP	bool	No
includeByEmailDomain	bool	No
sso	string	No

Risposta

Restituisce: Option[BulkPreBanSummary]

Esempio

Esempio di postBulkPreBanSummary

Copy

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

postCommentsByIds

Parametri

Nome	Tipo	Richiesto	Descrizione
commentsByIdsParams	CommentsByIdsParams	No
sso	string	No

Risposta

Restituisce: Option[ModerationAPIChildCommentsResponse]

Esempio

Esempio di postCommentsByIds

Copy

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

postFlagComment

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di postFlagComment

Copy

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

postRemoveComment

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[PostRemoveCommentResponse]

Esempio

Esempio di postRemoveComment

Copy

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

postRestoreDeletedComment

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di postRestoreDeletedComment

Copy

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

postSetCommentApprovalStatus

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
approved	bool	No
sso	string	No

Risposta

Restituisce: Option[SetCommentApprovedResponse]

Esempio

Esempio di postSetCommentApprovalStatus

Copy

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

postSetCommentReviewStatus

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
reviewed	bool	No
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di postSetCommentReviewStatus

Copy

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

postSetCommentSpamStatus

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
spam	bool	No
permNotSpam	bool	No
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di postSetCommentSpamStatus

Copy

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

postSetCommentText

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
setCommentTextParams	SetCommentTextParams	No
sso	string	No

Risposta

Restituisce: Option[SetCommentTextResponse]

Esempio

Esempio di postSetCommentText

Copy

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

postUnFlagComment

Parametri

Nome	Tipo	Obbligatorio	Descrizione
commentId	string	Sì
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio postUnFlagComment

Copy

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

postVote

Parametri

Nome	Tipo	Obbligatorio
commentId	string	Sì
direction	string	No
sso	string	No

Risposta

Restituisce: Option[VoteResponse]

Esempio

Esempio postVote

Copy

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

putAwardBadge

Parametri

Nome	Tipo	Richiesto
badgeId	string	No
userId	string	No
commentId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[AwardUserBadgeResponse]

Esempio

Esempio di putAwardBadge

Copy

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

putCloseThread

Parametri

Nome	Tipo	Obbligatorio	Descrizione
urlId	string	Sì
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di putCloseThread

Copy

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

putRemoveBadge

Parametri

Name	Type	Required
badgeId	string	No
userId	string	No
commentId	string	Sì
broadcastId	string	No
sso	string	No

Risposta

Restituisce: Option[RemoveUserBadgeResponse]

Esempio

Esempio di putRemoveBadge

Copy

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

putReopenThread

Parametri

Nome	Tipo	Obbligatorio	Descrizione
urlId	string	Sì
sso	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio putReopenThread

Copy

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

setTrustFactor

Parametri

Nome	Tipo	Obbligatorio
userId	string	No
trustFactor	string	No
sso	string	No

Risposta

Restituisce: Option[SetUserTrustFactorResponse]

Esempio

Esempio di setTrustFactor

Copy

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

createModerator

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createModeratorBody	CreateModeratorBody	No

Risposta

Restituisce: Option[CreateModeratorResponse]

Esempio

Esempio di createModerator

Copy

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

deleteModerator

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteModerator

Copy

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

getModerator

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetModeratorResponse]

Esempio

Esempio di getModerator

Copy

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

getModerators

Parametri

Name	Type	Required	Description
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetModeratorsResponse]

Esempio

Esempio getModerators

Copy

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

updateModerator

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateModerator

Copy

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

deleteNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteNotificationCount

Copy

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

getCachedNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetCachedNotificationCountResponse]

Esempio

Esempio di getCachedNotificationCount

Copy

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

getNotificationCount

Parametri

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

Risposta

Restituisce: Option[GetNotificationCountResponse]

Esempio

Esempio di getNotificationCount

Copy

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

getNotifications

Parametri

Nome	Tipo	Richiesto
tenantId	string	Sì
userId	string	No
urlId	string	Sì
fromCommentId	string	No
viewed	bool	No
skip	float64	No

Risposta

Restituisce: Option[GetNotificationsResponse]

Esempio

Esempio di getNotifications

Copy

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

updateNotification

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateNotification

Copy

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

createV1PageReact

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
title	string	No

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

Esempio di createV1PageReact

Copy

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

createV2PageReact

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
id	string	No
title	string	No

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

Esempio di createV2PageReact

Copy

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

deleteV1PageReact

Parametri

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

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

Esempio di deleteV1PageReact

Copy

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

deleteV2PageReact

Parametri

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

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

Esempio di deleteV2PageReact

Copy

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

getV1PageLikes

Parametri

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

Risposta

Restituisce: Option[GetV1PageLikes]

Esempio

Esempio getV1PageLikes

Copy

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

getV2PageReacts

Parametri

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

Risposta

Restituisce: Option[GetV2PageReacts]

Esempio

Esempio di getV2PageReacts

Copy

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

getV2PageReactUsers

Parametri

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

Risposta

Restituisce: Option[GetV2PageReactUsersResponse]

Esempio

Esempio di getV2PageReactUsers

Copy

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

addPage

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

deletePage

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

getOfflineUsers

Commentatori passati sulla pagina che NON sono attualmente online. Ordinati per displayName. Usare questo dopo aver esaurito /users/online per visualizzare una sezione "Membri". Paginazione cursore su commenterName: il server scorre l'indice parziale {tenantId, urlId, commenterName} da afterName in avanti tramite $gt, senza costo $skip.

Parametri

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
afterName	string	No
afterUserId	string	No

Risposta

Restituisce: Option[PageUsersOfflineResponse]

Esempio

Esempio di getOfflineUsers

Copy

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

getOnlineUsers

Attualmente i visualizzatori online di una pagina: persone la cui sessione websocket è sottoscritta alla pagina in questo momento. Restituisce anonCount + totalCount (iscritti alla room in generale, inclusi i visualizzatori anonimi che non elenchiamo).

Parametri

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
afterName	string	No
afterUserId	string	No

Risposta

Restituisce: Option[PageUsersOnlineResponse]

Esempio

Esempio di getOnlineUsers

Copy

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

getPageByURLId

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

getPages

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

getPagesPublic

Elenca le pagine per un tenant. Utilizzato dal client desktop FChat per popolare l'elenco delle sue stanze. Richiede che enableFChat sia true nella configurazione personalizzata risolta per ciascuna pagina. Le pagine che richiedono SSO vengono filtrate rispetto ai gruppi di accesso dell'utente che effettua la richiesta.

Parametri

Name	Type	Required
tenantId	string	Sì
cursor	string	No
limit	int	No
q	string	No
sortBy	PagesSortBy	No
hasComments	bool	No

Risposta

Restituisce: Option[GetPublicPagesResponse]

Esempio

Esempio getPagesPublic

Copy

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

getUsersInfo

Informazioni utente in blocco per un tenant. Dato userIds, restituisce le informazioni di visualizzazione da User / SSOUser. Utilizzato dal widget dei commenti per arricchire gli utenti che sono appena apparsi tramite un evento di presenza. Nessun contesto di pagina: la privacy è applicata in modo uniforme (i profili privati sono mascherati).

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
ids	string	No

Risposta

Restituisce: Option[PageUsersInfoResponse]

Esempio

Esempio di getUsersInfo

Copy

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

patchPage

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

deletePendingWebhookEvent

Parametri

Name	Type	Required	Description
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deletePendingWebhookEvent

Copy

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

getPendingWebhookEventCount

Parametri

Name	Type	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
externalId	string	No
eventType	string	No
domain	string	No
attemptCountGT	float64	No

Risposta

Restituisce: Option[GetPendingWebhookEventCountResponse]

Esempio

Esempio di getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

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

Esempio

Esempio getPendingWebhookEvents

Copy

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

createQuestionConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionConfigBody	CreateQuestionConfigBody	No

Risposta

Restituisce: Option[CreateQuestionConfigResponse]

Esempio

Esempio di createQuestionConfig

Copy

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

deleteQuestionConfig

Parametri

Name	Type	Required	Description
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteQuestionConfig

Copy

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

getQuestionConfig

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetQuestionConfigResponse]

Esempio

Esempio di getQuestionConfig

Copy

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

getQuestionConfigs

Parametri

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Risposta

Restituisce: Option[GetQuestionConfigsResponse]

Esempio

Esempio di getQuestionConfigs

Copy

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

updateQuestionConfig

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateQuestionConfig

Copy

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

createQuestionResult

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionResultBody	CreateQuestionResultBody	No

Risposta

Restituisce: Option[CreateQuestionResultResponse]

Esempio

Esempio di createQuestionResult

Copy

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

deleteQuestionResult

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteQuestionResult

Copy

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

getQuestionResult

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetQuestionResultResponse]

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 "Question result received:"
  echo result
else:
  echo "No question result returned, HTTP status: ", $httpResponse.status

getQuestionResults

Parametri

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	float64	No

Risposta

Restituisce: Option[GetQuestionResultsResponse]

Esempio

Esempio di getQuestionResults

Copy

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

updateQuestionResult

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateQuestionResult

Copy

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

aggregateQuestionResults

Parametri

Nome	Tipo	Obbligatorio
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[AggregateQuestionResultsResponse]

Esempio

Esempio di aggregateQuestionResults

Copy

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

bulkAggregateQuestionResults

Parametri

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

Risposta

Restituisce: Option[BulkAggregateQuestionResultsResponse]

Esempio

Esempio di bulkAggregateQuestionResults

Copy

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

combineCommentsWithQuestionResults

Parametri

Nome	Tipo	Obbligatorio
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[CombineQuestionResultsWithCommentsResponse]

Esempio

Esempio di combineCommentsWithQuestionResults

Copy

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

addSSOUser

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

deleteSSOUser

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

getSSOUserByEmail

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

getSSOUserById

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

getSSOUsers

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	int	No

Risposta

Restituisce: Option[GetSSOUsersResponse]

Esempio

Esempio di getSSOUsers

Copy

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

patchSSOUser

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

putSSOUser

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

createSubscription

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

deleteSubscription

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"

getSubscriptions

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

updateSubscription

Parametri

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

Risposta

Restituisce: Option[UpdateSubscriptionAPIResponse]

Esempio

Esempio di updateSubscription

Copy

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

getTenantDailyUsages

Parametri

Name	Type	Required
tenantId	string	Sì
yearNumber	float64	No
monthNumber	float64	No
dayNumber	float64	No
skip	float64	No

Risposta

Restituisce: Option[GetTenantDailyUsagesResponse]

Esempio

Esempio di getTenantDailyUsages

Copy

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

createTenantPackage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createTenantPackageBody	CreateTenantPackageBody	No

Risposta

Restituisce: Option[CreateTenantPackageResponse]

Esempio

Esempio di createTenantPackage

Copy

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

deleteTenantPackage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteTenantPackage

Copy

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

getTenantPackage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantPackageResponse]

Esempio

Esempio di getTenantPackage

Copy

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

getTenantPackages

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetTenantPackagesResponse]

Esempio

Esempio di getTenantPackages

Copy

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

replaceTenantPackage

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di replaceTenantPackage

Copy

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

updateTenantPackage

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateTenantPackage

Copy

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

createTenantUser

Parametri

Nome	Tipo	Richiesto	Descrizione
tenantId	string	Sì
createTenantUserBody	CreateTenantUserBody	No

Risposta

Restituisce: Option[CreateTenantUserResponse]

Esempio

Esempio di createTenantUser

Copy

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

deleteTenantUser

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteTenantUser

Copy

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

getTenantUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantUserResponse]

Esempio

Esempio di getTenantUser

Copy

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

getTenantUsers

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetTenantUsersResponse]

Esempio

Esempio di getTenantUsers

Copy

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

replaceTenantUser

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di replaceTenantUser

Copy

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

sendLoginLink

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di sendLoginLink

Copy

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

updateTenantUser

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateTenantUser

Copy

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

createTenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createTenantBody	CreateTenantBody	No

Risposta

Restituisce: Option[CreateTenantResponse]

Esempio

Esempio di createTenant

Copy

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

deleteTenant

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di deleteTenant

Copy

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

getTenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantResponse]

Esempio

Esempio di getTenant

Copy

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

getTenants

Parametri

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

Risposta

Restituisce: Option[GetTenantsResponse]

Esempio

Esempio di getTenants

Copy

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

updateTenant

Parametri

Name	Type	Required
tenantId	string	Sì
id	string	No
updateTenantBody	UpdateTenantBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateTenant

Copy

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

changeTicketState

Parametri

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

Risposta

Restituisce: Option[ChangeTicketStateResponse]

Esempio

Esempio changeTicketState

Copy

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

createTicket

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
userId	string	No
createTicketBody	CreateTicketBody	No

Risposta

Restituisce: Option[CreateTicketResponse]

Esempio

Esempio di createTicket

Copy

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

getTicket

Parametri

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

Risposta

Restituisce: Option[GetTicketResponse]

Esempio

Esempio di getTicket

Copy

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

getTickets

Parametri

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

Risposta

Restituisce: Option[GetTicketsResponse]

Esempio

Esempio di getTickets

Copy

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

getTranslations

Parametri

Nome	Tipo	Obbligatorio
namespace	string	No
component	string	No
locale	string	No
useFullTranslationIds	bool	No

Risposta

Restituisce: Option[GetTranslationsResponse]

Esempio

Esempio di getTranslations

Copy

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

uploadImage

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

getUserBadgeProgressById

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIGetUserBadgeProgressResponse]

Esempio

Esempio di getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
userId	string	No

Risposta

Restituisce: Option[APIGetUserBadgeProgressResponse]

Esempio

Esempio getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Parametri

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

Risposta

Restituisce: Option[APIGetUserBadgeProgressListResponse]

Esempio

Esempio di getUserBadgeProgressList

Copy

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

createUserBadge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createUserBadgeParams	CreateUserBadgeParams	No

Risposta

Restituisce: Option[APICreateUserBadgeResponse]

Esempio

Esempio di createUserBadge

Copy

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

deleteUserBadge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptySuccessResponse]

Esempio

Esempio di deleteUserBadge

Copy

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

getUserBadge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIGetUserBadgeResponse]

Esempio

Esempio di getUserBadge

Copy

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

getUserBadges

Parametri

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

Risposta

Restituisce: Option[APIGetUserBadgesResponse]

Esempio

Esempio di getUserBadges

Copy

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

updateUserBadge

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updateUserBadgeParams	UpdateUserBadgeParams	No

Risposta

Restituisce: Option[APIEmptySuccessResponse]

Esempio

Esempio di updateUserBadge

Copy

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

getUserNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string	No

Risposta

Restituisce: Option[GetUserNotificationCountResponse]

Esempio

Esempio di getUserNotificationCount

Copy

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

getUserNotifications

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	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
includeTenantNotifications	bool	No
sso	string	No

Risposta

Restituisce: Option[GetMyNotificationsResponse]

Esempio

Esempio di getUserNotifications

Copy

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

resetUserNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string	No

Risposta

Restituisce: Option[ResetUserNotificationsResponse]

Esempio

Esempio di resetUserNotificationCount

Copy

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

resetUserNotifications

Parametri

Nome	Tipo	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[ResetUserNotificationsResponse]

Esempio

Esempio di resetUserNotifications

Copy

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

updateUserNotificationCommentSubscriptionStatus

Abilita o disabilita le notifiche per un commento specifico.

Parametri

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

Risposta

Restituisce: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Esempio

Esempio di updateUserNotificationCommentSubscriptionStatus

Copy

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

updateUserNotificationPageSubscriptionStatus

Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, vengono create notifiche per nuovi commenti principali, e anche

Parametri

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string	No

Risposta

Restituisce: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Esempio

Esempio di updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
notificationId	string	No
newStatus	string	No
sso	string	No

Risposta

Restituisce: Option[UpdateUserNotificationStatusResponse]

Esempio

Esempio di updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parametri

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

Risposta

Restituisce: Option[GetUserPresenceStatusesResponse]

Esempio

Esempio di getUserPresenceStatuses

Copy

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

searchUsers

Parametri

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

Risposta

Restituisce: Option[SearchUsersResult]

Esempio

Esempio di searchUsers

Copy

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

getUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetUserResponse]

Esempio

Esempio getUser

Copy

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

createVote

Parametri

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

Risposta

Restituisce: Option[VoteResponse]

Esempio

Esempio di createVote

Copy

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

deleteVote

Parametri

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

Risposta

Restituisce: Option[VoteDeleteResponse]

Esempio

Esempio di deleteVote

Copy

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

getVotes

Parametri

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

Risposta

Restituisce: Option[GetVotesResponse]

Esempio

Esempio getVotes

Copy

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

getVotesForUser

Parametri

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

Risposta

Restituisce: Option[GetVotesForUserResponse]

Esempio

Esempio di getVotesForUser

Copy

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

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

Autenticazione

Blocca dal commento

Controlla commenti bloccati

Commenti

Commenti per utente

Configurazioni dominio

Modelli email

Registro eventi

Post del feed

Segnala commento

GIF

Hashtag

Moderazione

Moderatori

Conteggio notifiche

Notifiche

Reazioni pagina

Pagine

Eventi webhook in sospeso

Configurazioni domande

Risultati domande

Aggregazione risultati domande

Utenti SSO

Sottoscrizioni

Utilizzo giornaliero tenant

Pacchetti tenant

Utenti tenant

Tenant

Ticket

Traduzioni

Carica immagine

Avanzamento badge utente

Badge utente

Notifiche utente

Stato presenza utente

Ricerca utenti

Utenti

Voti

FastComments SDK per Nim

Repository

Requisiti

Installazione

Utilizzo di Nimble

Compilazione dal sorgente

Contenuto della libreria

API pubbliche vs protette

Guida rapida

Utilizzo delle API autenticate (DefaultAPI)

Utilizzo delle API pubbliche (PublicAPI)

Utilizzo delle API di moderazione (ModerationAPI)

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 degli endpoint API

Documentazione dei Modelli

aggregate

Parametri

Risposta

Esempio

getAuditLogs

Parametri

Risposta

Esempio

logoutPublic

Risposta