SDK Nim de FastComments

Ceci est le SDK Nim officiel pour FastComments.

SDK Nim officiel pour l'API FastComments

Dépôt

Exigences

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installation

Utilisation de Nimble

nimble install fastcomments

Compilation à partir du code source

nimble build

Contenu de la bibliothèque

Cette bibliothèque contient le client API généré ainsi que les utilitaires SSO pour faciliter l’utilisation de l’API.

Documentation de la bibliothèque client API

APIs publiques vs sécurisées

Pour le client API, il existe trois modules API, api_default, api_public et api_moderation. Le module api_default contient des méthodes qui nécessitent votre clé API, et le module api_public contient des appels API qui peuvent être effectués directement depuis un navigateur, un appareil mobile, etc., sans authentification. Le module api_moderation contient des méthodes pour le tableau de bord du modérateur.

Le module api_moderation offre une suite étendue d’API de modération en temps réel et rapides. Chaque méthode api_moderation accepte un paramètre sso et peut s’authentifier via SSO ou un cookie de session FastComments.com.

Démarrage rapide

Utilisation des APIs authentifiées (DefaultAPI)

Important : Les points de terminaison authentifiés exigent que votre clé API soit définie dans l’en‑tête 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"

# Effectuer des appels API authentifiés.
# Les paramètres requis (et le corps de la requête) sont positionnels ; les
# paramètres sont passés via l'objet d'options de l'opération.
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"

Utilisation des APIs publiques (PublicAPI)

Les points de terminaison publics ne nécessitent pas d'authentification :

import httpclient
import fastcomments
import fastcomments/apis/api_public

let client = newHttpClient()

# Effectuer des appels API publics.
# tenantId et urlId sont requis (positionnels) ; tout le reste est optionnel.
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"

Utilisation des APIs de modération (ModerationAPI)

Les points de terminaison de modération alimentent le tableau de bord des modérateurs et sont authentifiés avec un jeton SSO pour le modérateur agissant :

import httpclient
import fastcomments
import fastcomments/apis/api_moderation

let client = newHttpClient()

# Lister les commentaires dans le tableau de bord de modération.
# Cette opération n'a aucun paramètre requis, donc tout est optionnel.
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"

Problèmes courants

Erreur d'authentification 401 : Assurez‑vous de définir l’en‑tête x-api-key sur votre HttpClient avant d’effectuer des requêtes DefaultAPI : client.headers["x-api-key"] = "your-api-key"
Classe d'API incorrecte : Utilisez api_default pour les requêtes authentifiées côté serveur, api_public pour les requêtes côté client/public, et api_moderation pour les requêtes du tableau de bord des modérateurs.

Effectuer des appels API

Toutes les méthodes d’API dans ce SDK renvoient des tuples de (Option[ResponseType], Response). Le premier élément contient la réponse analysée si la requête réussit, et le deuxième élément est la réponse HTTP brute.

Les paramètres requis et le corps de la requête sont passés positionnellement. Les paramètres optionnels restants sont regroupés dans un seul objet Api<Operation>Options, qui constitue le dernier argument. Les opérations qui n’ont pas de paramètres optionnels n’utilisent aucun objet d’options.

Exemple : Récupération des commentaires

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"

Remarques

Identifiants de diffusion

Vous verrez que vous devez transmettre un broadcastId dans certains appels d'API. Lorsque vous recevez des événements, vous recevrez cet ID en retour, ce qui vous permet de savoir quand ignorer l'événement si vous prévoyez d'appliquer des modifications de façon optimiste côté client (ce que vous voudrez probablement faire, car cela offre la meilleure expérience). Transmettez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session de navigateur.

SSO (Authentification unique)

Pour des exemples d'authentification unique, voir ci‑dessous.

Utilisation du SSO

SSO simple

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 sécurisé

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

Documentation pour fastcomments

Documentation des points d’accès API

Tous les URI sont relatifs à https://fastcomments.com

Classe	Méthode	Requête HTTP	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	Agrège les documents en les regroupant (si « groupBy » est fourni) et en appliquant plusieurs opérations. Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.
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	Commentateurs précédents de la page qui ne sont PAS actuellement en ligne. Triés par displayName. Utilisez ceci après avoir épuisé /users/online pour rendre une section « Membres ». Pagination par curseur sur commenterName : le serveur parcourt l’index partiel {tenantId, urlId, commenterName} à partir de afterName en avant via $gt, sans coût $skip.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Spectateurs actuellement en ligne d’une page : personnes dont la session websocket est abonnée à la page en ce moment. Retourne anonCount + totalCount (abonnés à toute la salle, y compris les spectateurs anonymes que nous n’énumérons pas).
PublicApi	getPagesPublic	GET /pages/{tenantId}	Répertorie les pages d’un locataire. Utilisé par le client de bureau FChat pour remplir sa liste de salles. Nécessite que `enableFChat` soit vrai dans la configuration personnalisée résolue pour chaque page. Les pages qui nécessitent SSO sont filtrées selon l’accès aux groupes de l’utilisateur demandeur.
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	Informations d’utilisateurs en masse pour un locataire. Donnés des userIds, renvoie les informations d’affichage provenant de User / SSOUser. Utilisé par le widget de commentaire pour enrichir les utilisateurs qui viennent d’apparaître via un événement de présence. Aucun contexte de page : la confidentialité est appliquée uniformément (les profils privés sont masqués).
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}	Activer ou désactiver les notifications pour un commentaire spécifique.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Activer ou désactiver les notifications pour une page. Lorsque les utilisateurs sont abonnés à une page, des notifications sont créées pour les nouveaux commentaires racine, et aussi
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Télécharger et redimensionner une image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation des modèles

aggregate

Agrège les documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations.
Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
aggregationRequest	AggregationRequest	Non
options	AggregateOptions	Non

Réponse

Renvoie : Option[AggregateResponse]

Exemple

Exemple d'agrégation

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetAuditLogsOptions	No

Réponse

Renvoie : Option[GetAuditLogsResponse]

Exemple

Exemple getAuditLogs

Copy

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

logoutPublic

Réponse

Renvoie: Option[APIEmptyResponse]

Exemple

Exemple logoutPublic

Copy

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

blockFromCommentPublic

Paramètres

Nom	Type	Requis
tenantId	string	Oui
commentId	string	Oui
publicBlockFromCommentParams	PublicBlockFromCommentParams	Non
sso	string = ""	Non

Réponse

Renvoie : Option[BlockSuccess]

Exemple

blockFromCommentPublic Exemple

Copy

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

unBlockCommentPublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
publicBlockFromCommentParams	PublicBlockFromCommentParams	Non
sso	string = ""	Non

Réponse

Retourne : Option[UnblockSuccess]

Exemple

Exemple unBlockCommentPublic

Copy

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

checkedCommentsForBlocked

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentIds	string	Non
sso	string = ""	Non

Réponse

Renvoie : Option[CheckBlockedCommentsResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
blockFromCommentParams	BlockFromCommentParams	Non
options	BlockUserFromCommentOptions	Non

Réponse

Renvoie : Option[BlockSuccess]

Exemple

blockUserFromComment Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
broadcastId	string	Non
commentData	CommentData	Non
options	CreateCommentPublicOptions	Non

Réponse

Renvoie : Option[SaveCommentsResponseWithPresence]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
options	DeleteCommentOptions	Non

Réponse

Renvoie : Option[DeleteCommentResult]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
options	DeleteCommentPublicOptions	Non

Réponse

Renvoie : Option[PublicAPIDeleteCommentResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
voteId	string	Non
urlId	string	Oui
broadcastId	string	Non
options	DeleteCommentVoteOptions	Non

Réponse

Renvoie : Option[VoteDeleteResponse]

Exemple

deleteCommentVote Exemple

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

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
options	FlagCommentOptions	Non

Réponse

Renvoie : Option[FlagCommentResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[APIGetCommentResponse]

Exemple

Exemple getComment

Copy

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

getComments

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetCommentsOptions	No

Réponse

Renvoie : Option[APIGetCommentsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
options	GetCommentsPublicOptions	Non

Réponse

Renvoie : Option[GetCommentsResponseWithPresencePublicComment]

Exemple

Exemple getCommentsPublic

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	GetCommentTextOptions	Non

Réponse

Retourne : Option[PublicAPIGetCommentTextResponse]

Exemple

Exemple getCommentText

Copy

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

getCommentVoteUserNames

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
dir	int	No
sso	string = ""	No

Réponse

Retourne : Option[GetCommentVoteUserNamesSuccessResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
sso	string = ""	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
sso	string = ""	Non

Réponse

Renvoie : Option[ChangeCommentPinStatusResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
createCommentParams	CreateCommentParams	Non
options	SaveCommentOptions	Non

Réponse

Renvoie : Option[APISaveCommentResponse]

Exemple

Exemple 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

Paramètres

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

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

saveCommentsBulk Exemple

Copy

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

setCommentText

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
broadcastId	string	Non
commentTextUpdateRequest	CommentTextUpdateRequest	Non
options	SetCommentTextOptions	Non

Réponse

Retourne : Option[PublicAPISetCommentTextResponse]

Exemple

Exemple setCommentText

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
unBlockFromCommentParams	UnBlockFromCommentParams	Non
options	UnBlockUserFromCommentOptions	Non

Réponse

Renvoie : Option[UnblockSuccess]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
options	UnFlagCommentOptions	No

Réponse

Renvoie : Option[FlagCommentResponse]

Exemple

Exemple unFlagComment

Copy

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

unLockComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
sso	string = ""	No

Réponse

Returns: Option[APIEmptyResponse]

Exemple

Exemple de 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

Paramètres

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

Réponse

Retourne : Option[ChangeCommentPinStatusResponse]

Exemple

Exemple 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

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
updatableCommentParams	UpdatableCommentParams	Non
options	UpdateCommentOptions	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
urlId	string	Oui
broadcastId	string	Non
voteBodyParams	VoteBodyParams	Non
options	VoteCommentOptions	Non

Réponse

Retourne : Option[VoteResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
options	GetCommentsForUserOptions	Non

Réponse

Retourne : Option[GetCommentsForUserResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
addDomainConfigParams	AddDomainConfigParams	Non

Réponse

Renvoie: Option[AddDomainConfigResponse]

Exemple

addDomainConfig Exemple

Copy

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

deleteDomainConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
domain	string	Non

Réponse

Renvoie : Option[DeleteDomainConfigResponse]

Exemple

deleteDomainConfig Exemple

Copy

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

getDomainConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
domain	string	No

Réponse

Renvoie : Option[GetDomainConfigResponse]

Exemple

getDomainConfig Exemple

Copy

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

getDomainConfigs

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui

Réponse

Renvoie : Option[GetDomainConfigsResponse]

Exemple

Exemple getDomainConfigs

Copy

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

patchDomainConfig

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
domainToUpdate	string	Non
patchDomainConfigParams	PatchDomainConfigParams	Non

Réponse

Retourne : Option[PatchDomainConfigResponse]

Exemple

Exemple patchDomainConfig

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

Paramètres

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Réponse

Retourne : Option[PutDomainConfigResponse]

Exemple

putDomainConfig Exemple

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createEmailTemplateBody	CreateEmailTemplateBody	Non

Réponse

Retourne : Option[CreateEmailTemplateResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

deleteEmailTemplate Exemple

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

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
errorId	string	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

deleteEmailTemplateRenderError Exemple

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

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetEmailTemplateResponse]

Exemple

Exemple getEmailTemplate

Copy

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

getEmailTemplateDefinitions

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui

Réponse

Renvoie : Option[GetEmailTemplateDefinitionsResponse]

Exemple

Exemple getEmailTemplateDefinitions

Copy

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

getEmailTemplateRenderErrors

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
skip	float64	Non

Réponse

Renvoie : Option[GetEmailTemplateRenderErrorsResponse]

Exemple

getEmailTemplateRenderErrors Exemple

Copy

let (optResp, httpResp) = client.getEmailTemplateRenderErrors(
  tenantId = "my-tenant-123",
  id = "welcome-template",
  skip = 0.0
)
if optResp.isSome:
  let resp = optResp.get()
  # utiliser la réponse selon les besoins
else:
  # gérer la réponse manquante
  discard

getEmailTemplates

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetEmailTemplatesResponse]

Exemple

Exemple getEmailTemplates

Copy

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

renderEmailTemplate

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	No
locale	string = ""	No

Réponse

Retourne : Option[RenderEmailTemplateResponse]

Exemple

Exemple renderEmailTemplate

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
updateEmailTemplateBody	UpdateEmailTemplateBody	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

updateEmailTemplate Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
userIdWS	string	Non
startTime	int64	Non
endTime	int64	Non

Réponse

Retourne: Option[GetEventLogResponse]

Exemple

getEventLog Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
userIdWS	string	Non
startTime	int64	Non
endTime	int64	Non

Réponse

Renvoie : Option[GetEventLogResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
createFeedPostParams	CreateFeedPostParams	Non
options	CreateFeedPostOptions	Non

Réponse

Renvoie : Option[CreateFeedPostsResponse]

Exemple

Exemple de createFeedPost

Copy

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

createFeedPostPublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
createFeedPostParams	CreateFeedPostParams	Non
options	CreateFeedPostPublicOptions	Non

Réponse

Renvoie : Option[CreateFeedPostResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
postId	string	No
options	DeleteFeedPostPublicOptions	No

Réponse

Retourne : Option[DeleteFeedPostPublicResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetFeedPostsOptions	Non

Réponse

Retourne : Option[GetFeedPostsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetFeedPostsPublicOptions	Non

Réponse

Renvoie : Option[PublicFeedPostsResponse]

Exemple

Exemple getFeedPostsPublic

Copy

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

getFeedPostsStats

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
postIds	seq[string]	Non
sso	string = ""	Non

Réponse

Retourne : Option[FeedPostsStatsResponse]

Exemple

Exemple 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()
  # utilisez les statistiques selon les besoins

getUserReactsPublic

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserReactsPublicOptions	Non

Réponse

Renvoie : Option[UserReactsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
postId	string	Non
reactBodyParams	ReactBodyParams	Non
options	ReactFeedPostPublicOptions	Non

Réponse

Retourne : Option[ReactFeedPostResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
feedPost	FeedPost	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

updateFeedPost Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
postId	string	Non
updateFeedPostParams	UpdateFeedPostParams	Non
options	UpdateFeedPostPublicOptions	Non

Réponse

Renvoie : Option[CreateFeedPostResponse]

Exemple

Exemple de 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

Paramètres

Name	Type	Required
tenantId	string	Oui
commentId	string	Oui
isFlagged	bool	Non
sso	string = ""	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

flagCommentPublic Exemple

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
largeInternalURLSanitized	string	Non

Réponse

Retourne : Option[GifGetLargeResponse]

Exemple

Exemple getGifLarge

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
search	string	No
options	GetGifsSearchOptions	No

Réponse

Renvoie : Option[GetGifsSearchResponse]

Exemple

Exemple 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()
  # use resp as needed

getGifsTrending

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetGifsTrendingOptions	Non

Réponse

Retourne : Option[GetGifsTrendingResponse]

Exemple

Exemple getGifsTrending

Copy

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

addHashTag

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Réponse

Retourne : Option[CreateHashTagResponse]

Exemple

addHashTag Exemple

Copy

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

addHashTagsBulk

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Non

Réponse

Renvoie : Option[BulkCreateHashTagsResponse]

Exemple

Exemple addHashTagsBulk

Copy

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

deleteHashTag

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
tag	string	Non
deleteHashTagRequestBody	DeleteHashTagRequestBody	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

deleteHashTag Exemple

Copy

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

getHashTags

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
page	float64	Non

Réponse

Renvoie : Option[GetHashTagsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
tag	string	No
updateHashTagBody	UpdateHashTagBody	No

Réponse

Retourne : Option[UpdateHashTagResponse]

Exemple

Exemple de patchHashTag

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
voteId	string	Non
options	DeleteModerationVoteOptions	Non

Réponse

Renvoie : Option[VoteDeleteResponse]

Exemple

Exemple de deleteModerationVote

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetApiCommentsOptions	Non

Réponse

Renvoie: Option[ModerationAPIGetCommentsResponse]

Exemple

Exemple getApiComments

Copy

let (maybeResp, httpResp) = client.getApiComments(tenantId = "my-tenant-123", options = GetApiCommentsOptions())
if maybeResp.isSome:
  let resp = maybeResp.get()
  # un traitement supplémentaire peut être effectué avec `resp`

getApiExportStatus

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetApiExportStatusOptions	Non

Réponse

Renvoie : Option[ModerationExportStatusResponse]

Exemple

Exemple getApiExportStatus

Copy

let (exportStatusOpt, httpResp) = client.getApiExportStatus(
  tenantId = "my-tenant-123",
  options = GetApiExportStatusOptions()
)
if exportStatusOpt.isSome:
  let exportStatus = exportStatusOpt.get()
  # utiliser exportStatus selon les besoins

getApiIds

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetApiIdsOptions	Non

Réponse

Retourne : Option[ModerationAPIGetCommentIdsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Requis
tenantId	string	Yes
commentId	string	Yes
sso	string = ""	No

Réponse

Renvoie : Option[GetBannedUsersFromCommentResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
sso	string = ""	Non

Réponse

Renvoie : Option[GetCommentBanStatusResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
sso	string = ""	Non

Réponse

Renvoie : Option[ModerationAPIChildCommentsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetCountOptions	Non

Réponse

Renvoie : Option[ModerationAPICountCommentsResponse]

Exemple

Exemple getCount

Copy

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

getCounts

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
sso	string = ""	Non

Réponse

Retourne : Option[GetBannedUsersCountResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
sso	string = ""	Non

Réponse

Renvoie : Option[ModerationAPIGetLogsResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
sso	string = ""	Non

Réponse

Renvoie : Option[GetTenantManualBadgesResponse]

Exemple

Exemple getManualBadges

Copy

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

getManualBadgesForUser

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetManualBadgesForUserOptions	Non

Réponse

Retourne : Option[GetUserManualBadgesResponse]

Exemple

getManualBadgesForUser Exemple

Copy

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

getModerationComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	GetModerationCommentOptions	Non

Réponse

Retourne : Option[ModerationAPICommentResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
sso	string = ""	Non

Réponse

Retourne: Option[GetCommentTextResponse]

Exemple

getModerationCommentText Exemple

Copy

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

getPreBanSummary

Paramètres

Nom	Type	Requis
tenantId	string	Yes
commentId	string	Yes
options	GetPreBanSummaryOptions	No

Réponse

Renvoie : Option[PreBanSummary]

Exemple

Exemple getPreBanSummary

Copy

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

getSearchCommentsSummary

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchCommentsSummaryOptions	Non

Réponse

Retourne : Option[ModerationCommentSearchResponse]

Exemple

Exemple getSearchCommentsSummary

Copy

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

getSearchPages

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetSearchPagesOptions	No

Réponse

Retourne : Option[ModerationPageSearchResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchSitesOptions	Non

Réponse

Renvoie : Option[ModerationSiteSearchResponse]

Exemple

Exemple getSearchSites

Copy

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

getSearchSuggest

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchSuggestOptions	Non

Réponse

Renvoie : Option[ModerationSuggestResponse]

Exemple

Exemple getSearchSuggest

Copy

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

getSearchUsers

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchUsersOptions	Non

Réponse

Retourne : Option[ModerationUserSearchResponse]

Exemple

getSearchUsers Exemple

Copy

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

getTrustFactor

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
options	GetTrustFactorOptions	No

Réponse

Retourne : Option[GetUserTrustFactorResponse]

Exemple

Exemple getTrustFactor

Copy

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

getUserBanPreference

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
sso	string = ""	Non

Réponse

Renvoie : Option[APIModerateGetUserBanPreferencesResponse]

Exemple

Exemple getUserBanPreference

Copy

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

getUserInternalProfile

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserInternalProfileOptions	Non

Réponse

Renvoie : Option[GetUserInternalProfileResponse]

Exemple

Exemple getUserInternalProfile

Copy

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

postAdjustCommentVotes

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
adjustCommentVotesParams	AdjustCommentVotesParams	Non
options	PostAdjustCommentVotesOptions	Non

Réponse

Retourne : Option[AdjustVotesResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	PostApiExportOptions	Non

Réponse

Renvoie : Option[ModerationExportResponse]

Exemple

postApiExport Exemple

Copy

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

postBanUserFromComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	PostBanUserFromCommentOptions	Non

Réponse

Renvoie : Option[BanUserFromCommentResult]

Exemple

postBanUserFromComment Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
banUserUndoParams	BanUserUndoParams	Non
sso	string = ""	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple postBanUserUndo

Copy

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

postBulkPreBanSummary

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
bulkPreBanParams	BulkPreBanParams	Non
options	PostBulkPreBanSummaryOptions	Non

Réponse

Renvoie : Option[BulkPreBanSummary]

Exemple

postBulkPreBanSummary Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentsByIdsParams	CommentsByIdsParams	Non
sso	string = ""	Non

Réponse

Retourne : Option[ModerationAPIChildCommentsResponse]

Exemple

Exemple postCommentsByIds

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()
  # utiliser la réponse au besoin

postFlagComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	PostFlagCommentOptions	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de postFlagComment

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

Paramètres

Nom	Type	Requis
tenantId	string	Oui
commentId	string	Oui
options	PostRemoveCommentOptions	Non

Réponse

Renvoie : Option[PostRemoveCommentApiResponse]

Exemple

Exemple postRemoveComment

Copy

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

postRestoreDeletedComment

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
options	PostRestoreDeletedCommentOptions	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

postRestoreDeletedComment Exemple

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

Paramètres

Name	Type	Required
tenantId	string	Oui
commentId	string	Oui
options	PostSetCommentApprovalStatusOptions	Non

Réponse

Renvoie : Option[SetCommentApprovedResponse]

Exemple

Exemple de 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

Paramètres

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

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

postSetCommentReviewStatus Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	PostSetCommentSpamStatusOptions	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

postSetCommentSpamStatus Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
setCommentTextParams	SetCommentTextParams	Non
options	PostSetCommentTextOptions	Non

Réponse

Retourne : Option[SetCommentTextResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	PostUnFlagCommentOptions	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

postUnFlagComment Exemple

Copy

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

postVote

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
options	PostVoteOptions	Non

Réponse

Renvoie : Option[VoteResponse]

Exemple

postVote Exemple

Copy

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

putAwardBadge

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
badgeId	string	Non
options	PutAwardBadgeOptions	Non

Réponse

Retourne : Option[AwardUserBadgeResponse]

Exemple

putAwardBadge Exemple

Copy

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

putCloseThread

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
sso	string = ""	Non

Réponse

Returns: Option[APIEmptyResponse]

Exemple

Exemple putCloseThread

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
badgeId	string	Non
options	PutRemoveBadgeOptions	Non

Réponse

Retourne : Option[RemoveUserBadgeResponse]

Exemple

Exemple putRemoveBadge

Copy

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

putReopenThread

Parameters

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
sso	string = ""	Non

Response

Returns: Option[APIEmptyResponse]

Example

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	SetTrustFactorOptions	Non

Réponse

Retourne : Option[SetUserTrustFactorResponse]

Exemple

setTrustFactor Exemple

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createModeratorBody	CreateModeratorBody	Non

Réponse

Renvoie : Option[CreateModeratorResponse]

Exemple

createModerator Exemple

Copy

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

deleteModerator

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
sendEmail	string = ""	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetModeratorResponse]

Exemple

Exemple getModerator

Copy

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

getModerators

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetModeratorsResponse]

Exemple

Exemple getModerators

Copy

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

updateModerator

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateModeratorBody	UpdateModeratorBody	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
id	string	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple deleteNotificationCount

Copy

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

getCachedNotificationCount

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetCachedNotificationCountResponse]

Exemple

Exemple getCachedNotificationCount

Copy

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

getNotificationCount

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
options	GetNotificationCountOptions	Non

Réponse

Renvoie : Option[GetNotificationCountResponse]

Exemple

Exemple getNotificationCount

Copy

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

getNotifications

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetNotificationsOptions	Non

Réponse

Retourne : Option[GetNotificationsResponse]

Exemple

Exemple getNotifications

Copy

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

updateNotification

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateNotificationBody	UpdateNotificationBody	Non
userId	string = ""	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
title	string = ""	Non

Réponse

Renvoie : Option[CreateV1PageReact]

Exemple

Exemple createV1PageReact

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
id	string	Non
title	string = ""	Non

Réponse

Renvoie : Option[CreateV1PageReact]

Exemple

Exemple createV2PageReact

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()
  # utilisez `page` selon vos besoins

deleteV1PageReact

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Retourne : Option[CreateV1PageReact]

Exemple

deleteV1PageReact Exemple

Copy

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

deleteV2PageReact

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
urlId	string	Yes
id	string	No

Réponse

Renvoie : Option[CreateV1PageReact]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Renvoie : Option[GetV1PageLikes]

Exemple

Exemple getV1PageLikes

Copy

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

getV2PageReacts

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
urlId	string	Yes

Réponse

Renvoie : Option[GetV2PageReacts]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
urlId	string	Yes
id	string	No

Réponse

Renvoie : Option[GetV2PageReactUsersResponse]

Exemple

Exemple getV2PageReactUsers

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createAPIPageData	CreateAPIPageData	Non

Réponse

Retourne : Option[AddPageAPIResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[DeletePageAPIResponse]

Exemple

Exemple 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.

Parameters

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

Response

Renvoie : Option[PageUsersOfflineResponse]

Example

Exemple de 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

Spectateurs en ligne d'une page : personnes dont la session websocket est actuellement abonnée à la page.
Renvoie anonCount + totalCount (abonnés à l’ensemble de la salle, y compris les spectateurs anonymes que nous n’énumérons pas).

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
options	GetOnlineUsersOptions	Non

Réponse

Renvoie : Option[PageUsersOnlineResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
urlId	string	Yes

Réponse

Retourne : Option[GetPageByURLIdAPIResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui

Réponse

Renvoie : Option[GetPagesAPIResponse]

Exemple

Exemple 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

Lister les pages pour un locataire. Utilisé par le client de bureau FChat pour remplir sa liste de salles.
Nécessite que enableFChat soit vrai dans la configuration personnalisée résolue pour chaque page.
Les pages qui nécessitent SSO sont filtrées en fonction de l’accès aux groupes de l’utilisateur demandeur.

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetPagesPublicOptions	Non

Réponse

Retourne : Option[GetPublicPagesResponse]

Exemple

Exemple getPagesPublic

Copy

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

getUsersInfo

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Utilisé par le widget de commentaires pour enrichir les utilisateurs qui viennent d'apparaître via un événement de présence.
Aucun contexte de page : la confidentialité est appliquée uniformément (les profils privés sont masqués).

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
ids	string	Non

Réponse

Renvoie : Option[PageUsersInfoResponse]

Exemple

Exemple getUsersInfo

Copy

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

patchPage

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
updateAPIPageData	UpdateAPIPageData	No

Réponse

Retourne : Option[PatchPageAPIResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

deletePendingWebhookEvent Exemple

Copy

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

getPendingWebhookEventCount

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetPendingWebhookEventCountOptions	No

Réponse

Renvoie : Option[GetPendingWebhookEventCountResponse]

Exemple

Exemple getPendingWebhookEventCount

Copy

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

getPendingWebhookEvents

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetPendingWebhookEventsOptions	Non

Réponse

Renvoie : Option[GetPendingWebhookEventsResponse]

Exemple

Exemple getPendingWebhookEvents

Copy

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

createQuestionConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createQuestionConfigBody	CreateQuestionConfigBody	Non

Réponse

Retourne : Option[CreateQuestionConfigResponse]

Exemple

Exemple createQuestionConfig

Copy

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

deleteQuestionConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

deleteQuestionConfig Exemple

Copy

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

getQuestionConfig

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[GetQuestionConfigResponse]

Exemple

Exemple getQuestionConfig

Copy

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

getQuestionConfigs

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
skip	float64	No

Réponse

Retourne : Option[GetQuestionConfigsResponse]

Exemple

Exemple getQuestionConfigs

Copy

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

updateQuestionConfig

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateQuestionConfigBody	UpdateQuestionConfigBody	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de updateQuestionConfig

Copy

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

createQuestionResult

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	No

Réponse

Renvoie : Option[CreateQuestionResultResponse]

Exemple

Exemple de createQuestionResult

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple de deleteQuestionResult

Copy

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

getQuestionResult

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetQuestionResultResponse]

Exemple

Exemple getQuestionResult

Copy

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

getQuestionResults

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetQuestionResultsOptions	Non

Réponse

Renvoie : Option[GetQuestionResultsResponse]

Exemple

Exemple getQuestionResults

Copy

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

updateQuestionResult

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateQuestionResultBody	UpdateQuestionResultBody	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de updateQuestionResult

Copy

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

aggregateQuestionResults

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	AggregateQuestionResultsOptions	No

Réponse

Renvoie : Option[AggregateQuestionResultsResponse]

Exemple

aggregateQuestionResults Exemple

Copy

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

bulkAggregateQuestionResults

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Non
forceRecalculate	bool	Non

Réponse

Renvoie : Option[BulkAggregateQuestionResultsResponse]

Exemple

Exemple bulkAggregateQuestionResults

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	CombineCommentsWithQuestionResultsOptions	Non

Réponse

Retourne : Option[CombineQuestionResultsWithCommentsResponse]

Exemple

combineCommentsWithQuestionResults Exemple

Copy

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

addSSOUser

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createAPISSOUserData	CreateAPISSOUserData	Non

Réponse

Retourne : Option[AddSSOUserAPIResponse]

Exemple

Exemple addSSOUser

Copy

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

deleteSSOUser

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
options	DeleteSSOUserOptions	Non

Réponse

Retourne : Option[DeleteSSOUserAPIResponse]

Exemple

Exemple deleteSSOUser

Copy

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

getSSOUserByEmail

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
email	string	Non

Réponse

Renvoie : Option[GetSSOUserByEmailAPIResponse]

Exemple

Exemple getSSOUserByEmail

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[GetSSOUserByIdAPIResponse]

Exemple

Exemple getSSOUserById

Copy

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

getSSOUsers

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	int	Non

Réponse

Retourne : Option[GetSSOUsersResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateAPISSOUserData	UpdateAPISSOUserData	Non
updateComments	bool	Non

Réponse

Renvoie : Option[PatchSSOUserAPIResponse]

Exemple

Exemple patchSSOUser

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateAPISSOUserData	UpdateAPISSOUserData	Non
updateComments	bool	Non

Réponse

Retourne : Option[PutSSOUserAPIResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Non

Réponse

Retourne : Option[CreateSubscriptionAPIResponse]

Exemple

Exemple createSubscription

Copy

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

deleteSubscription

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
userId	string = ""	Non

Réponse

Retourne: Option[DeleteSubscriptionAPIResponse]

Exemple

Exemple de deleteSubscription

Copy

let (maybeResp, httpResp) = client.deleteSubscription(
  tenantId = "my-tenant-123",
  id = "sub-789",
  userId = ""
)
if maybeResp.isSome:
  let apiResult = maybeResp.get()
  # utilisez apiResult selon les besoins

getSubscriptions

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
userId	string = ""	Non

Réponse

Retourne : Option[GetSubscriptionsAPIResponse]

Exemple

Exemple getSubscriptions

Copy

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

updateSubscription

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Non
userId	string = ""	Non

Réponse

Retourne : Option[UpdateSubscriptionAPIResponse]

Exemple

Exemple de updateSubscription

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetTenantDailyUsagesOptions	Non

Réponse

Retourne : Option[GetTenantDailyUsagesResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantPackageBody	CreateTenantPackageBody	Non

Réponse

Retourne : Option[CreateTenantPackageResponse]

Exemple

createTenantPackage Exemple

Copy

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

deleteTenantPackage

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple deleteTenantPackage

Copy

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

getTenantPackage

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetTenantPackageResponse]

Exemple

Exemple getTenantPackage

Copy

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

getTenantPackages

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetTenantPackagesResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
replaceTenantPackageBody	ReplaceTenantPackageBody	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple replaceTenantPackage

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateTenantPackageBody	UpdateTenantPackageBody	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantUserBody	CreateTenantUserBody	Non

Réponse

Retourne : Option[CreateTenantUserResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
options	DeleteTenantUserOptions	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

deleteTenantUser Exemple

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetTenantUserResponse]

Exemple

Exemple getTenantUser

Copy

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

getTenantUsers

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Retourne : Option[GetTenantUsersResponse]

Exemple

Exemple getTenantUsers

Copy

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

replaceTenantUser

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
replaceTenantUserBody	ReplaceTenantUserBody	Non
updateComments	string = ""	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple replaceTenantUser

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
redirectURL	string = ""	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
updateTenantUserBody	UpdateTenantUserBody	No
updateComments	string = ""	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de updateTenantUser

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantBody	CreateTenantBody	Non

Réponse

Retourne : Option[CreateTenantResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
sure	string = ""	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple deleteTenant

Copy

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

getTenant

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[GetTenantResponse]

Exemple

Exemple getTenant

Copy

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

getTenants

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetTenantsOptions	Non

Réponse

Retourne : Option[GetTenantsResponse]

Exemple

Exemple getTenants

Copy

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

updateTenant

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
updateTenantBody	UpdateTenantBody	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de mise à jour du locataire

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
userId	string	No
id	string	No
changeTicketStateBody	ChangeTicketStateBody	No

Réponse

Retourne : Option[ChangeTicketStateResponse]

Exemple

changeTicketState Exemple

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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
userId	string	Non
createTicketBody	CreateTicketBody	Non

Réponse

Renvoie : Option[CreateTicketResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
userId	string = ""	No

Réponse

Renvoie : Option[GetTicketResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetTicketsOptions	Non

Réponse

Retourne : Option[GetTicketsResponse]

Exemple

Exemple getTickets

Copy

let (ticketsOpt, httpResp) = client.getTickets(tenantId = "my-tenant-123", options = GetTicketsOptions())
if ticketsOpt.isSome:
  let tickets = ticketsOpt.get()
  # utilisez les tickets au besoin

getTranslations

Paramètres

Nom	Type	Obligatoire
namespace	string	No
component	string	No
options	GetTranslationsOptions	No

Réponse

Renvoie : Option[GetTranslationsResponse]

Exemple

Exemple 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

Téléverser et redimensionner une image

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
file	string	Non
options	UploadImageOptions	Non

Réponse

Retourne : Option[UploadImageResponse]

Exemple

Exemple uploadImage

Copy

let (uploadResult, httpResponse) = client.uploadImage(
  tenantId = "my-tenant-123",
  file = "images/avatar.jpg",
  options = UploadImageOptions()
)
if uploadResult.isSome:
  let result = uploadResult.get()
  # utilisez le résultat selon les besoins

getUserBadgeProgressById

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIGetUserBadgeProgressResponse]

Exemple

Exemple getUserBadgeProgressById

Copy

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

getUserBadgeProgressByUserId

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

Réponse

Renvoie : Option[APIGetUserBadgeProgressResponse]

Exemple

Exemple getUserBadgeProgressByUserId

Copy

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

getUserBadgeProgressList

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
options	GetUserBadgeProgressListOptions	No

Réponse

Retourne : Option[APIGetUserBadgeProgressListResponse]

Exemple

getUserBadgeProgressList Exemple

Copy

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

createUserBadge

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createUserBadgeParams	CreateUserBadgeParams	Non

Réponse

Retourne : Option[APICreateUserBadgeResponse]

Exemple

Exemple de createUserBadge

Copy

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

deleteUserBadge

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[APIEmptySuccessResponse]

Exemple

Exemple deleteUserBadge

Copy

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

getUserBadge

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIGetUserBadgeResponse]

Exemple

Exemple getUserBadge

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserBadgesOptions	Non

Réponse

Renvoie : Option[APIGetUserBadgesResponse]

Exemple

Exemple getUserBadges

Copy

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

updateUserBadge

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateUserBadgeParams	UpdateUserBadgeParams	Non

Réponse

Retourne : Option[APIEmptySuccessResponse]

Exemple

Exemple de mise à jour du badge d'utilisateur

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
sso	string = ""	Non

Réponse

Retourne : Option[GetUserNotificationCountResponse]

Exemple

getUserNotificationCount Exemple

Copy

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

getUserNotifications

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserNotificationsOptions	Non

Réponse

Returns: Option[GetMyNotificationsResponse]

Exemple

Exemple getUserNotifications

Copy

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

resetUserNotificationCount

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
sso	string = ""	No

Réponse

Renvoie : Option[ResetUserNotificationsResponse]

Exemple

resetUserNotificationCount Exemple

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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	ResetUserNotificationsOptions	Non

Réponse

Renvoie : Option[ResetUserNotificationsResponse]

Exemple

resetUserNotifications Exemple

Copy

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

updateUserNotificationCommentSubscriptionStatus

Activer ou désactiver les notifications pour un commentaire spécifique.

Parameters

Nom	Type	Obligatoire
tenantId	string	Oui
notificationId	string	Non
optedInOrOut	string	Non
commentId	string	Oui
sso	string = ""	Non

Response

Retour: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Exemple

Exemple updateUserNotificationCommentSubscriptionStatus

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

Activer ou désactiver les notifications pour une page. Lorsqu’un utilisateur s’abonne à une page, des notifications sont créées
pour les nouveaux commentaires racine, et également

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
url	string	Non
pageTitle	string	Non
subscribedOrUnsubscribed	string	Non
sso	string = ""	Non

Réponse

Retourne : Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Exemple

Exemple de 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()
  # traitement supplémentaire avec resp

updateUserNotificationStatus

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
notificationId	string	Non
newStatus	string	Non
sso	string = ""	Non

Réponse

Renvoie : Option[UpdateUserNotificationStatusResponse]

Exemple

Exemple de 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
urlIdWS	string	No
userIds	string	No

Réponse

Retourne : Option[GetUserPresenceStatusesResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
options	SearchUsersOptions	Non

Réponse

Renvoie : Option[SearchUsersResult]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
id	string	No

Réponse

Retourne : Option[GetUserResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
direction	string	No
options	CreateVoteOptions	No

Réponse

Renvoie : Option[VoteResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
editKey	string = ""	No

Réponse

Renvoie: Option[VoteDeleteResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Retourne : Option[GetVotesResponse]

Exemple

Exemple 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

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
options	GetVotesForUserOptions	Non

Réponse

Retourne : Option[GetVotesForUserResponse]

Exemple

Exemple 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

Besoin d'aide ?

Si vous rencontrez des problèmes ou avez des questions concernant le SDK Nim, veuillez :

Contribution

Les contributions sont les bienvenues ! Veuillez consulter le dépôt GitHub pour les consignes de contribution.

Langue 🇨🇦 Français (Canada)

Documentation

Premiers pas

Référence de l'API

Utilisation

Agrégation

Journaux d'audit

Authentification

Bloquer depuis un commentaire

Vérifier les commentaires bloqués

Commentaires

Commentaires pour l'utilisateur

Configurations de domaine

Modèles de courriel

Journal d'événements

Publications

Signaler un commentaire

Gifs

Mots-clics

Modération

Modérateurs

Nombre de notifications

Notifications

Réactions de page

Pages

Événements webhook en attente

Configurations des questions

Résultats des questions

Agrégation des résultats de questions

Utilisateurs SSO

Abonnements

Utilisation quotidienne du locataire

Forfaits du locataire

Utilisateurs du locataire

Locataires

Tickets

Traductions

Téléverser une image

Progression des badges utilisateur

Badges utilisateur

Notifications utilisateur

Statut de présence de l'utilisateur

Recherche d'utilisateurs

Utilisateurs

Votes

SDK Nim de FastComments

Dépôt

Exigences

Installation

Utilisation de Nimble

Compilation à partir du code source

Contenu de la bibliothèque

APIs publiques vs sécurisées

Démarrage rapide

Utilisation des APIs authentifiées (DefaultAPI)

Utilisation des APIs publiques (PublicAPI)

Utilisation des APIs de modération (ModerationAPI)

Problèmes courants

Effectuer des appels API

Exemple : Récupération des commentaires

Remarques

Identifiants de diffusion

SSO (Authentification unique)

Utilisation du SSO

SSO simple

SSO sécurisé

Documentation pour fastcomments

Documentation des points d’accès API

Documentation des modèles

aggregate

Paramètres

Réponse

Exemple

getAuditLogs

Paramètres

Réponse

Exemple

logoutPublic

Réponse

Exemple

Exemple : Récupération des commentaires