FastComments Nim SDK

Exemple

Exemple de deleteEmailTemplate

Copy

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

Supprimer une erreur de rendu de modèle d'e-mail

Paramètres

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

Réponse

Exemple

Exemple de deleteEmailTemplateRenderError

Copy

let (response, httpResponse) = client.deleteEmailTemplateRenderError(
  tenantId = "my-tenant-123",
  id = "welcome-email-template",
  errorId = "render-error-2026"
)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

Récupérer un modèle d'e-mail

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetEmailTemplate_200_response]

Exemple

Exemple de getEmailTemplate

Copy

let (response, httpResponse) = client.getEmailTemplate(tenantId = "my-tenant-123", id = "welcome-email-01")
if response.isSome:
  let template = response.get()
  echo "Template ID: ", template.id
  echo "Subject: ", template.subject
  echo "Body: ", template.body

Récupérer les définitions de modèles d'e-mail

Paramètres

Name	Type	Requis	Description
tenantId	string	Oui

Réponse

Renvoie: Option[GetEmailTemplateDefinitions_200_response]

Exemple

Exemple de getEmailTemplateDefinitions

Copy

let (response, httpResponse) = client.getEmailTemplateDefinitions(tenantId = "my-tenant-123")
if response.isSome:
  let defs = response.get()
  echo "Received email template definitions for tenant my-tenant-123"
else:
  echo "No template definitions returned; HTTP status: ", httpResponse.status

Récupérer les erreurs de rendu des modèles d'e-mail

Paramètres

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

Réponse

Retourne : Option[GetEmailTemplateRenderErrors_200_response]

Exemple

Exemple de getEmailTemplateRenderErrors

Copy

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

Récupérer les modèles d'e-mail

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie : Option[GetEmailTemplates_200_response]

Exemple

Exemple de getEmailTemplates

Copy

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

Rendre un modèle d'e-mail

Paramètres

Nom	Type	Requis
tenantId	string	Oui
renderEmailTemplateBody	RenderEmailTemplateBody	Non
locale	string	Non

Réponse

Renvoie: Option[RenderEmailTemplate_200_response]

Exemple

Exemple de renderEmailTemplate

Copy

let renderBody = RenderEmailTemplateBody(templateId: "comment-notification", subject: "New comment on your article", variables: @["John Doe", "news/global-climate"])
let (response, httpResponse) = client.renderEmailTemplate(tenantId = "my-tenant-123", renderEmailTemplateBody = renderBody, locale = "en-US")
if response.isSome:
  let rendered = response.get()
  echo rendered

Mettre à jour un modèle d'e-mail

Paramètres

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

Réponse

Exemple

Exemple de updateEmailTemplate

Copy

let updateBody = UpdateEmailTemplateBody(
  name = "Welcome Email",
  subject = "Welcome to Example News",
  html = "<p>Hi {name}, welcome to Example News.</p>",
  isActive = true,
  tags = @["onboarding", "welcome"]
)
let (response, httpResponse) = client.updateEmailTemplate(
  tenantId = "my-tenant-123",
  id = "welcome-template-2026",
  updateEmailTemplateBody = updateBody
)
if response.isSome:
  let template = response.get()
  discard template

Récupérer le journal d'événements

Paramètres

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

Réponse

Retourne: Option[GetEventLog_200_response]

Exemple

Exemple de getEventLog

Copy

let (response, httpResponse) = client.getEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userIdWS = "",
  startTime = 0'i64,
  endTime = 0'i64
)
if response.isSome:
  let eventLog = response.get()
  echo "Received event log for ", "my-tenant-123"
else:
  echo "No event log returned. HTTP status: ", $httpResponse.status

Récupérer le journal d'événements global

Paramètres

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

Réponse

Renvoie: Option[GetEventLog_200_response]

Exemple

Exemple de getGlobalEventLog

Copy

let (response, httpResponse) = client.getGlobalEventLog(
  tenantId = "my-tenant-123",
  urlId = "news/article-title",
  userIdWS = "",
  startTime = int64(0),
  endTime = int64(0)
)
if response.isSome:
  let eventLog = response.get()
  echo eventLog
else:
  echo "No event log returned"

Créer une publication

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
createFeedPostParams	CreateFeedPostParams	Non
broadcastId	string	Non
isLive	bool	Non
doSpamCheck	bool	Non
skipDupCheck	bool	Non

Réponse

Renvoie : Option[CreateFeedPost_200_response]

Exemple

Exemple de createFeedPost

Copy

let createParams = CreateFeedPostParams(
  content = "We're rolling out realtime comments to all users!",
  title = "Realtime Comments Rollout",
  url = "news/realtime-comments-rollout-2025",
  authorId = "prod-team",
  tags = @["release", "comments"]
)
let (response, httpResponse) = client.createFeedPost(
  tenantId = "my-tenant-123",
  createFeedPostParams = createParams,
  broadcastId = "broadcast-2025-11",
  isLive = true,
  doSpamCheck = true,
  skipDupCheck = false
)
if response.isSome:
  let created = response.get()
  echo "Feed post created, id: ", $created.id
else:
  echo "Failed to create feed post, HTTP status: ", $httpResponse.statusCode

Créer une publication publique

Paramètres

Nom	Type	Requis
tenantId	string	Oui
createFeedPostParams	CreateFeedPostParams	Non
broadcastId	string	Non
sso	string	Non

Réponse

Retourne : Option[CreateFeedPostPublic_200_response]

Exemple

Exemple de createFeedPostPublic

Copy

let (response, httpResponse) = client.createFeedPostPublic(
  tenantId = "my-tenant-123",
  createFeedPostParams = CreateFeedPostParams(
    title = "Product Launch Announcement",
    content = "We just launched a new commenting feature to improve engagement.",
    authorId = "team-product",
    url = "news/product-launch",
    tags = @["launch", "comments"],
    isFeatured = false
  ),
  broadcastId = "broadcast-009",
  sso = ""
)
if response.isSome:
  let created = response.get()
  discard created

Supprimer une publication publique

Paramètres

Name	Type	Required
tenantId	string	Oui
postId	string	Non
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie : Option[DeleteFeedPostPublic_200_response]

Exemple

Exemple de deleteFeedPostPublic

Copy

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

Récupérer les publications

Paramètres

Nom	Type	Requis
tenantId	string	Oui
afterId	string	Non
limit	int	Non
tags	seq[string]	Non

Réponse

Retourne : Option[GetFeedPosts_200_response]

Exemple

Exemple de getFeedPosts

Copy

let (response, httpResponse) = client.getFeedPosts(tenantId = "my-tenant-123", afterId = "post_abc123", limit = 20, tags = @["news", "sports"])
if response.isSome:
  let feed = response.get()
  echo "Feed posts retrieved for tenant my-tenant-123"
else:
  echo "No feed posts returned, HTTP status: ", $httpResponse.status

Récupérer les publications publiques

Paramètres

Name	Type	Obligatoire
tenantId	string	Oui
afterId	string	Non
limit	int	Non
tags	seq[string]	Non
sso	string	Non
isCrawler	bool	Non
includeUserInfo	bool	Non

Réponse

Renvoie: Option[GetFeedPostsPublic_200_response]

Exemple

Exemple de getFeedPostsPublic

Copy

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

Récupérer les statistiques des publications

Paramètres

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

Réponse

Renvoie : Option[GetFeedPostsStats_200_response]

Exemple

Exemple de getFeedPostsStats

Copy

let (response, httpResponse) = client.getFeedPostsStats(
  tenantId = "my-tenant-123",
  postIds = @["news/article-2025-11-22", "opinion/market-trends-452"],
  sso = ""
)
if response.isSome:
  let stats = response.get()
  discard stats

Récupérer les réactions d'un utilisateur (public)

Paramètres

Name	Type	Required
tenantId	string	Oui
postIds	seq[string]	Non
sso	string	Non

Réponse

Renvoie: Option[GetUserReactsPublic_200_response]

Exemple

Exemple de getUserReactsPublic

Copy

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

Réagir à une publication (public)

Paramètres

Nom	Type	Requis
tenantId	string	Oui
postId	string	Non
reactBodyParams	ReactBodyParams	Non
isUndo	bool	Non
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie: Option[ReactFeedPostPublic_200_response]

Exemple

Exemple de reactFeedPostPublic

Copy

let (response, httpResponse) = client.reactFeedPostPublic(
  tenantId = "my-tenant-123",
  postId = "news/article-title",
  reactBodyParams = ReactBodyParams(),
  isUndo = false,
  broadcastId = "broadcast-456",
  sso = ""
)
if response.isSome:
  let result = response.get()
  echo "Reaction result: ", result
else:
  echo "Reaction failed, HTTP response: ", httpResponse

Mettre à jour une publication

Paramètres

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

Réponse

Exemple

Exemple de updateFeedPost

Copy

let feedPost = FeedPost(
  title: "Local Election Results",
  content: "Updated vote counts across precincts",
  tags: @["politics", "local"],
  authorId: "journalist-32",
  isPublished: true,
  views: 124
)
let (response, httpResponse) = client.updateFeedPost(tenantId = "my-tenant-123", id = "post-456", feedPost = feedPost)
if response.isSome:
  let flagResp = response.get()
  discard flagResp

Mettre à jour une publication publique

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
postId	string	Non
updateFeedPostParams	UpdateFeedPostParams	Non
broadcastId	string	Non
sso	string	Non

Réponse

Renvoie : Option[CreateFeedPostPublic_200_response]

Exemple

Exemple de updateFeedPostPublic

Copy

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

Signaler un commentaire (public)

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
isFlagged	bool	Non
sso	string	Non

Réponse

Exemple

Exemple de flagCommentPublic

Copy

let (response, httpResponse) = client.flagCommentPublic(
  tenantId = "my-tenant-123",
  commentId = "comment-98765",
  isFlagged = false,
  sso = ""
)
if response.isSome:
  let flagResult = response.get()
  discard flagResult

Ajouter un hashtag

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
createHashTagBody	CreateHashTagBody	Non

Réponse

Renvoie : Option[AddHashTag_200_response]

Exemple

Exemple addHashTag

Copy

let createBody = CreateHashTagBody(
  name = "sports",
  description = "Articles and discussions about sports",
  aliases = @["sport", "athletics"],
  isActive = true
)
let (response, httpResponse) = client.addHashTag(tenantId = "my-tenant-123", createHashTagBody = createBody)
if response.isSome:
  let added = response.get()
  echo "HashTag added successfully"
else:
  echo "Failed to add HashTag"

Ajouter des hashtags en masse

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Non

Réponse

Retourne : Option[AddHashTagsBulk_200_response]

Exemple

Exemple addHashTagsBulk

Copy

let bulkBody = BulkCreateHashTagsBody(
  tags = @["breaking", "world-news", "economy"],
  createdBy = "editor@dailynews.com",
  replaceExisting = false
)
let (response, httpResponse) = client.addHashTagsBulk(tenantId = "newsroom-tenant-42", bulkCreateHashTagsBody = bulkBody)
if response.isSome:
  let created = response.get()
  echo created
else:
  echo "AddHashTagsBulk failed:", httpResponse

Supprimer un hashtag

Paramètres

Nom	Type	Obligatoire
tag	string	Non
tenantId	string	Oui
deleteHashTagRequest	DeleteHashTagRequest	Non

Réponse

Exemple

Exemple de deleteHashTag

Copy

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

Récupérer les hashtags

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
page	float64	Non

Réponse

Renvoie: Option[GetHashTags_200_response]

Exemple

Exemple de getHashTags

Copy

let (response, httpResponse) = client.getHashTags(tenantId = "my-tenant-123", page = 1.0)
if response.isSome:
  let tags = response.get()
  for t in tags:
    echo t
else:
  echo "no hashtags found"

Modifier partiellement un hashtag

Paramètres

Nom	Type	Requis
tag	string	Non
tenantId	string	Oui
updateHashTagBody	UpdateHashTagBody	Non

Réponse

Renvoie: Option[PatchHashTag_200_response]

Exemple

Exemple de patchHashTag

Copy

let (response, httpResponse) = client.patchHashTag(tag = "politics", tenantId = "my-tenant-123", updateHashTagBody = UpdateHashTagBody())
if response.isSome:
  let updated = response.get()
  echo "Hashtag updated successfully"
else:
  echo "Failed to update hashtag, status:", httpResponse.status

Créer un modérateur

Paramètres

Name	Type	Requis	Description
tenantId	string	Oui
createModeratorBody	CreateModeratorBody	Non

Réponse

Renvoie: Option[CreateModerator_200_response]

Exemple

Exemple createModerator

Copy

let createBody = CreateModeratorBody(
  email = "moderator@news-site.com",
  displayName = "News Moderator",
  permissions = @["approve_comments", "delete_comments"],
  isSuperAdmin = false
)
let (response, httpResponse) = client.createModerator(tenantId = "my-tenant-123", createModeratorBody = createBody)
if response.isSome:
  let moderator = response.get()
  echo "Created moderator: ", $moderator

Supprimer un modérateur

Paramètres

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

Réponse

Exemple

Exemple de deleteModerator

Copy

let (response, httpResponse) = client.deleteModerator(tenantId = "my-tenant-123", id = "moderator-456", sendEmail = "false")
if response.isSome:
  let flagResp = response.get()
  echo "Moderator deletion response: ", $flagResp
else:
  echo "No response body; HTTP status: ", $httpResponse.status

Récupérer un modérateur

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetModerator_200_response]

Exemple

Exemple de getModerator

Copy

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

Récupérer les modérateurs

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie: Option[GetModerators_200_response]

Exemple

Exemple de getModerators

Copy

let (response, httpResponse) = client.getModerators(tenantId = "my-tenant-123", skip = 0.0)
if response.isSome:
  let moderators = response.get()
  echo "Moderators fetched successfully"
  echo moderators

Mettre à jour un modérateur

Paramètres

Nom	Type	Requis
tenantId	string	Yes
id	string	No
updateModeratorBody	UpdateModeratorBody	No

Réponse

Exemple

Exemple de updateModerator

Copy

let updateBody = UpdateModeratorBody(
  name: "Alicia Gomez",
  email: "alicia.gomez@dailynews.com",
  active: true,
  roles: @["moderator"]
)
let (response, httpResponse) = client.updateModerator(tenantId = "my-tenant-123", id = "moderator-789", updateModeratorBody = updateBody)
if response.isSome:
  let updated = response.get()
  echo "Moderator updated:", updated

Supprimer le compte de notifications

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne : Option[FlagCommentPublic_200_response]

Exemple

Exemple de deleteNotificationCount

Copy

let (response, httpResponse) = client.deleteNotificationCount(tenantId = "my-tenant-123", id = "notif-456")
if response.isSome:
  let deleted = response.get()
  echo "Deleted notification count:", deleted
else:
  echo "No response body; HTTP response:", httpResponse

Récupérer le nombre de notifications mis en cache

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne: Option[GetCachedNotificationCount_200_response]

Exemple

Exemple de getCachedNotificationCount

Copy

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

Récupérer le nombre de notifications

Paramètres

Name	Type	Required
tenantId	string	Oui
userId	string	Non
urlId	string	Oui
fromCommentId	string	Non
viewed	bool	Non

Réponse

Renvoie: Option[GetNotificationCount_200_response]

Exemple

Exemple de getNotificationCount

Copy

let (response, httpResponse) = client.getNotificationCount(
  tenantId = "acme-corp-tenant-12",
  userId = "user-84",
  urlId = "news/2026/market-update",
  fromCommentId = "cmt-20251234",
  viewed = false
)
if response.isSome:
  let notificationData = response.get()
  echo "Received notification data"
else:
  echo "No notification data"

Récupérer les notifications

Paramètres

Nom	Type	Requis
tenantId	string	Oui
userId	string	Non
urlId	string	Oui
fromCommentId	string	Non
viewed	bool	Non
skip	float64	Non

Réponse

Renvoie: Option[GetNotifications_200_response]

Exemple

Exemple de getNotifications

Copy

let (response, httpResponse) = client.getNotifications(
  tenantId = "fastcomments-tenant-42",
  userId = "",
  urlId = "news/latest-tech-innovations",
  fromCommentId = "",
  viewed = false,
  skip = 0.0
)
if response.isSome:
  let notifications = response.get()
  echo "Received notifications: ", notifications
else:
  echo "No notifications, response: ", httpResponse

Mettre à jour une notification

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateNotificationBody	UpdateNotificationBody	Non
userId	string	Non

Réponse

Exemple

Exemple de updateNotification

Copy

let (response, httpResponse) = client.updateNotification(tenantId = "my-tenant-123",
  id = "notif-456",
  updateNotificationBody = UpdateNotificationBody(),
  userId = "user-789")
if response.isSome:
  let updated = response.get()
  echo "Updated notification id: ", $updated

Ajouter une page

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
createAPIPageData	CreateAPIPageData	Non

Réponse

Renvoie : Option[AddPageAPIResponse]

Exemple

Exemple pour addPage

Copy

var createData: CreateAPIPageData
createData.url = "news/nim-4-release"
createData.title = "Nim 4 Release Coverage"
createData.path = "/news/nim-4-release"
createData.isEnabled = true
createData.tags = @["nim", "release"]
createData.description = "Coverage of Nim 4 release"
let (response, httpResponse) = client.addPage(tenantId = "my-tenant-123", createAPIPageData = createData)
if response.isSome:
  let pageResp = response.get()
  echo pageResp

Supprimer une page

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie : Option[DeletePageAPIResponse]

Exemple

Exemple d'utilisation de deletePage'; type = 'nim

Copy

let (response, httpResponse) = client.deletePage(tenantId = "site-tenant-456", id = "news/winter-updates-2025")
if response.isSome:
  let deleted = response.get()
  echo "DeletePageAPIResponse:", deleted
else:
  echo "Delete failed, HTTP response:", httpResponse

Récupérer une page par URL/ID

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
urlId	string	Oui

Réponse

Renvoie : Option[GetPageByURLIdAPIResponse]

Exemple

Exemple de getPageByURLId

Copy

let (response, httpResponse) = client.getPageByURLId(tenantId = "my-tenant-123", urlId = "news/article-title")
if response.isSome:
  let page = response.get()
  echo "Page ID: ", page.id
  echo "Title: ", page.title
  echo "URL: ", page.url
  echo "Published: ", $page.published
  echo "Tags: ", $page.tags
else:
  echo "No page found. HTTP status: ", httpResponse.statusCode

Récupérer les pages

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui

Réponse

Retourne: Option[GetPagesAPIResponse]

Exemple

Exemple de getPages

Copy

let (response, httpResponse) = client.getPages(tenantId = "news-site-456")
if response.isSome:
  let pages = response.get()
  echo "Received pages response: ", pages
else:
  echo "No pages returned. HTTP response: ", httpResponse

Modifier partiellement une page

Paramètres

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

Réponse

Retourne : Option[PatchPageAPIResponse]

Exemple

Exemple de patchPage

Copy

let updateData = UpdateAPIPageData(
  title = "Breaking: Major Event Update",
  urlId = "news/major-event-update",
  visible = true,
  tags = @["breaking", "headline"],
  sortOrder = 5
)
let (response, httpResponse) = client.patchPage(
  tenantId = "my-tenant-123",
  id = "news/major-event-update",
  updateAPIPageData = updateData
)
if response.isSome:
  let page = response.get()
  discard page

Supprimer un événement webhook en attente

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de deletePendingWebhookEvent

Copy

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

Récupérer le nombre d'événements webhook en attente

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
externalId	string	Non
eventType	string	Non
domain	string	Non
attemptCountGT	float64	Non

Réponse

Renvoie : Option[GetPendingWebhookEventCount_200_response]

Exemple

Exemple de getPendingWebhookEventCount

Copy

let (response, httpResponse) = client.getPendingWebhookEventCount(
  tenantId = "my-tenant-123",
  commentId = "cmt-4567",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0
)
if response.isSome:
  let pending = response.get()
  echo "Received pending webhook event count response: ", $pending
else:
  echo "No pending webhook event count returned, HTTP response: ", $httpResponse

Récupérer les événements webhook en attente

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
commentId	string	Oui
externalId	string	Non
eventType	string	Non
domain	string	Non
attemptCountGT	float64	Non
skip	float64	Non

Réponse

Renvoie: Option[GetPendingWebhookEvents_200_response]

Exemple

Exemple de getPendingWebhookEvents

Copy

let (response, httpResponse) = client.getPendingWebhookEvents(
  tenantId = "my-tenant-123",
  commentId = "cmt-456789",
  externalId = "",
  eventType = "",
  domain = "",
  attemptCountGT = 0.0,
  skip = 0.0
)
if response.isSome:
  let pending = response.get()
  discard pending
  echo "Received pending webhook events"
else:
  echo "No pending webhook events"

Créer une configuration de question

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createQuestionConfigBody	CreateQuestionConfigBody	Non

Réponse

Retourne : Option[CreateQuestionConfig_200_response]

Exemple

Exemple de createQuestionConfig

Copy

let body = CreateQuestionConfigBody(
  key = "recommendation",
  question = "Would you recommend this article to a friend?",
  required = false,
  inputType = "radio",
  options = @["Yes", "No", "Maybe"]
)
let (response, httpResponse) = client.createQuestionConfig(tenantId = "my-tenant-123", createQuestionConfigBody = body)
if response.isSome:
  let config = response.get()
  discard config

Supprimer une configuration de question

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de deleteQuestionConfig

Copy

let (response, httpResponse) = client.deleteQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-456")
if response.isSome:
  let respVal = response.get()
  echo "Delete succeeded for tenant my-tenant-123"
else:
  echo "Delete returned no data (status: ", $httpResponse.status, ")"

Récupérer une configuration de question

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetQuestionConfig_200_response]

Exemple

Exemple de getQuestionConfig

Copy

let (response, httpResponse) = client.getQuestionConfig(tenantId = "my-tenant-123", id = "qcfg-98765")
if response.isSome:
  let config = response.get()
  echo "Received question config for tenant:", " my-tenant-123"

Récupérer les configurations de question

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie: Option[GetQuestionConfigs_200_response]

Exemple

Exemple de getQuestionConfigs

Copy

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

Mettre à jour une configuration de question

Paramètres

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

Réponse

Exemple

Exemple de updateQuestionConfig

Copy

let (response, httpResponse) = client.updateQuestionConfig(
  tenantId = "my-tenant-123",
  id = "q-config-456",
  updateQuestionConfigBody = UpdateQuestionConfigBody()
)
if response.isSome:
  let updated = response.get()
  discard updated
  echo "Question config updated"
else:
  echo "Update did not return a result"

Créer un résultat de question

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
createQuestionResultBody	CreateQuestionResultBody	Non

Réponse

Renvoie: Option[CreateQuestionResult_200_response]

Exemple

Exemple de createQuestionResult

Copy

let (response, httpResponse) = client.createQuestionResult(tenantId = "my-tenant-123",
  createQuestionResultBody = CreateQuestionResultBody(questionId: "q-456",
    userId: "user-789",
    correct: true,
    score: 9,
    answers: @["B", "D"]))
if response.isSome:
  let result = response.get()
  echo result

Supprimer un résultat de question

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de deleteQuestionResult

Copy

let (response, httpResponse) = client.deleteQuestionResult(tenantId = "my-tenant-123", id = "question-result-789")
if response.isSome:
  let result = response.get()
  echo "Deleted question result:", result
else:
  echo "No result returned, HTTP status:", $httpResponse.status

Récupérer un résultat de question

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
id	string	Non

Réponse

Retourne: Option[GetQuestionResult_200_response]

Exemple

Exemple de getQuestionResult

Copy

let (response, httpResponse) = client.getQuestionResult(tenantId = "my-tenant-123", id = "question-456")
if response.isSome:
  let result = response.get()
  echo "Received question result:"
  echo result
else:
  echo "No question result returned"

Récupérer les résultats de question

Paramètres

Name	Type	Obligatoire
tenantId	string	Oui
urlId	string	Oui
userId	string	Non
startDate	string	Non
questionId	string	Non
questionIds	string	Non
skip	float64	Non

Réponse

Retourne: Option[GetQuestionResults_200_response]

Exemple

Exemple de getQuestionResults

Copy

let (response, httpResponse) = client.getQuestionResults(
  tenantId = "my-tenant-123",
  urlId = "news/politics/election-2024",
  userId = "user-9876",
  startDate = "2024-01-01T00:00:00Z",
  questionId = "q-user-satisfaction",
  questionIds = "q-user-satisfaction,q-engagement",
  skip = 0.0
)
if response.isSome:
  let results = response.get()
  echo "Got question results: ", $results
else:
  echo "No results, HTTP status: ", httpResponse.status

Mettre à jour un résultat de question

Paramètres

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

Réponse

Exemple

Exemple de updateQuestionResult

Copy

let (response, httpResponse) = client.updateQuestionResult(
  tenantId = "my-tenant-123",
  id = "question-456",
  updateQuestionResultBody = UpdateQuestionResultBody(
    result = "approved",
    reviewerId = "moderator-42",
    notes = "Valid question, no action required",
    isSpam = false
  )
)
if response.isSome:
  let flagResponse = response.get()
  discard flagResponse

Agrégat des résultats de question

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
questionId	string	Non
questionIds	seq[string]	Non
urlId	string	Oui
timeBucket	AggregateTimeBucket	Non
startDate	string	Non
forceRecalculate	bool	Non

Réponse

Renvoie : Option[AggregateQuestionResults_200_response]

Exemple

Exemple de aggregateQuestionResults

Copy

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

Agrégation en masse des résultats de question

Paramètres

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

Réponse

Renvoie : Option[BulkAggregateQuestionResults_200_response]

Exemple

Exemple de bulkAggregateQuestionResults

Copy

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

Combiner les commentaires avec les résultats de question

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
questionId	string	Non
questionIds	seq[string]	Non
urlId	string	Oui
startDate	string	Non
forceRecalculate	bool	Non
minValue	float64	Non
maxValue	float64	Non
limit	float64	Non

Réponse

Renvoie: Option[CombineCommentsWithQuestionResults_200_response]

Exemple

Exemple de combineCommentsWithQuestionResults

Copy

let (response, httpResponse) = client.combineCommentsWithQuestionResults(
  tenantId = "my-tenant-123",
  questionId = "q-9876",
  questionIds = @["q-9876", "q-9877"],
  urlId = "news/article-title",
  startDate = "2025-01-01T00:00:00Z",
  forceRecalculate = false,
  minValue = 1.0,
  maxValue = 5.0,
  limit = 100.0
)
if response.isSome:
  let combined = response.get()
  discard combined

Ajouter un utilisateur SSO

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
createAPISSOUserData	CreateAPISSOUserData	Non

Réponse

Renvoie : Option[AddSSOUserAPIResponse]

Exemple

Exemple addSSOUser

Copy

let (response, httpResponse) = client.addSSOUser(
  tenantId = "my-tenant-123",
  createAPISSOUserData = CreateAPISSOUserData(
    id = "sso-456",
    email = "alice.johnson@newsorg.com",
    name = "Alice Johnson",
    roles = @["editor", "contributor"],
    isActive = true,
    isAdmin = false
  )
)
if response.isSome:
  let apiResp = response.get()
  discard apiResp
else:
  discard httpResponse

Supprimer un utilisateur SSO

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
deleteComments	bool	Non
commentDeleteMode	string	Non

Réponse

Retourne: Option[DeleteSSOUserAPIResponse]

Exemple

Exemple de deleteSSOUser

Copy

let (response, httpResponse) = client.deleteSSOUser(tenantId = "my-tenant-123", id = "sso-user-9876", deleteComments = true, commentDeleteMode = "hard")
if response.isSome:
  let deleted = response.get()
  discard deleted
else:
  discard httpResponse

Récupérer un utilisateur SSO par e-mail

Paramètres

Nom	Type	Requis	Description
tenantId	string	Yes
email	string	No

Réponse

Renvoie : Option[GetSSOUserByEmailAPIResponse]

Exemple

Exemple getSSOUserByEmail

Copy

let (response, httpResponse) = client.getSSOUserByEmail(tenantId = "my-tenant-123", email = "alice@newsco.com")
if response.isSome:
  let ssoUser = response.get()
  echo "SSO user found: ", ssoUser.email
else:
  echo "No SSO user found. HTTP status: ", httpResponse.status

Récupérer un utilisateur SSO par ID

Paramètres

Name	Type	Required	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetSSOUserByIdAPIResponse]

Exemple

Exemple de getSSOUserById

Copy

let (response, httpResponse) = client.getSSOUserById(tenantId = "my-tenant-123", id = "user-789")
if response.isSome:
  let ssoUser: GetSSOUserByIdAPIResponse = response.get()
  echo "SSO user retrieved: ", $ssoUser
else:
  echo "No SSO user found, HTTP status: ", httpResponse.statusCode

Récupérer les utilisateurs SSO

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	int	Non

Réponse

Renvoie: Option[GetSSOUsers_200_response]

Exemple

Exemple getSSOUsers

Copy

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

Modifier partiellement un utilisateur SSO

Paramètres

Name	Type	Required
tenantId	string	Oui
id	string	Non
updateAPISSOUserData	UpdateAPISSOUserData	Non
updateComments	bool	Non

Réponse

Renvoie : Option[PatchSSOUserAPIResponse]

Exemple

Exemple de patchSSOUser

Copy

let (response, httpResponse) = client.patchSSOUser(
  tenantId = "my-tenant-123",
  id = "user-789",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-987",
    username = "j.smith",
    email = "j.smith@news.example.com",
    displayName = "John Smith",
    roles = @["author", "editor"],
    avatarUrl = "https://cdn.news.example.com/avatars/j.smith.png"
  ),
  updateComments = true
)
if response.isSome:
  let patched = response.get()
  echo patched

Remplacer/mettre à jour un utilisateur SSO

Paramètres

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

Réponse

Renvoie: Option[PutSSOUserAPIResponse]

Exemple

Exemple de putSSOUser

Copy

let (response, httpResponse) = client.putSSOUser(
  tenantId = "my-tenant-123",
  id = "user-456",
  updateAPISSOUserData = UpdateAPISSOUserData(
    externalId = "ext-789",
    displayName = "Jane Doe",
    email = "jane.doe@example.com",
    avatarUrl = "https://cdn.news-site.com/avatars/jane.jpg",
    roles = @["member", "subscriber"]
  ),
  updateComments = true
)
if response.isSome:
  let result = response.get()
  echo "SSO user updated:", result

Créer un abonnement

Paramètres

Name	Type	Requis	Description
tenantId	string	Oui
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Non

Réponse

Retourne: Option[CreateSubscriptionAPIResponse]

Exemple

Exemple de createSubscription

Copy

let createData = CreateAPIUserSubscriptionData(
  subscriberId = "user-987",
  email = "jane.doe@newsreader.com",
  urlId = "news/local-weather",
  active = true,
  tags = @["weather", "local"],
  frequency = "immediate"
)
let (response, httpResponse) = client.createSubscription(tenantId = "my-tenant-123", createAPIUserSubscriptionData = createData)
if response.isSome:
  let created = response.get()
  echo "Created subscription id: ", created.id

Supprimer un abonnement

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
userId	string	Non

Réponse

Renvoie : Option[DeleteSubscriptionAPIResponse]

Exemple

Exemple de deleteSubscription

Copy

let (response, httpResponse) = client.deleteSubscription(tenantId = "my-tenant-123", id = "sub-98765", userId = "user-456")
if response.isSome:
  let deleteResp = response.get()
  echo "Delete subscription response received"
else:
  echo "No subscription response"

Récupérer les abonnements

Paramètres

Name	Type	Requis	Description
tenantId	string	Oui
userId	string	Non

Réponse

Renvoie : Option[GetSubscriptionsAPIResponse]

Exemple

Exemple de getSubscriptions

Copy

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

Récupérer l'utilisation quotidienne du locataire

Paramètres

Nom	Type	Obligatoire
tenantId	string	Oui
yearNumber	float64	Non
monthNumber	float64	Non
dayNumber	float64	Non
skip	float64	Non

Réponse

Renvoie : Option[GetTenantDailyUsages_200_response]

Exemple

Exemple pour getTenantDailyUsages

Copy

let (response, httpResponse) = client.getTenantDailyUsages(
  tenantId = "my-tenant-123",
  yearNumber = 2025.0,
  monthNumber = 6.0,
  dayNumber = 15.0,
  skip = 0.0
)
if response.isSome:
  let usages = response.get()
  echo usages
else:
  echo "No daily usages returned"

Créer un forfait pour locataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
createTenantPackageBody	CreateTenantPackageBody	Non

Réponse

Renvoie : Option[CreateTenantPackage_200_response]

Exemple

Exemple de createTenantPackage

Copy

let packageBody = CreateTenantPackageBody(
  packageName = "premium-comments",
  description = "Premium moderation package for news site",
  planId = "plan-pro-2024",
  seats = 100,
  enabled = true,
  features = @["moderation", "analytics", "sentiment"]
)
let (response, httpResponse) = client.createTenantPackage(tenantId = "my-tenant-123", createTenantPackageBody = packageBody)
if response.isSome:
  let pkg = response.get()
  echo "Created package ID: ", pkg.packageId
  echo "Package name: ", pkg.packageName
else:
  echo "Failed to create package, HTTP status: ", httpResponse.status.code

Supprimer un forfait pour locataire

Paramètres

Name	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Exemple

Exemple de deleteTenantPackage

Copy

let (response, httpResponse) = client.deleteTenantPackage(tenantId = "my-tenant-123", id = "pkg-789")
if response.isSome:
  let deleted = response.get()
  echo "Successfully deleted tenant package"

Récupérer un forfait pour locataire

Paramètres

Name	Type	Required	Description
tenantId	string	Yes
id	string	No

Réponse

Renvoie: Option[GetTenantPackage_200_response]

Exemple

Exemple de getTenantPackage

Copy

let (response, httpResponse) = client.getTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium-001")
if response.isSome:
  let pkg = response.get()
  echo pkg
else:
  echo "No package found for tenant"

Récupérer les forfaits du locataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie: Option[GetTenantPackages_200_response]

Exemple

Exemple getTenantPackages

Copy

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

Remplacer un forfait pour locataire

Paramètres

Name	Type	Required
tenantId	string	Yes
id	string	No
replaceTenantPackageBody	ReplaceTenantPackageBody	No

Réponse

Exemple

Exemple de replaceTenantPackage

Copy

let replaceBody = ReplaceTenantPackageBody(
  packageName = "Community Pro",
  seats = 500,
  enableModeration = true,
  features = @["moderation", "analytics", "single-sign-on"]
)
let (response, httpResponse) = client.replaceTenantPackage(
  tenantId = "my-tenant-123",
  id = "community-pro",
  replaceTenantPackageBody = replaceBody
)
if response.isSome:
  let flagResp = response.get()
  echo "Package replaced for tenant: ", "my-tenant-123"
  discard flagResp

Mettre à jour un forfait pour locataire

Paramètres

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

Réponse

Exemple

Exemple de updateTenantPackage

Copy

let (response, httpResponse) = client.updateTenantPackage(tenantId = "my-tenant-123", id = "pkg-premium", updateTenantPackageBody = UpdateTenantPackageBody())
if response.isSome:
  let updated = response.get()
  echo "Updated package received:", updated
else:
  echo "Update failed, HTTP status: ", httpResponse.status

Créer un utilisateur de locataire

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
createTenantUserBody	CreateTenantUserBody	Non

Réponse

Renvoie : Option[CreateTenantUser_200_response]

Exemple

Exemple de createTenantUser

Copy

let createBody = CreateTenantUserBody(
  email = "jane.doe@acmepub.com",
  displayName = "Jane Doe",
  password = "S3cur3P@ssw0rd",
  roles = @["moderator", "editor"],
  disabled = false
)
let (response, httpResponse) = client.createTenantUser(tenantId = "my-tenant-123", createTenantUserBody = createBody)
if response.isSome:
  let createdUser = response.get()
  echo createdUser

Supprimer un utilisateur de locataire

Paramètres

Name	Type	Obligatoire
tenantId	string	Oui
id	string	Non
deleteComments	string	Non
commentDeleteMode	string	Non

Réponse

Exemple

Exemple de deleteTenantUser

Copy

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

Récupérer un utilisateur de locataire

Paramètres

Nom	Type	Obligatoire	Description
tenantId	string	Oui
id	string	Non

Réponse

Renvoie: Option[GetTenantUser_200_response]

Exemple

Exemple de getTenantUser

Copy

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

Récupérer les utilisateurs du locataire

Paramètres

Nom	Type	Requis	Description
tenantId	string	Oui
skip	float64	Non

Réponse

Renvoie: Option[GetTenantUsers_200_response]

Exemple

Exemple de getTenantUsers

Copy

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

Remplacer un utilisateur de locataire

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
replaceTenantUserBody	ReplaceTenantUserBody	Non
updateComments	string	Non

Réponse

Exemple

Exemple de replaceTenantUser

Copy

let replaceBody = ReplaceTenantUserBody(name: "Jane Doe", email: "jane.doe@example.com", roles: @["moderator", "contributor"], banned: false)
let (response, httpResponse) = client.replaceTenantUser(tenantId = "my-tenant-123", id = "user-789", replaceTenantUserBody = replaceBody, updateComments = "true")
if response.isSome:
  let updated = response.get()
  echo updated
else:
  echo "No response returned"

Envoyer un lien de connexion

Paramètres

Name	Type	Requis
tenantId	string	Oui
id	string	Non
redirectURL	string	Non

Réponse

Exemple

Exemple de sendLoginLink

Copy

let (response, httpResponse) = client.sendLoginLink(tenantId = "fastcomments-tenant-42", id = "user-9876", redirectURL = "https://news.example.com/articles/2026/fastcomments-login")
if response.isSome:
  let loginResp = response.get()
  echo "Login link sent successfully"
else:
  echo "Failed to send login link"

Mettre à jour un utilisateur de locataire

Paramètres

Nom	Type	Requis
tenantId	string	Oui
id	string	Non
updateTenantUserBody	UpdateTenantUserBody	Non
updateComments	string	Non

Réponse