FastComments SDK Nim

Ceci est le SDK Nim officiel pour FastComments.

SDK Nim officiel pour l'API FastComments

Dépôt

Agents de codage IA

Donnez à votre agent de codage le contexte FastComments dont il a besoin - widgets, configuration, SSO sécurisé, l'API REST et les SDK :

npx skills add fastcomments/skills

Fonctionne avec Claude Code, Codex, Cursor, Copilot, Gemini et tout autre agent pris en charge par le skills CLI.

Exigences

Nim >= 1.6.0
nimcrypto >= 0.5.4

Installation

Utiliser Nimble

nimble install fastcomments

Compilation depuis le code source

nimble build

Contenu de la bibliothèque

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

Docs de la bibliothèque cliente 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 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 fournit une suite étendue d’APIs 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 API authentifiées (DefaultAPI)

Important : Authenticated endpoints require your API key to be set as the x-api-key header.

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 optionnels sont passés via l'objet 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 API publiques (PublicAPI)

Public endpoints don't require authentication:

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 API de modération (ModerationAPI)

Moderation endpoints power the moderator dashboard and are authenticated with an SSO token for the acting moderator:

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

401 error d'authentification : 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 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 API de ce SDK renvoient des tuples de (Option[ResponseType], Response). Le premier élément contient la réponse analysée en cas de succès, et le deuxième élément est la réponse HTTP brute.

Les paramètres obligatoires et le corps de la requête sont passés positionnellement. Les paramètres optionnels restants sont rassemblés dans un seul objet Api<Operation>Options, qui est le dernier argument. Les opérations sans paramètres optionnels ne prennent 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"

Notes

Identifiants de diffusion

Vous verrez que vous devez passer un broadcastId dans certaines requêtes API. Lorsque vous recevrez des événements, vous récupérerez cet ID, ce qui vous permettra d'ignorer l'événement si vous comptez appliquer les changements de façon optimiste côté client (ce que vous voudrez probablement faire car cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas se produire deux fois dans une session de navigateur.

SSO (Authentification unique)

Pour des exemples de SSO, voir ci-dessous.

Utilisation 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 for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate	Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts	req tenantId afterId
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/mod_api/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/mod_api/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/mod_api/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/mod_api/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/mod_api/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/mod_api/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/mod_api/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/mod_api/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/mod_api/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/mod_api/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/mod_api/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}	req tenantId urlId
PublicApi	getEventLog	GET /event-log/{tenantId}	req tenantId urlId userIdWS
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}	req tenantId afterId
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}	req tenantId urlId userIdWS
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline	Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online	Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
PublicApi	getPagesPublic	GET /pages/{tenantId}	List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires `enableFChat` to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info	Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}	Enable or disable notifications for a specific comment.
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}	Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}	Upload and resize an image
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

agréger

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
aggregationRequest	AggregationRequest	No
options	AggregateOptions	No

Réponse

Returns: 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

obtenirJournauxAudit

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetAuditLogsOptions	No

Réponse

Retourne : 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

déconnexionPublique

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

logoutPublic Exemple

Copy

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

bloquerDepuisCommentPublic

Paramètres

Nom	Type	Obligatoire
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()

débloquerCommentPublic

Paramètres

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

Réponse

Retourne : Option[UnblockSuccess]

Exemple

Exemple de unBlockCommentPublic

Copy

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

commentairesVérifiésPourBloqués

Paramètres

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

Réponse

Renvoie : Option[CheckBlockedCommentsResponse]

Exemple

Exemple 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

bloquerUtilisateurDepuisComment

Paramètres

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

Réponse

Retourne : Option[BlockSuccess]

Exemple

Exemple blockUserFromComment

Copy

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

créerCommentPublic

Paramètres

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	No
commentData	CommentData	No
options	CreateCommentPublicOptions	No

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

supprimerCommentaire

Paramètres

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

Réponse

Retourne : Option[DeleteCommentResult]

Exemple

deleteComment Exemple

Copy

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

supprimerCommentairePublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
options	DeleteCommentPublicOptions	No

Réponse

Retourne : Option[PublicAPIDeleteCommentResponse]

Exemple

deleteCommentPublic Exemple

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

supprimerVoteCommentaire

Parameters

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

Response

Retourne : Option[VoteDeleteResponse]

Exemple

Exemple deleteCommentVote

Copy

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

signalerCommentaire

Paramètres

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

Réponse

Retourne : 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

obtenirCommentaire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : 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

obtenirCommentaires

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetCommentsOptions	No

Réponse

Returns: 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

obtenirCommentairesPublic

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

obtenirTexteCommentaire

Paramètres

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

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

obtenirNomsUtilisateursVoteCommentaire

Paramètres

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

Réponse

Renvoie : 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

verrouillerCommentaire

Paramètres

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

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

épinglerCommentaire

Paramètres

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

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

enregistrerCommentaire

Paramètres

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

Réponse

Retourne : Option[APISaveCommentResponse]

Exemple

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

enregistrerCommentairesEnLot

Paramètres

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

Réponse

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

définirTexteCommentaire

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	No
commentTextUpdateRequest	CommentTextUpdateRequest	No
options	SetCommentTextOptions	No

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

débloquerUtilisateurDepuisComment

Paramètres

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

Réponse

Renvoie : Option[UnblockSuccess]

Exemple

unBlockUserFromComment Exemple

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

décocherCommentaire

Paramètres

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

Réponse

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

déverrouillerCommentaire

Paramètres

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

Réponse

Retourne : 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"

désépinglerCommentaire

Paramètres

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

Réponse

Retourne : Option[ChangeCommentPinStatusResponse]

Exemple

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

mettreÀJourCommentaire

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
updatableCommentParams	UpdatableCommentParams	No
options	UpdateCommentOptions	No

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

voterCommentaire

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

voteComment Exemple

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

obtenirCommentairesPourUtilisateur

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

ajouterConfigurationDomaine

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
addDomainConfigParams	AddDomainConfigParams	Non

Réponse

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

supprimerConfigurationDomaine

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
domain	string	Non

Réponse

Retourne : 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

obtenirConfigurationDomaine

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
domain	string	No

Réponse

Retourne : 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

obtenirConfigurationsDomaine

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes

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

modifierConfigurationDomaine

Paramètres

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

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

mettreConfigurationDomaine

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
domainToUpdate	string	No
updateDomainConfigParams	UpdateDomainConfigParams	No

Réponse

Retourne : Option[PutDomainConfigResponse]

Exemple

Exemple putDomainConfig

Copy

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

créerModèleEmail

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	No

Réponse

Retourne : Option[CreateEmailTemplateResponse]

Exemple

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

supprimerModèleEmail

Parameters

Nom	Type	Obligatoire	Description
tenantId	string	Yes
id	string	No

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de deleteEmailTemplate

Copy

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

supprimerErreurRenduModèleEmail

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
errorId	string	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple deleteEmailTemplateRenderError

Copy

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

obtenirModèleEmail

Paramètres

Nom	Type	Obligatoire	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()

obtenirDéfinitionsModèleEmail

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

obtenirErreursRenduModèleEmail

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
skip	float64	No

Réponse

Retourne : Option[GetEmailTemplateRenderErrorsResponse]

Exemple

Exemple getEmailTemplateRenderErrors

Copy

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

obtenirModèlesEmail

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Retourne : 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

rendreModèleEmail

Paramètres

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

Réponse

Renvoie : 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

mettreÀJourModèleEmail

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateEmailTemplateBody	UpdateEmailTemplateBody	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de mise à jour du modèle d'email

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

obtenirJournalÉvénement

req tenantId urlId userIdWS

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	No
startTime	int64	No
endTime	int64	No

Réponse

Renvoie : Option[GetEventLogResponse]

Exemple

Exemple getEventLog

Copy

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

obtenirJournalÉvénementGlobal

requête 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

getGlobalEventLog Exemple

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

créerPublicationFlux

Paramètres

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	No
options	CreateFeedPostOptions	No

Réponse

Retourne : Option[CreateFeedPostsResponse]

Exemple

createFeedPost Exemple

Copy

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

créerPublicationFluxPublic

Paramètres

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

Réponse

Renvoie : Option[CreateFeedPostResponse]

Exemple

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

supprimerPublicationFluxPublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
postId	string	Non
options	DeleteFeedPostPublicOptions	Non

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

obtenirPublicationsFlux

req tenantId afterId

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetFeedPostsOptions	Non

Réponse

Renvoie : 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

obtenirPublicationsFluxPublic

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

obtenirStatistiquesPublicationsFlux

Paramètres

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

Réponse

Returns: 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

obtenirRéactionsUtilisateurPublic

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetUserReactsPublicOptions	No

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

réagirPublicationFluxPublic

Paramètres

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

Réponse

Retourne : Option[ReactFeedPostResponse]

Exemple

reactFeedPostPublic Exemple

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

mettreÀJourPublicationFlux

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
feedPost	FeedPost	No

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple de updateFeedPost

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

mettreÀJourPublicationFluxPublic

Paramètres

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

Réponse

Returns: Option[CreateFeedPostResponse]

Exemple

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

signalerCommentairePublic

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
commentId	string	Yes
isFlagged	bool	No
sso	string = ""	No

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple flagCommentPublic

Copy

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

obtenirGifGrand

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

rechercherGifs

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
search	string	Non
options	GetGifsSearchOptions	Non

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

obtenirGifsTendance

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

ajouterHashtag

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
createHashTagBody	CreateHashTagBody	No

Réponse

Retourne : Option[CreateHashTagResponse]

Exemple

Exemple addHashTag

Copy

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

ajouterHashtagsEnLot

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Réponse

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

supprimerHashtag

Paramètres

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

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple de deleteHashTag

Copy

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

obtenirHashtags

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
page	float64	Non

Réponse

Renvoie : Option[GetHashTagsResponse]

Exemple

getHashTags Exemple

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"

modifierHashtag

Paramètres

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

Réponse

Retourne : Option[UpdateHashTagResponse]

Exemple

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

supprimerVoteModération

Paramètres

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

Réponse

Retourne : Option[VoteDeleteResponse]

Exemple

deleteModerationVote Exemple

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

obtenirCommentairesAPI

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetApiCommentsOptions	Non

Réponse

Retourne : 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`

obtenirStatutExportAPI

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetApiExportStatusOptions	Non

Réponse

Retourne : Option[ModerationExportStatusResponse]

Exemple

Exemple getApiExportStatus

Copy

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

obtenirIdsAPI

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetApiIdsOptions	No

Réponse

Renvoie : 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

obtenirUtilisateursBannisDepuisComment

Paramètres

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

Réponse

Retourne : 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

obtenirStatutBanCommentaire

Paramètres

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

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

obtenirEnfantsCommentaire

Paramètres

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

Réponse

Retourne : 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

obtenirCompte

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetCountOptions	Non

Réponse

Retourne : Option[ModerationAPICountCommentsResponse]

Exemple

Exemple getCount

Copy

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

obtenirComptes

Paramètres

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

Réponse

Renvoie : 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"

obtenirJournaux

Paramètres

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

Réponse

Retourne : 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

obtenirBadgesManuels

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
sso	string = ""	No

Réponse

Retourne : 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

obtenirBadgesManuelsPourUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetManualBadgesForUserOptions	Non

Réponse

Renvoie : Option[GetUserManualBadgesResponse]

Exemple

Exemple getManualBadgesForUser

Copy

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

obtenirCommentaireModération

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

obtenirTexteCommentaireModération

Paramètres

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

Réponse

Renvoie : Option[GetCommentTextResponse]

Exemple

Exemple getModerationCommentText

Copy

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

obtenirRésuméPréBan

Paramètres

Nom	Type	Obligatoire
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()

obtenirRésuméRechercheCommentaires

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchCommentsSummaryOptions	Non

Réponse

Renvoie : Option[ModerationCommentSearchResponse]

Exemple

getSearchCommentsSummary Exemple

Copy

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

obtenirPagesRecherche

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchPagesOptions	Non

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

obtenirSitesRecherche

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchSitesOptions	Non

Réponse

Retourne : Option[ModerationSiteSearchResponse]

Exemple

Exemple getSearchSites

Copy

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

obtenirSuggestionRecherche

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchSuggestOptions	Non

Réponse

Retourne : 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

obtenirUtilisateursRecherche

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetSearchUsersOptions	Non

Réponse

Retourne : Option[ModerationUserSearchResponse]

Exemple

Exemple getSearchUsers

Copy

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

obtenirFacteurConfiance

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetTrustFactorOptions	Non

Réponse

Renvoie : 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

obtenirPréférenceBanUtilisateur

Paramètres

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

Réponse

Retourne : 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

obtenirProfilInterneUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserInternalProfileOptions	Non

Réponse

Retourne : Option[GetUserInternalProfileResponse]

Exemple

Exemple getUserInternalProfile

Copy

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

ajusterVotesCommentaire

Paramètres

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

Réponse

Retourne: Option[AdjustVotesResponse]

Exemple

postAdjustCommentVotes Exemple

Copy

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

exporterAPI

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

bannirUtilisateurDepuisComment

Paramètres

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

Réponse

Retourne : 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

annulerBanUtilisateur

Paramètres

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

Réponse

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

résuméPréBanEnLot

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
bulkPreBanParams	BulkPreBanParams	No
options	PostBulkPreBanSummaryOptions	No

Réponse

Renvoie : Option[BulkPreBanSummary]

Exemple

Exemple postBulkPreBanSummary

Copy

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

commentairesParIds

Paramètres

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

Réponse

Retourne : Option[ModerationAPIChildCommentsResponse]

Exemple

postCommentsByIds Exemple

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()
  # utilisez la réponse selon les besoins

signalerCommentaire

Paramètres

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

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

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

supprimerCommentaire

Paramètres

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

Réponse

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

restaurerCommentaireSupprimé

Paramètres

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

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"

définirStatutApprobationCommentaire

Paramètres

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

Réponse

Retourne : Option[SetCommentApprovedResponse]

Exemple

Exemple 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

définirStatutRévisionCommentaire

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

définirStatutSpamCommentaire

Paramètres

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

Réponse

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

définirTexteCommentaire

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

décocherCommentaire

Paramètres

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

Réponse

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

voter

Paramètres

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

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

attribuerBadge

Paramètres

Name	Type	Required
tenantId	string	Yes
badgeId	string	No
options	PutAwardBadgeOptions	No

Réponse

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

fermerFil

Paramètres

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

Réponse

Retourne : 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"

supprimerBadge

Paramètres

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

Réponse

Renvoie : Option[RemoveUserBadgeResponse]

Exemple

putRemoveBadge Exemple

Copy

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

rouvrirFil

Paramètres

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

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

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

définirFacteurConfiance

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	SetTrustFactorOptions	No

Réponse

Returns: Option[SetUserTrustFactorResponse]

Exemple

Exemple setTrustFactor

Copy

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

créerModérateur

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

supprimerModérateur

Paramètres

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

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

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

obtenirModérateur

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

obtenirModérateurs

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Retourne : 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

mettreÀJourModérateur

Paramètres

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

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

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

supprimerCompteNotifications

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple de deleteNotificationCount

Copy

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

obtenirCompteNotificationsCache

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[GetCachedNotificationCountResponse]

Exemple

getCachedNotificationCount Exemple

Copy

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

obtenirCompteNotifications

Paramètres

Nom	Type	Obligatoire	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

obtenirNotifications

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetNotificationsOptions	No

Réponse

Renvoie : Option[GetNotificationsResponse]

Exemple

Exemple de getNotifications

Copy

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

mettreÀJourNotification

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

créerRéactionPageV1

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
urlId	string	Yes
title	string = ""	No

Réponse

Retourne : 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

créerRéactionPageV2

Paramètres

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

Réponse

Renvoie : Option[CreateV1PageReact]

Exemple

createV2PageReact Exemple

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 les besoins

supprimerRéactionPageV1

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Retourne : Option[CreateV1PageReact]

Exemple

Exemple deleteV1PageReact

Copy

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

supprimerRéactionPageV2

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
id	string	Non

Réponse

Retourne : 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

obtenirLikesPageV1

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

obtenirRéactionsPageV2

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
urlId	string	Oui

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

obtenirUtilisateursRéactionPageV2

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
id	string	Non

Réponse

Retourne: 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

ajouterPage

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	No

Réponse

Returns: 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

supprimerPage

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : 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

obtenirUtilisateursHorsLigne

Past commenters on the page who are NOT currently online. Sorted by displayName.
Commentateurs précédents sur la page qui ne sont PAS actuellement en ligne. Triés par displayName.

Use this after exhausting /users/online to render a "Members" section.
Utilisez ceci après avoir épuisé /users/online pour afficher une section « Membres ».

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Pagination du curseur sur commenterName : le serveur parcourt le fragment {tenantId, urlId, commenterName} à partir de afterName vers l’avant via $gt, sans coût $skip.

Parameters

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

Response

Returns: Option[PageUsersOfflineResponse]

Example

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

obtenirUtilisateursEnLigne

Visiteurs actuellement en ligne d'une page : personnes dont la session websocket est abonnée à la page en ce moment.
Renvoie anonCount + totalCount (abonnés à l’ensemble de la salle, y compris les visiteurs 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

obtenirPageParIdURL

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

obtenirPages

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui

Réponse

Retourne : 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

obtenirPagesPublic

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parameters

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetPagesPublicOptions	Non

Response

Retourne : Option[GetPublicPagesResponse]

Example

getPagesPublic Exemple

Copy

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

obtenirInfoUtilisateur

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

Name	Type	Required	Description
tenantId	string	Yes
ids	string	No

Response

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

modifierPage

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateAPIPageData	UpdateAPIPageData	Non

Réponse

Renvoie : Option[PatchPageAPIResponse]

Exemple

patchPage Exemple

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

supprimerÉvénementWebhookEnAttente

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

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

obtenirCompteÉvénementsWebhookEnAttente

Parameters

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetPendingWebhookEventCountOptions	Non

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

obtenirÉvénementsWebhookEnAttente

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetPendingWebhookEventsOptions	No

Réponse

Retourne : Option[GetPendingWebhookEventsResponse]

Exemple

Exemple getPendingWebhookEvents

Copy

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

créerConfigurationQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createQuestionConfigBody	CreateQuestionConfigBody	Non

Réponse

Retourne : Option[CreateQuestionConfigResponse]

Exemple

createQuestionConfig Exemple

Copy

let configBody = CreateQuestionConfigBody()
let (maybeResp, httpResp) = client.createQuestionConfig(
  tenantId = "my-tenant-123",
  createQuestionConfigBody = configBody,
)
if maybeResp.isSome:
  let resp = maybeResp.get()
  # utilisez la réponse selon vos besoins

supprimerConfigurationQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

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

obtenirConfigurationQuestion

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

obtenirConfigurationsQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

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

mettreÀJourConfigurationQuestion

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
updateQuestionConfigBody	UpdateQuestionConfigBody	No

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple updateQuestionConfig

Copy

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

créerRésultatQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createQuestionResultBody	CreateQuestionResultBody	Non

Réponse

Renvoie : Option[CreateQuestionResultResponse]

Exemple

Exemple 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

supprimerRésultatQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

deleteQuestionResult Exemple

Copy

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

obtenirRésultatQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : 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

obtenirRésultatsQuestion

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

mettreÀJourRésultatQuestion

Paramètres

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

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

updateQuestionResult Exemple

Copy

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

agrégerRésultatsQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	AggregateQuestionResultsOptions	Non

Réponse

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

agrégerRésultatsQuestionEnLot

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	No
forceRecalculate	bool	No

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

combinerCommentairesAvecRésultatsQuestion

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	CombineCommentsWithQuestionResultsOptions	Non

Réponse

Retourne : Option[CombineQuestionResultsWithCommentsResponse]

Exemple

Exemple de combineCommentsWithQuestionResults

Copy

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

ajouterUtilisateurSSO

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createAPISSOUserData	CreateAPISSOUserData	Non

Réponse

Retourne : Option[AddSSOUserAPIResponse]

Exemple

addSSOUser Exemple

Copy

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

supprimerUtilisateurSSO

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

obtenirUtilisateurSSOParEmail

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
email	string	Non

Réponse

Retourne : 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

obtenirUtilisateurSSOParId

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

obtenirUtilisateursSSO

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

modifierUtilisateurSSO

Paramètres

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

Réponse

Retourne : 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

mettreUtilisateurSSO

Paramètres

Name	Type	Required
tenantId	string	Yes
id	string	No
updateAPISSOUserData	UpdateAPISSOUserData	No
updateComments	bool	No

Réponse

Retourne : Option[PutSSOUserAPIResponse]

Exemple

putSSOUser Exemple

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

créerAbonnement

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

supprimerAbonnement

Paramètres

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

Réponse

Renvoie : Option[DeleteSubscriptionAPIResponse]

Exemple

deleteSubscription Exemple

Copy

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

obtenirAbonnements

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

mettreÀJourAbonnement

Paramètres

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

Réponse

Retourne : Option[UpdateSubscriptionAPIResponse]

Exemple

updateSubscription Exemple

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

obtenirUtilisationsQuotidiennesLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetTenantDailyUsagesOptions	Non

Réponse

Returns: Option[GetTenantDailyUsagesResponse]

Exemple

getTenantDailyUsages Exemple

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

créerPackageLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	No

Réponse

Renvoie : Option[CreateTenantPackageResponse]

Exemple

Exemple de createTenantPackage

Copy

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

supprimerPackageLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

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

obtenirPackageLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[GetTenantPackageResponse]

Exemple

getTenantPackage Exemple

Copy

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

obtenirPackagesLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Retourne : 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

remplacerPackageLocataire

Paramètres

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

Réponse

Retourne : 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

mettreÀJourPackageLocataire

Paramètres

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

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

updateTenantPackage Exemple

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

créerUtilisateurLocataire

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

supprimerUtilisateurLocataire

Paramètres

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

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple deleteTenantUser

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"

obtenirUtilisateurLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
id	string	No

Réponse

Retourne : 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

obtenirUtilisateursLocataire

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

remplacerUtilisateurLocataire

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
id	string	No
replaceTenantUserBody	ReplaceTenantUserBody	No
updateComments	string = ""	No

Réponse

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

envoyerLienConnexion

Paramètres

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

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

mettreÀJourUtilisateurLocataire

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateTenantUserBody	UpdateTenantUserBody	Non
updateComments	string = ""	Non

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

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

créerLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantBody	CreateTenantBody	Non

Réponse

Retourne : Option[CreateTenantResponse]

Exemple

createTenant Exemple

Copy

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

supprimerLocataire

Paramètres

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

Réponse

Renvoie : Option[APIEmptyResponse]

Exemple

Exemple de deleteTenant

Copy

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

obtenirLocataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : 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

obtenirLocataires

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
options	GetTenantsOptions	No

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

mettreÀJourLocataire

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
id	string	Non
updateTenantBody	UpdateTenantBody	Non

Réponse

Retourne : Option[APIEmptyResponse]

Exemple

Exemple updateTenant

Copy

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

changerÉtatTicket

Paramètres

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

Réponse

Renvoie : Option[ChangeTicketStateResponse]

Exemple

Exemple changeTicketState

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

créerTicket

Paramètres

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

Réponse

Renvoie : Option[CreateTicketResponse]

Exemple

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

obtenirTicket

Paramètres

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

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

obtenirTickets

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetTicketsOptions	Non

Réponse

Renvoie : 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 selon vos besoins

obtenirTraductions

Paramètres

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

Réponse

Retourne : 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

téléverserImage

Upload and resize an image

Parameters

Nom	Type	Obligatoire
tenantId	string	Yes
file	string	No
options	UploadImageOptions	No

Response

Retourne: Option[UploadImageResponse]

Example

uploadImage Exemple

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

obtenirProgressionBadgeUtilisateurParId

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Yes
id	string	No

Réponse

Renvoie : 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

obtenirProgressionBadgeUtilisateurParIdUtilisateur

Paramètres

Nom	Type	Obligatoire	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

obtenirListeProgressionBadgeUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserBadgeProgressListOptions	Non

Réponse

Retourne : Option[APIGetUserBadgeProgressListResponse]

Exemple

Exemple getUserBadgeProgressList

Copy

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

créerBadgeUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createUserBadgeParams	CreateUserBadgeParams	Non

Réponse

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

supprimerBadgeUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

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

obtenirBadgeUtilisateur

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

obtenirBadgesUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserBadgesOptions	Non

Réponse

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

mettreÀJourBadgeUtilisateur

Paramètres

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

Réponse

Retourne : Option[APIEmptySuccessResponse]

Exemple

Exemple updateUserBadge

Copy

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

obtenirCompteNotificationsUtilisateur

Paramètres

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

Réponse

Returns: Option[GetUserNotificationCountResponse]

Exemple

Exemple getUserNotificationCount

Copy

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

obtenirNotificationsUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	GetUserNotificationsOptions	Non

Réponse

Retourne : Option[GetMyNotificationsResponse]

Exemple

getUserNotifications Exemple

Copy

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

réinitialiserCompteNotificationsUtilisateur

Paramètres

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

Réponse

Retourne : Option[ResetUserNotificationsResponse]

Exemple

Exemple de resetUserNotificationCount

Copy

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

réinitialiserNotificationsUtilisateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
options	ResetUserNotificationsOptions	Non

Réponse

Retourne : Option[ResetUserNotificationsResponse]

Exemple

Exemple de resetUserNotifications

Copy

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

mettreÀJourStatutAbonnementCommentaireNotificationUtilisateur

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

Paramètres

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

Réponse

Renvoie : Option[UpdateUserNotificationCommentSubscriptionStatusResponse]

Exemple

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

mettreÀJourStatutAbonnementPageNotificationUtilisateur

Enable 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 également

Parameters

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

Response

Renvoie : Option[UpdateUserNotificationPageSubscriptionStatusResponse]

Example

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

mettreÀJourStatutNotificationUtilisateur

Paramètres

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

Réponse

Renvoie : Option[UpdateUserNotificationStatusResponse]

Exemple

updateUserNotificationStatus Exemple

Copy

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

obtenirStatutsPrésenceUtilisateur

Paramètres

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

Réponse

Retourne : Option[GetUserPresenceStatusesResponse]

Exemple

getUserPresenceStatuses Exemple

Copy

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

rechercherUtilisateurs

Paramètres

Nom	Type	Obligatoire
tenantId	string	Yes
urlId	string	Yes
options	SearchUsersOptions	No

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

obtenirUtilisateur

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

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"

créerVote

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
direction	string	Non
options	CreateVoteOptions	Non

Réponse

Retourne : Option[VoteResponse]

Exemple

createVote Exemple

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

supprimerVote

Paramètres

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

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

obtenirVotes

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

obtenirVotesPourUtilisateur

Paramètres

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

Réponse

Renvoie : Option[GetVotesForUserResponse]

Exemple

Exemple de 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 Nim SDK, veuillez :

Contribuer

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

Langue 🇫🇷 Français (France)

Documentation

Commencer

Référence API

Utilisation

Agrégation

Journaux d'audit

Authentification

Blocage depuis le commentaire

Vérifier les commentaires bloqués

Commentaires

Commentaires pour l'utilisateur

Configurations de domaine

Modèles d'email

Journal d'événement

Publications du flux

Signaler le commentaire

GIFs

Hashtags

Modération

Modérateurs

Nombre de notifications

Notifications

Réactions de page

Pages

Événements webhook en attente

Configurations de question

Résultats de question

Agrégation des résultats de question

Utilisateurs SSO

Abonnements

Utilisation quotidienne du locataire

Packages de locataire

Utilisateurs du locataire

Locataires

Tickets

Traductions

Téléverser une image

Progression des badges utilisateur

Badges utilisateur

Notifications utilisateur

Statut de présence utilisateur

Recherche d'utilisateurs

Utilisateurs

Votes

FastComments SDK Nim

Dépôt

Agents de codage IA

Exigences

Installation

Utiliser Nimble

Compilation depuis le code source

Contenu de la bibliothèque

APIs publiques vs sécurisées

Démarrage rapide

Utilisation des API authentifiées (DefaultAPI)

Utilisation des API publiques (PublicAPI)

Utilisation des API de modération (ModerationAPI)

Problèmes courants

Effectuer des appels API

Exemple : Récupération des commentaires

Notes

Identifiants de diffusion

SSO (Authentification unique)

Utilisation SSO

SSO simple

SSO sécurisé

Documentation pour FastComments

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

api_key

agréger

Paramètres

Réponse

Exemple

obtenirJournauxAudit

Paramètres

Réponse

Exemple

Exemple : Récupération des commentaires