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

Utilizzare Nimble

nimble install fastcomments

Compilare dal codice sorgente

nimble build

Contenuto della libreria

Questa libreria contiene il client API generato e le utility SSO per semplificare l'utilizzo dell'API.

Documentazione della libreria client API

API pubbliche vs API sicure

Per il client API, esistono tre moduli API, api_default, api_public e api_moderation. Il modulo api_default contiene metodi che richiedono la tua chiave API, e api_public contiene chiamate API che possono essere effettuate direttamente da un browser/dispositivo mobile/etc. senza autenticazione. Il modulo api_moderation contiene metodi per la dashboard del moderatore.

Il modulo `api_moderation` offre una suite completa di API di moderazione live e rapide. Ogni metodo `api_moderation` accetta un parametro `sso` e può autenticarsi tramite SSO o un cookie di sessione di FastComments.com.

Guida rapida

Utilizzo delle API Autenticate (DefaultAPI)

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

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

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

# Effettua chiamate API autenticate.
# I parametri richiesti (e il corpo della richiesta) sono posizionali; i parametri opzionali
# sono passati tramite l'oggetto options dell'operazione.
let (response, httpResponse) = getComments(
  httpClient = client,
  tenantId = "your-tenant-id",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

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.
# tenantId e urlId sono obbligatori (posizionali); tutto il resto è opzionale.
let (response, httpResponse) = getCommentsPublic(
  httpClient = client,
  tenantId = "your-tenant-id",
  urlId = "your-url-id",
  options = GetCommentsPublicOptions(
    direction: SortDirections.DESC
  )
)

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

Utilizzo delle API di Moderazione (ModerationAPI)

Gli endpoint di moderazione alimentano la dashboard del moderatore e sono autenticati con un token SSO per il moderatore attivo:

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Elenca i commenti nella dashboard di moderazione.
# Questa operazione non ha parametri richiesti, quindi tutto è opzionale.
let (response, httpResponse) = getApiComments(
  httpClient = client,
  options = GetApiCommentsOptions(
    count: 30,
    tenantId: "your-tenant-id",
    sso: "your-sso-token"
  )
)

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

Problemi comuni

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

Effettuare chiamate API

All API methods in this SDK return tuples of (Option[ResponseType], Response). The first element contains the parsed response if successful, and the second element is the raw HTTP response.

I parametri obbligatori e il corpo della richiesta vengono passati positionalmente. I restanti parametri opzionali vengono raccolti in un unico oggetto Api<Operation>Options, che è l'ultimo argomento. Le operazioni senza parametri opzionali non richiedono alcun oggetto di opzioni.

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",
  options = GetCommentsOptions(
    urlId: "your-url-id",
    direction: SortDirections.DESC
  )
)

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

Note

ID di broadcast

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

SSO (Single Sign-On)

Per esempi di SSO, vedi sotto.

Utilizzo SSO

SSO Semplice

import fastcomments/sso

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

echo "SSO Token: ", token

SSO Sicuro

import fastcomments/sso

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

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

echo "Secure SSO Token: ", token

Documentazione per fastcomments

Documentazione per gli endpoint API

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

Class	Method	HTTP request	Description
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 (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/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	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 iscritti a una pagina, le notifiche vengono create 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 per i modelli

aggregate

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

Parameters

Nome	Tipo	Obbligatorio
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Response

Restituisce: Option[AggregateResponse]

Example

Esempio di aggregazione

Copy

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

getAuditLogs

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetAuditLogsOptions	No

Risposta

Restituisce: Option[GetAuditLogsResponse]

Esempio

Esempio getAuditLogs

Copy

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

logoutPublic

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

logoutPublic Esempio

Copy

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

blockFromCommentPublic

Parametri

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

Risposta

Restituisce: Option[BlockSuccess]

Esempio

Esempio blockFromCommentPublic

Copy

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

unBlockCommentPublic

Parametri

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

Risposta

Restituisce: Option[UnblockSuccess]

Esempio

unBlockCommentPublic Esempio

Copy

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

checkedCommentsForBlocked

Parametri

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

Risposta

Restituisce: Option[CheckBlockedCommentsResponse]

Esempio

Esempio di checkedCommentsForBlocked

Copy

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

blockUserFromComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
blockFromCommentParams	BlockFromCommentParams	No
options	BlockUserFromCommentOptions	No

Risposta

Restituisce: Option[BlockSuccess]

Esempio

Esempio blockUserFromComment

Copy

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

createCommentPublic

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

Risposta

Restituisce: Option[SaveCommentsResponseWithPresence]

Esempio

Esempio createCommentPublic

Copy

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

deleteComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
options	DeleteCommentOptions	No

Risposta

Restituisce: Option[DeleteCommentResult]

Esempio

Esempio deleteComment

Copy

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

deleteCommentPublic

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Risposta

Restituisce: Option[PublicAPIDeleteCommentResponse]

Esempio

Esempio deleteCommentPublic

Copy

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

deleteCommentVote

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
voteId	string	No
urlId	string	Yes
broadcastId	string	No
options	DeleteCommentVoteOptions	No

Risposta

Restituisce: Option[VoteDeleteResponse]

Esempio

Esempio deleteCommentVote

Copy

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

flagComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
options	FlagCommentOptions	No

Risposta

Returns: Option[FlagCommentResponse]

Esempio

Esempio flagComment

Copy

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

getComment

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-789")
if response.isSome:
  let comment = response.get()
  discard comment

getComments

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetCommentsOptions	No

Risposta

Restituisce: Option[APIGetCommentsResponse]

Esempio

Esempio getComments

Copy

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

getCommentsPublic

req
tenantId
urlId

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
options	GetCommentsPublicOptions	No

Risposta

Restituisce: Option[GetCommentsResponseWithPresencePublicComment]

Esempio

getCommentsPublic Esempio

Copy

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

getCommentText

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
options	GetCommentTextOptions	No

Risposta

Restituisce: Option[PublicAPIGetCommentTextResponse]

Esempio

Esempio getCommentText

Copy

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

getCommentVoteUserNames

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

Risposta

Restituisce: Option[GetCommentVoteUserNamesSuccessResponse]

Esempio

Esempio getCommentVoteUserNames

Copy

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

lockComment

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio lockComment

Copy

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

pinComment

Parametri

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

Risposta

Restituisce: Option[ChangeCommentPinStatusResponse]

Esempio

Esempio pinComment

Copy

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

saveComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createCommentParams	CreateCommentParams	No
options	SaveCommentOptions	No

Risposta

Restituisce: Option[APISaveCommentResponse]

Esempio

Esempio saveComment

Copy

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

saveCommentsBulk

Parametri

Name	Type	Required
tenantId	string	Yes
createCommentParams	seq[CreateCommentParams]	No
options	SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]]	No
id	string	No
fromName	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

saveCommentsBulk Esempio

Copy

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

setCommentText

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

Risposta

Restituisce: Option[PublicAPISetCommentTextResponse]

Esempio

setCommentText Esempio

Copy

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

unBlockUserFromComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
unBlockFromCommentParams	UnBlockFromCommentParams	No
options	UnBlockUserFromCommentOptions	No

Risposta

Restituisce: Option[UnblockSuccess]

Esempio

Esempio unBlockUserFromComment

Copy

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

unFlagComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
options	UnFlagCommentOptions	No

Risposta

Restituisce: Option[FlagCommentResponse]

Esempio

unFlagComment Esempio

Copy

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

unLockComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di unLockComment

Copy

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

unPinComment

Parametri

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

Risposta

Restituisce: Option[ChangeCommentPinStatusResponse]

Esempio

Esempio unPinComment

Copy

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

updateComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateComment

Copy

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

voteComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	No
voteBodyParams	VoteBodyParams	No
options	VoteCommentOptions	No

Risposta

Restituisce: Option[VoteResponse]

Esempio

Esempio voteComment

Copy

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

getCommentsForUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
options	GetCommentsForUserOptions	No

Risposta

Restituisce: Option[GetCommentsForUserResponse]

Esempio

Esempio getCommentsForUser

Copy

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

addDomainConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
addDomainConfigParams	AddDomainConfigParams	No

Risposta

Restituisce: Option[AddDomainConfigResponse]

Esempio

addDomainConfig Esempio

Copy

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

deleteDomainConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	No

Risposta

Restituisce: Option[DeleteDomainConfigResponse]

Esempio

Esempio deleteDomainConfig

Copy

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

getDomainConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
domain	string	No

Risposta

Restituisce: Option[GetDomainConfigResponse]

Esempio

Esempio di getDomainConfig

Copy

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

getDomainConfigs

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes

Risposta

Restituisce: Option[GetDomainConfigsResponse]

Esempio

Esempio getDomainConfigs

Copy

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

patchDomainConfig

Parametri

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
patchDomainConfigParams	PatchDomainConfigParams	No

Risposta

Restituisce: Option[PatchDomainConfigResponse]

Esempio

patchDomainConfig Esempio

Copy

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

putDomainConfig

Parametri

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

Risposta

Restituisce: Option[PutDomainConfigResponse]

Esempio

putDomainConfig Esempio

Copy

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

createEmailTemplate

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Risposta

Restituisce: Option[CreateEmailTemplateResponse]

Esempio

Esempio createEmailTemplate

Copy

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

deleteEmailTemplate

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio deleteEmailTemplate

Copy

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

deleteEmailTemplateRenderError

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
errorId	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deleteEmailTemplateRenderError Esempio

Copy

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

getEmailTemplate

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")
if response.isSome:
  let tmpl = response.get()

getEmailTemplateDefinitions

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì

Risposta

Restituisce: Option[GetEmailTemplateDefinitionsResponse]

Esempio

Esempio getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Parametri

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

Risposta

Restituisce: Option[GetEmailTemplateRenderErrorsResponse]

Esempio

getEmailTemplateRenderErrors Esempio

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # use resp as needed
else:
  # handle missing response
  discard

getEmailTemplates

Parameters

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Response

Restituisce: Option[GetEmailTemplatesResponse]

Example

Esempio getEmailTemplates

Copy

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

renderEmailTemplate

Parametri

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

Risposta

Restituisce: Option[RenderEmailTemplateResponse]

Esempio

renderEmailTemplate Esempio

Copy

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

updateEmailTemplate

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

updateEmailTemplate Esempio

Copy

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

getEventLog

req
tenantId
urlId
userIdWS

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Risposta

Restituisce: Option[GetEventLogResponse]

Esempio

Esempio getEventLog

Copy

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

getGlobalEventLog

req tenantId urlId userIdWS

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Risposta

Restituisce: Option[GetEventLogResponse]

Esempio

Esempio getGlobalEventLog

Copy

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

createFeedPost

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Risposta

Restituisce: Option[CreateFeedPostsResponse]

Esempio

createFeedPost Esempio

Copy

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

createFeedPostPublic

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostPublicOptions	No

Risposta

Restituisce: Option[CreateFeedPostResponse]

Esempio

Esempio createFeedPostPublic

Copy

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

deleteFeedPostPublic

Parametri

Name	Type	Required
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

Risposta

Restituisce: Option[DeleteFeedPostPublicResponse]

Esempio

Esempio deleteFeedPostPublic

Copy

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

getFeedPosts

req tenantId afterId

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetFeedPostsOptions	No

Risposta

Restituisce: Option[GetFeedPostsResponse]

Esempio

Esempio getFeedPosts

Copy

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

getFeedPostsPublic

req tenantId afterId

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetFeedPostsPublicOptions	No

Risposta

Restituisce: Option[PublicFeedPostsResponse]

Esempio

Esempio getFeedPostsPublic

Copy

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

getFeedPostsStats

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
postIds	seq[string]	No
sso	string = ""	No

Risposta

Restituisce: Option[FeedPostsStatsResponse]

Esempio

Esempio getFeedPostsStats

Copy

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

getUserReactsPublic

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetUserReactsPublicOptions	No

Risposta

Restituisce: Option[UserReactsResponse]

Esempio

Esempio getUserReactsPublic

Copy

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

reactFeedPostPublic

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
postId	string	No
reactBodyParams	ReactBodyParams	No
options	ReactFeedPostPublicOptions	No

Risposta

Restituisce: Option[ReactFeedPostResponse]

Esempio

Esempio reactFeedPostPublic

Copy

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

updateFeedPost

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

updateFeedPost Esempio

Copy

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

updateFeedPostPublic

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
postId	string	No
updateFeedPostParams	UpdateFeedPostParams	No
options	UpdateFeedPostPublicOptions	No

Risposta

Restituisce: Option[CreateFeedPostResponse]

Esempio

Esempio updateFeedPostPublic

Copy

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

flagCommentPublic

Parametri

Name	Type	Required
tenantId	string	Sì
commentId	string	Sì
isFlagged	bool	No
sso	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio flagCommentPublic

Copy

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

getGifLarge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
largeInternalURLSanitized	string	No

Risposta

Restituisce: Option[GifGetLargeResponse]

Esempio

getGifLarge Esempio

Copy

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

getGifsSearch

Parameters

Name	Type	Required
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

Response

Restituisce: Option[GetGifsSearchResponse]

Example

Esempio getGifsSearch

Copy

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

getGifsTrending

Parametri

Name	Type	Required	Description
tenantId	string	Yes
options	GetGifsTrendingOptions	No

Risposta

Restituisce: Option[GetGifsTrendingResponse]

Esempio

Esempio getGifsTrending

Copy

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

addHashTag

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Risposta

Restituisce: Option[CreateHashTagResponse]

Esempio

Esempio addHashTag

Copy

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

addHashTagsBulk

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Risposta

Restituisce: Option[BulkCreateHashTagsResponse]

Esempio

addHashTagsBulk Esempio

Copy

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

deleteHashTag

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio deleteHashTag

Copy

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

getHashTags

Parametri

Name	Type	Required	Description
tenantId	string	Yes
page	float64	No

Risposta

Restituisce: Option[GetHashTagsResponse]

Esempio

Esempio getHashTags

Copy

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

patchHashTag

Parametri

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

Risposta

Restituisce: Option[UpdateHashTagResponse]

Esempio

patchHashTag Esempio

Copy

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

deleteModerationVote

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
voteId	string	No
options	DeleteModerationVoteOptions	No

Risposta

Restituisce: Option[VoteDeleteResponse]

Esempio

deleteModerationVote Esempio

Copy

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

getApiComments

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetApiCommentsOptions	No

Risposta

Restituisce: Option[ModerationAPIGetCommentsResponse]

Esempio

Esempio getApiComments

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # è possibile eseguire ulteriori elaborazioni con `resp`

getApiExportStatus

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetApiExportStatusOptions	No

Risposta

Restituisce: Option[ModerationExportStatusResponse]

Esempio

getApiExportStatus Esempio

Copy

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

getApiIds

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetApiIdsOptions	No

Risposta

Restituisce: Option[ModerationAPIGetCommentIdsResponse]

Esempio

Esempio getApiIds

Copy

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

getBanUsersFromComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[GetBannedUsersFromCommentResponse]

Esempio

Esempio getBanUsersFromComment

Copy

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

getCommentBanStatus

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Risposta

Restituisce: Option[GetCommentBanStatusResponse]

Esempio

Esempio getCommentBanStatus

Copy

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

getCommentChildren

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Risposta

Restituisce: Option[ModerationAPIChildCommentsResponse]

Esempio

Esempio getCommentChildren

Copy

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

getCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetCountOptions	No

Risposta

Restituisce: Option[ModerationAPICountCommentsResponse]

Esempio

Esempio getCount

Copy

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

getCounts

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
sso	string = ""	No

Risposta

Restituisce: Option[GetBannedUsersCountResponse]

Esempio

Esempio getCounts

Copy

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

getLogs

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[ModerationAPIGetLogsResponse]

Esempio

Esempio getLogs

Copy

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

getManualBadges

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[GetTenantManualBadgesResponse]

Esempio

Esempio getManualBadges

Copy

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

getManualBadgesForUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetManualBadgesForUserOptions	No

Risposta

Restituisce: Option[GetUserManualBadgesResponse]

Esempio

Esempio getManualBadgesForUser

Copy

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

getModerationComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
options	GetModerationCommentOptions	No

Risposta

Restituisce: Option[ModerationAPICommentResponse]

Esempio

Esempio getModerationComment

Copy

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

getModerationCommentText

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[GetCommentTextResponse]

Esempio

Esempio getModerationCommentText

Copy

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

getPreBanSummary

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
options	GetPreBanSummaryOptions	No

Risposta

Restituisce: Option[PreBanSummary]

Esempio

getPreBanSummary Esempio

Copy

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

getSearchCommentsSummary

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetSearchCommentsSummaryOptions	No

Risposta

Restituisce: Option[ModerationCommentSearchResponse]

Esempio

getSearchCommentsSummary Esempio

Copy

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

getSearchPages

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetSearchPagesOptions	No

Risposta

Restituisce: Option[ModerationPageSearchResponse]

Esempio

Esempio getSearchPages

Copy

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

getSearchSites

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetSearchSitesOptions	No

Risposta

Restituisce: Option[ModerationSiteSearchResponse]

Esempio

Esempio di getSearchSites

Copy

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

getSearchSuggest

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetSearchSuggestOptions	No

Risposta

Restituisce: Option[ModerationSuggestResponse]

Esempio

Esempio getSearchSuggest

Copy

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

getSearchUsers

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetSearchUsersOptions	No

Risposta

Restituisce: Option[ModerationUserSearchResponse]

Esempio

Esempio getSearchUsers

Copy

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

getTrustFactor

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetTrustFactorOptions	No

Risposta

Restituisce: Option[GetUserTrustFactorResponse]

Esempio

Esempio getTrustFactor

Copy

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

getUserBanPreference

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[APIModerateGetUserBanPreferencesResponse]

Esempio

Esempio getUserBanPreference

Copy

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

getUserInternalProfile

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetUserInternalProfileOptions	No

Risposta

Restituisce: Option[GetUserInternalProfileResponse]

Esempio

getUserInternalProfile Esempio

Copy

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

postAdjustCommentVotes

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
adjustCommentVotesParams	AdjustCommentVotesParams	No
options	PostAdjustCommentVotesOptions	No

Risposta

Restituisce: Option[AdjustVotesResponse]

Esempio

Esempio postAdjustCommentVotes

Copy

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

postApiExport

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	PostApiExportOptions	No

Risposta

Restituisce: Option[ModerationExportResponse]

Esempio

postApiExport Esempio

Copy

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

postBanUserFromComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
options	PostBanUserFromCommentOptions	No

Risposta

Restituisce: Option[BanUserFromCommentResult]

Esempio

postBanUserFromComment Esempio

Copy

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

postBanUserUndo

Parametri

Name	Type	Required
tenantId	string	Sì
banUserUndoParams	BanUserUndoParams	No
sso	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

postBanUserUndo Esempio

Copy

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

postBulkPreBanSummary

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Risposta

Restituisce: Option[BulkPreBanSummary]

Esempio

Esempio postBulkPreBanSummary

Copy

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

postCommentsByIds

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentsByIdsParams	CommentsByIdsParams	No
sso	string = ""	No

Risposta

Restituisce: Option[ModerationAPIChildCommentsResponse]

Esempio

postCommentsByIds Esempio

Copy

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

postFlagComment

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

postFlagComment Esempio

Copy

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

postRemoveComment

Parameters

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
options	PostRemoveCommentOptions	No

Response

Restituisce: Option[PostRemoveCommentApiResponse]

Example

Esempio postRemoveComment

Copy

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

postRestoreDeletedComment

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
options	PostRestoreDeletedCommentOptions	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio postRestoreDeletedComment

Copy

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

postSetCommentApprovalStatus

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
options	PostSetCommentApprovalStatusOptions	No

Risposta

Restituisce: Option[SetCommentApprovedResponse]

Esempio

Esempio postSetCommentApprovalStatus

Copy

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

postSetCommentReviewStatus

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Si
commentId	string	Si
options	PostSetCommentReviewStatusOptions	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

postSetCommentReviewStatus Esempio

Copy

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

postSetCommentSpamStatus

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
options	PostSetCommentSpamStatusOptions	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

postSetCommentSpamStatus Esempio

Copy

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

postSetCommentText

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	No
options	PostSetCommentTextOptions	No

Risposta

Restituisce: Option[SetCommentTextResponse]

Esempio

Esempio postSetCommentText

Copy

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

postUnFlagComment

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

postUnFlagComment Esempio

Copy

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

postVote

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
options	PostVoteOptions	No

Risposta

Restituisce: Option[VoteResponse]

Esempio

postVote Esempio

Copy

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

putAwardBadge

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
badgeId	string	No
options	PutAwardBadgeOptions	No

Risposta

Restituisce: Option[AwardUserBadgeResponse]

Esempio

Esempio putAwardBadge

Copy

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

putCloseThread

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

putCloseThread Esempio

Copy

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

putRemoveBadge

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
badgeId	string	No
options	PutRemoveBadgeOptions	No

Risposta

Restituisce: Option[RemoveUserBadgeResponse]

Esempio

Esempio putRemoveBadge

Copy

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

putReopenThread

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio putReopenThread

Copy

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

setTrustFactor

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	SetTrustFactorOptions	No

Risposta

Restituisce: Option[SetUserTrustFactorResponse]

Esempio

Esempio setTrustFactor

Copy

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

createModerator

Parametri

Name	Type	Required	Description
tenantId	string	Sì
createModeratorBody	CreateModeratorBody	No

Risposta

Restituisce: Option[CreateModeratorResponse]

Esempio

Esempio createModerator

Copy

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

deleteModerator

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
sendEmail	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio deleteModerator

Copy

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

getModerator

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetModeratorResponse]

Esempio

Esempio getModerator

Copy

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

getModerators

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
skip	float64	No

Risposta

Restituisce: Option[GetModeratorsResponse]

Esempio

Esempio getModerators

Copy

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

updateModerator

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateModerator

Copy

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

deleteNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deleteNotificationCount Esempio

Copy

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

getCachedNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetCachedNotificationCountResponse]

Esempio

getCachedNotificationCount Esempio

Copy

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

getNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetNotificationCountOptions	No

Risposta

Returns: Option[GetNotificationCountResponse]

Esempio

Esempio getNotificationCount

Copy

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

getNotifications

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetNotificationsOptions	No

Risposta

Restituisce: Option[GetNotificationsResponse]

Esempio

Esempio getNotifications

Copy

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

updateNotification

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio updateNotification

Copy

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

createV1PageReact

Parametri

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

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

createV1PageReact Esempio

Copy

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

createV2PageReact

Parametri

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

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

createV2PageReact Esempio

Copy

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

deleteV1PageReact

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
urlId	string	Yes

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

Esempio deleteV1PageReact

Copy

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

deleteV2PageReact

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
id	string	No

Risposta

Restituisce: Option[CreateV1PageReact]

Esempio

Esempio deleteV2PageReact

Copy

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

getV1PageLikes

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/article-title")
if response.isSome:
  let pageLikes = response.get()
  # usa pageLikes come necessario

getV2PageReacts

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
urlId	string	Yes

Risposta

Restituisce: Option[GetV2PageReacts]

Esempio

Esempio getV2PageReacts

Copy

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

getV2PageReactUsers

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
id	string	No

Risposta

Restituisce: Option[GetV2PageReactUsersResponse]

Esempio

getV2PageReactUsers Esempio

Copy

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

addPage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Risposta

Restituisce: Option[AddPageAPIResponse]

Esempio

Esempio addPage

Copy

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

deletePage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[DeletePageAPIResponse]

Esempio

Esempio deletePage

Copy

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

getOfflineUsers

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
options	GetOfflineUsersOptions	No

Risposta

Restituisce: Option[PageUsersOfflineResponse]

Esempio

Esempio getOfflineUsers

Copy

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

getOnlineUsers

Visualizzatori attualmente online di una pagina: persone la cui sessione websocket è iscritta alla pagina in questo momento.
Restituisce anonCount + totalCount (sottoscrittori dell’intera stanza, inclusi visualizzatori anonimi che non elenchiamo).

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
urlId	string	Sì
options	GetOnlineUsersOptions	No

Risposta

Restituisce: Option[PageUsersOnlineResponse]

Esempio

Esempio getOnlineUsers

Copy

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

getPageByURLId

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
urlId	string	Yes

Risposta

Restituisce: Option[GetPageByURLIdAPIResponse]

Esempio

Esempio getPageByURLId

Copy

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

getPages

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes

Risposta

Restituisce: Option[GetPagesAPIResponse]

Esempio

Esempio getPages

Copy

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

getPagesPublic

Elenca le pagine per un tenant. Utilizzato dal client desktop FChat per popolare la sua lista delle stanze.
Richiede enableFChat impostato su true nella configurazione personalizzata risolta per ogni pagina.
Le pagine che richiedono SSO sono filtrate in base all'accesso ai gruppi dell'utente richiedente.

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetPagesPublicOptions	No

Risposta

Restituisce: Option[GetPublicPagesResponse]

Esempio

Esempio getPagesPublic

Copy

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

getUsersInfo

Informazioni di massa sugli utenti per un tenant. Dati gli userIds, restituisce le informazioni di visualizzazione da User / SSOUser.
Utilizzato dal widget dei commenti per arricchire gli utenti che sono appena comparsi tramite un evento di presenza.
Nessun contesto di pagina: la privacy è applicata uniformemente (i profili privati sono mascherati).

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

Restituisce: Option[PageUsersInfoResponse]

Example

Esempio getUsersInfo

Copy

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

patchPage

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Risposta

Restituisce: Option[PatchPageAPIResponse]

Esempio

Esempio patchPage

Copy

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

deletePendingWebhookEvent

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deletePendingWebhookEvent Esempio

Copy

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

getPendingWebhookEventCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetPendingWebhookEventCountOptions	No

Risposta

Restituisce: Option[GetPendingWebhookEventCountResponse]

Esempio

getPendingWebhookEventCount Esempio

Copy

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

getPendingWebhookEvents

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetPendingWebhookEventsOptions	No

Risposta

Restituisce: Option[GetPendingWebhookEventsResponse]

Esempio

getPendingWebhookEvents Esempio

Copy

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

createQuestionConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionConfigBody	CreateQuestionConfigBody	No

Risposta

Restituisce: Option[CreateQuestionConfigResponse]

Esempio

Esempio createQuestionConfig

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # usa resp secondo necessità

deleteQuestionConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deleteQuestionConfig Esempio

Copy

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

getQuestionConfig

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
id	string	No

Risposta

Restituisce: Option[GetQuestionConfigResponse]

Esempio

Esempio getQuestionConfig

Copy

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

getQuestionConfigs

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Risposta

Restituisce: Option[GetQuestionConfigsResponse]

Esempio

Esempio getQuestionConfigs

Copy

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

updateQuestionConfig

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateQuestionConfig

Copy

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

createQuestionResult

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createQuestionResultBody	CreateQuestionResultBody	No

Risposta

Restituisce: Option[CreateQuestionResultResponse]

Esempio

createQuestionResult Esempio

Copy

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

deleteQuestionResult

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio deleteQuestionResult

Copy

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

getQuestionResult

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
id	string	No

Risposta

Returns: Option[GetQuestionResultResponse]

Esempio

Esempio getQuestionResult

Copy

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

getQuestionResults

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetQuestionResultsOptions	No

Risposta

Restituisce: Option[GetQuestionResultsResponse]

Esempio

Esempio getQuestionResults

Copy

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

updateQuestionResult

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
updateQuestionResultBody	UpdateQuestionResultBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

updateQuestionResult Esempio

Copy

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

aggregateQuestionResults

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	AggregateQuestionResultsOptions	No

Risposta

Restituisce: Option[AggregateQuestionResultsResponse]

Esempio

aggregateQuestionResults Esempio

Copy

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

bulkAggregateQuestionResults

Parametri

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

Risposta

Restituisce: Option[BulkAggregateQuestionResultsResponse]

Esempio

bulkAggregateQuestionResults Esempio

Copy

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

combineCommentsWithQuestionResults

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	CombineCommentsWithQuestionResultsOptions	No

Risposta

Restituisce: Option[CombineQuestionResultsWithCommentsResponse]

Esempio

combineCommentsWithQuestionResults Esempio

Copy

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

addSSOUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPISSOUserData	CreateAPISSOUserData	No

Risposta

Restituisce: Option[AddSSOUserAPIResponse]

Esempio

Esempio addSSOUser

Copy

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

deleteSSOUser

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
options	DeleteSSOUserOptions	No

Risposta

Restituisce: Option[DeleteSSOUserAPIResponse]

Esempio

deleteSSOUser Esempio

Copy

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

getSSOUserByEmail

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
email	string	No

Risposta

Returns: Option[GetSSOUserByEmailAPIResponse]

Esempio

getSSOUserByEmail Esempio

Copy

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

getSSOUserById

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetSSOUserByIdAPIResponse]

Esempio

getSSOUserById Esempio

Copy

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

getSSOUsers

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
skip	int	No

Risposta

Restituisce: Option[GetSSOUsersResponse]

Esempio

Esempio getSSOUsers

Copy

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

patchSSOUser

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Risposta

Restituisce: Option[PatchSSOUserAPIResponse]

Esempio

patchSSOUser Esempio

Copy

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

putSSOUser

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Risposta

Restituisce: Option[PutSSOUserAPIResponse]

Esempio

Esempio putSSOUser

Copy

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

createSubscription

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	No

Risposta

Restituisce: Option[CreateSubscriptionAPIResponse]

Esempio

Esempio createSubscription

Copy

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

deleteSubscription

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
userId	string = ""	No

Risposta

Restituisce: Option[DeleteSubscriptionAPIResponse]

Esempio

Esempio deleteSubscription

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # usa apiResult secondo necessità

getSubscriptions

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
userId	string = ""	No

Risposta

Restituisce: Option[GetSubscriptionsAPIResponse]

Esempio

Esempio getSubscriptions

Copy

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

updateSubscription

Parametri

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

Risposta

Restituisce: Option[UpdateSubscriptionAPIResponse]

Esempio

updateSubscription Esempio

Copy

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

getTenantDailyUsages

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetTenantDailyUsagesOptions	No

Risposta

Restituisce: Option[GetTenantDailyUsagesResponse]

Esempio

Esempio getTenantDailyUsages

Copy

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

createTenantPackage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createTenantPackageBody	CreateTenantPackageBody	No

Risposta

Restituisce: Option[CreateTenantPackageResponse]

Esempio

createTenantPackage Esempio

Copy

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

deleteTenantPackage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deleteTenantPackage Esempio

Copy

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

getTenantPackage

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantPackageResponse]

Esempio

Esempio getTenantPackage

Copy

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

getTenantPackages

Parameters

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
skip	float64	No

Response

Restituisce: Option[GetTenantPackagesResponse]

Example

Esempio getTenantPackages

Copy

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

replaceTenantPackage

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

replaceTenantPackage Esempio

Copy

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

updateTenantPackage

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
updateTenantPackageBody	UpdateTenantPackageBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateTenantPackage

Copy

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

createTenantUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	No

Risposta

Restituisce: Option[CreateTenantUserResponse]

Esempio

Esempio createTenantUser

Copy

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

deleteTenantUser

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
id	string	No
options	DeleteTenantUserOptions	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deleteTenantUser Esempio

Copy

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

getTenantUser

Parameters

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Response

Restituisce: Option[GetTenantUserResponse]

Example

Esempio getTenantUser

Copy

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

getTenantUsers

Parameters

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
skip	float64	No

Response

Restituisce: Option[GetTenantUsersResponse]

Example

Esempio getTenantUsers

Copy

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

replaceTenantUser

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

replaceTenantUser Esempio

Copy

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

sendLoginLink

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di sendLoginLink

Copy

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

updateTenantUser

Parametri

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

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

updateTenantUser Esempio

Copy

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

createTenant

Parametri

Name	Type	Required	Description
tenantId	string	Yes
createTenantBody	CreateTenantBody	No

Risposta

Restituisce: Option[CreateTenantResponse]

Esempio

Esempio createTenant

Copy

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

deleteTenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
sure	string = ""	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

deleteTenant Esempio

Copy

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

getTenant

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetTenantResponse]

Esempio

Esempio getTenant

Copy

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

getTenants

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetTenantsOptions	No

Risposta

Restituisce: Option[GetTenantsResponse]

Esempio

Esempio getTenants

Copy

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

updateTenant

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

Risposta

Restituisce: Option[APIEmptyResponse]

Esempio

Esempio di updateTenant

Copy

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

changeTicketState

Parametri

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

Risposta

Restituisce: Option[ChangeTicketStateResponse]

Esempio

changeTicketState Esempio

Copy

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

createTicket

Parametri

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

Risposta

Restituisce: Option[CreateTicketResponse]

Esempio

Esempio createTicket

Copy

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

getTicket

Parametri

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

Risposta

Restituisce: Option[GetTicketResponse]

Esempio

Esempio getTicket

Copy

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

getTickets

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	GetTicketsOptions	No

Risposta

Restituisce: Option[GetTicketsResponse]

Esempio

Esempio getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # usa i ticket secondo necessità

getTranslations

Parametri

Nome	Tipo	Obbligatorio
namespace	string	No
component	string	No
options	GetTranslationsOptions	No

Risposta

Restituisce: Option[GetTranslationsResponse]

Esempio

Esempio getTranslations

Copy

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

uploadImage

Upload and resize an image

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Risposta

Restituisce: Option[UploadImageResponse]

Esempio

Esempio uploadImage

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # usa il risultato come necessario

getUserBadgeProgressById

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
id	string	No

Risposta

Restituisce: Option[APIGetUserBadgeProgressResponse]

Esempio

Esempio getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
userId	string	No

Risposta

Restituisce: Option[APIGetUserBadgeProgressResponse]

Esempio

Esempio getUserBadgeProgressByUserId

Copy

let (badgeProgressOpt, httpResp) = client.getUserBadgeProgressByUserId(tenantId = "my-tenant-123", userId = "user-456")
if badgeProgressOpt.isSome:
  let progress = badgeProgressOpt.get()
  echo progress

getUserBadgeProgressList

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetUserBadgeProgressListOptions	No

Risposta

Restituisce: Option[APIGetUserBadgeProgressListResponse]

Esempio

Esempio getUserBadgeProgressList

Copy

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

createUserBadge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
createUserBadgeParams	CreateUserBadgeParams	No

Risposta

Restituisce: Option[APICreateUserBadgeResponse]

Esempio

createUserBadge Esempio

Copy

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

deleteUserBadge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
id	string	No

Risposta

Restituisce: Option[APIEmptySuccessResponse]

Esempio

Esempio di deleteUserBadge

Copy

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

getUserBadge

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[APIGetUserBadgeResponse]

Esempio

getUserBadge Esempio

Copy

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

getUserBadges

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetUserBadgesOptions	No

Risposta

Restituisce: Option[APIGetUserBadgesResponse]

Esempio

Esempio getUserBadges

Copy

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

updateUserBadge

Parametri

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

Risposta

Restituisce: Option[APIEmptySuccessResponse]

Esempio

Esempio updateUserBadge

Copy

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

getUserNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
sso	string = ""	No

Risposta

Restituisce: Option[GetUserNotificationCountResponse]

Esempio

Esempio getUserNotificationCount

Copy

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

getUserNotifications

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
options	GetUserNotificationsOptions	No

Risposta

Restituisce: Option[GetMyNotificationsResponse]

Esempio

getUserNotifications Esempio

Copy

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

resetUserNotificationCount

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
sso	string = ""	No

Risposta

Restituisce: Option[ResetUserNotificationsResponse]

Esempio

Esempio resetUserNotificationCount

Copy

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

resetUserNotifications

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Yes
options	ResetUserNotificationsOptions	No

Risposta

Restituisce: Option[ResetUserNotificationsResponse]

Esempio

resetUserNotifications Esempio

Copy

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

updateUserNotificationCommentSubscriptionStatus

Abilita o disabilita le notifiche per un commento specifico.

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
notificationId	string	No
optedInOrOut	string	No
commentId	string	Yes
sso	string = ""	No

Risposta

Restituisce: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Esempio

updateUserNotificationCommentSubscriptionStatus Esempio

Copy

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

updateUserNotificationPageSubscriptionStatus

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

Parameters

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
url	string	No
pageTitle	string	No
subscribedOrUnsubscribed	string	No
sso	string = ""	No

Response

Restituisce: Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Example

Esempio updateUserNotificationPageSubscriptionStatus

Copy

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

updateUserNotificationStatus

Parametri

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

Risposta

Restituisce: Option[UpdateUserNotificationStatusResponse]

Esempio

Esempio updateUserNotificationStatus

Copy

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

getUserPresenceStatuses

Parametri

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

Risposta

Restituisce: Option[GetUserPresenceStatusesResponse]

Esempio

Esempio getUserPresenceStatuses

Copy

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

searchUsers

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

Risposta

Restituisce: Option[SearchUsersResult]

Esempio

Esempio searchUsers

Copy

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

getUser

Parametri

Nome	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì
id	string	No

Risposta

Restituisce: Option[GetUserResponse]

Esempio

Esempio getUser

Copy

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

createVote

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Sì
commentId	string	Sì
direction	string	No
options	CreateVoteOptions	No

Risposta

Restituisce: Option[VoteResponse]

Esempio

Esempio createVote

Copy

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

deleteVote

Parametri

Nome	Tipo	Obbligatorio
tenantId	string	Yes
id	string	No
editKey	string = ""	No

Risposta

Restituisce: Option[VoteDeleteResponse]

Esempio

Esempio deleteVote

Copy

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

getVotes

Parametri

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

Risposta

Restituisce: Option[GetVotesResponse]

Esempio

Esempio getVotes

Copy

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

getVotesForUser

Parameters

Name	Type	Required
tenantId	string	Sì
urlId	string	Sì
options	GetVotesForUserOptions	No

Response

Restituisce: Option[GetVotesForUserResponse]

Esempio

Esempio getVotesForUser

Copy

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

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

Utilizzare Nimble

Compilare dal codice sorgente

Contenuto della libreria

API pubbliche vs API sicure

Il modulo api_moderation offre una suite completa di API di moderazione live e rapide. Ogni metodo api_moderation accetta un parametro sso e può autenticarsi tramite SSO o un cookie di sessione di FastComments.com.

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 per gli endpoint API

Documentazione per i modelli

aggregate

Parameters

Response

Example

getAuditLogs

Parametri

Risposta

Esempio

logoutPublic

Il modulo `api_moderation` offre una suite completa di API di moderazione live e rapide. Ogni metodo `api_moderation` accetta un parametro `sso` e può autenticarsi tramite SSO o un cookie di sessione di FastComments.com.