FastComments JavaScript/TypeScript SDK

npm install fastcomments-sdk

Référence complète de l’API : docs/api/README.md

Ce SDK utilise des points d'entrée doubles pour garantir une compatibilité optimale et éviter les erreurs d'exécution :

• fastcomments-sdk/browser - Version adaptée au navigateur utilisant fetch natif
• fastcomments-sdk/server - Version complète pour Node.js avec prise en charge du SSO
• fastcomments-sdk (par défaut) - Contient uniquement des types, sûr à importer n'importe où

Le SDK fournit trois classes d'API principales :

• DefaultApi - Points de terminaison sécurisés qui nécessitent votre clé API pour l'authentification. Utilisez-les pour les opérations côté serveur.
• PublicApi - Points de terminaison publics accessibles sans clé API. Ils peuvent être appelés directement depuis les navigateurs/appareils mobiles/etc.
• HiddenApi - Points de terminaison internes/admin destinés aux cas d'utilisation avancés.

Exemple : Utilisation de Public API (adaptée au navigateur)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Récupérer les commentaires d'une page (aucune clé API requise)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Exemple : Utilisation de Default API (uniquement côté serveur)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // Gardez cette clé secrète !
});
const defaultApi = new DefaultApi(config);

// Récupérer les commentaires avec un accès administrateur complet
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

FastComments prend en charge le SSO pour s'intégrer à votre système d'authentification utilisateur existant. La fonctionnalité SSO n'est disponible que dans l'export serveur car elle requiert les fonctionnalités crypto de Node.js.

SSO simple (côté serveur uniquement)

Le SSO simple doit être généré côté serveur et envoyé au client :

// Code côté serveur (Node.js/back-end)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crée un SSO simple en utilisant l'assistant intégré  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// Envoyez ssoToken à votre code côté client
// Le code côté client peut ensuite utiliser ce jeton avec le SDK pour navigateur

SSO sécurisé (côté serveur, recommandé)

Le SSO sécurisé doit être implémenté côté serveur et offre une meilleure sécurité :

// Code côté serveur (Node.js/back-end)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crée un SSO sécurisé en utilisant l'assistant intégré
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// À utiliser avec des appels d'API côté serveur
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Ou envoyez ssoConfig au client pour une utilisation dans le navigateur

Utiliser le SSO depuis le navigateur (avec un jeton généré par le serveur)

// Code côté client (navigateur)
import { PublicApi } from 'fastcomments-sdk/browser';

// Récupérez le jeton SSO depuis votre point de terminaison serveur
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Utilisez le jeton SSO généré par le serveur
});

SSO avec création de commentaire

// Côté serveur : créer le SSO et le commentaire
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Récupérer les commentaires d'une page

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Créer un commentaire

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Voter sur un commentaire

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 pour un vote positif, -1 pour un vote négatif
  }
});

Gestion des utilisateurs (Nécessite une clé API)

// Recherche d'utilisateurs (nécessite DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Abonnez-vous aux événements en direct pour recevoir des mises à jour en temps réel sur les commentaires, les votes et d'autres activités.

Événements au niveau de la page

Écoutez les événements en direct sur une page spécifique (commentaires, votes, etc.) :

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// S'abonner aux événements en direct pour une page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (obtenez ceci à partir de la réponse de getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Mettez à jour votre interface utilisateur avec le nouveau commentaire
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Mettez à jour les compteurs de votes dans votre interface utilisateur
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Retournez true si l'événement a été traité
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Fermez l'abonnement lorsque terminé
subscription.close();

S'abonner aux événements utilisateur

Écoutez les événements spécifiques à un utilisateur (notifications, mentions, etc.) :

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Obtenez ceci à partir de la réponse de getComments
};

// Abonnez-vous au fil personnel de l'utilisateur
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Affichez la notification dans votre interface utilisateur
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }

    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Fermez lorsque terminé
userSubscription.close();

Obtenir userIdWS

Le paramètre userIdWS est requis pour les événements en direct et peut être obtenu à partir des réponses de l'API :

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Extraire userIdWS de la réponse
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Vous pouvez maintenant vous abonner aux événements en direct
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

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

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // ID unique pour cette opération
  }
});

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

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

Paramètres

Réponse

Retourne : AggregationResponse

Paramètres

Réponse

Renvoie: GetAuditLogs200Response

Paramètres

Réponse

Renvoie : BlockFromCommentPublic200Response

Paramètres

Réponse

Renvoie: UnBlockCommentPublic200Response

Paramètres

Réponse

Renvoie: CheckedCommentsForBlocked200Response

Paramètres

Réponse

Retourne : BlockFromCommentPublic200Response

Paramètres

Réponse

Renvoie: CreateCommentPublic200Response

Paramètres

Réponse

Renvoie : DeleteComment200Response

Paramètres

Réponse

Renvoie : DeleteCommentPublic200Response

Paramètres

Réponse

Retourne : DeleteCommentVote200Response

Paramètres

Réponse

Renvoie : FlagComment200Response

Paramètres

Réponse

Renvoie: GetComment200Response

Paramètres

Réponse

Renvoie : GetComments200Response

req tenantId urlId

Paramètres

Réponse

Renvoie : GetCommentsPublic200Response

Paramètres

Réponse

Renvoie : GetCommentText200Response

Paramètres

Réponse

Renvoie : GetCommentVoteUserNames200Response

Paramètres

Réponse

Renvoie : LockComment200Response

Paramètres

Réponse

Renvoie: PinComment200Response

Paramètres

Réponse

Renvoie : SaveComment200Response

Paramètres

Réponse

Retourne: Array<SaveComment200Response

Paramètres

Réponse

Renvoie : SetCommentText200Response

Paramètres

Réponse

Retourne : UnBlockCommentPublic200Response

Paramètres

Réponse

Retourne : FlagComment200Response

Paramètres

Réponse

Renvoie: LockComment200Response

Paramètres

Réponse

Renvoie : PinComment200Response

Paramètres

Réponse

Retourne: FlagCommentPublic200Response

Paramètres

Réponse

Retourne: VoteComment200Response

Paramètres

Réponse

Renvoie: AddDomainConfig200Response

Paramètres

Réponse

Renvoie: DeleteDomainConfig200Response

Paramètres

Réponse

Renvoie: GetDomainConfig200Response

Paramètres

Réponse

Retourne: GetDomainConfigs200Response

Paramètres

Réponse

Retourne : GetDomainConfig200Response

Paramètres

Réponse

Renvoie : GetDomainConfig200Response

Paramètres

Réponse

Renvoie : CreateEmailTemplate200Response

Exemple

Exemple de createEmailTemplate

Copy

1

2const tenantId: string = "tenant_7a9f2b3d";

3

4const createEmailTemplateBody: CreateEmailTemplateBody = {

5 name: "Comment Notification",

6 subject: "New comment on your article: ",

7 htmlBody: "<p> left a comment:</p><blockquote></blockquote>",

8 enabled: true,

9 defaultLocale: "en-US",

10 metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // données supplémentaires optionnelles

11};

12

13const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

14

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteEmailTemplate

Copy

1

2const tenantId: string = "tenant_4b2f6a-4b2f6a2d";

3const templateId: string = "email_template_9f8b7c3e";

4const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

5const status: APIStatus | undefined = result?.status

6

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deleteEmailTemplateRenderError

Copy

1

2const tenantId: string = "tenant_8f3b2a9c";

3const id: string = "template_4a1c9f7e";

4const errorId: string = "err_20260112_abc123";

5const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

6

Paramètres

Réponse

Renvoie : GetEmailTemplate200Response

Exemple

Exemple de getEmailTemplate

Copy

1

2(async () => {

3 const tenantId: string = 'acme-enterprises-123';

4 const id: string = 'welcome-email-template-v2';

5 const locale: string | undefined = 'en-US'; // exemple de paramètre optionnel

6 const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);

7 console.log(template, locale);

8})();

9

Parameters

Réponse

Renvoie : GetEmailTemplateDefinitions200Response

Exemple

Exemple de getEmailTemplateDefinitions

Copy

1

2const tenantId: string = 'acme-enterprises-78f2';

3const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

4

Paramètres

Réponse

Renvoie : GetEmailTemplateRenderErrors200Response

Exemple

Exemple de getEmailTemplateRenderErrors

Copy

1

2const tenantId: string = "tenant_7b3f2a9c";

3const id: string = "tmpl_4f1b2c9e";

4const skip: number = 25;

5const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

6

Paramètres

Réponse

Renvoie : GetEmailTemplates200Response

Exemple

Exemple de getEmailTemplates

Copy

1

2const tenantId: string = 'tenant_8f4d2b7c';

3const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);

4const skip: number = 20;

5const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

6

Paramètres

Réponse

Retourne: RenderEmailTemplate200Response

Exemple

Exemple de renderEmailTemplate

Copy

1

2const tenantId: string = 'acme-corp-7f3';

3const renderEmailTemplateBody: RenderEmailTemplateBody = {

4 templateId: 'new-comment-notification',

5 recipientEmail: 'jane.doe@acme.com',

6 variables: {

7 commenterName: 'Samir Patel',

8 commentText: 'I found this article really helpful — thanks for sharing!',

9 threadUrl: 'https://acme.com/blog/123#comments'

10 },

11 includeUnsubscribeLink: true

12};

13const locale: string = 'en-US';

14const response: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

15

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de updateEmailTemplate

Copy

1

2const tenantId: string = 'acme-corp-tenant-01';

3const id: string = 'email_tpl_42b7a9';

4const updateEmailTemplateBody: UpdateEmailTemplateBody = {

5 name: 'Comment Flag Notification',

6 subject: 'A comment was flagged on acme.com',

7 html: '<p>A comment by was flagged. Review at </p>',

8 replyTo: 'noreply@acme.com', // champ facultatif démontré

9 enabled: true,

10 customConfig: { priority: 'high' } // paramètres personnalisés facultatifs

11};

12const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

13

req tenantId urlId userIdWS

Paramètres

Réponse

Retourne: GetEventLog200Response

req tenantId urlId userIdWS

Paramètres

Réponse

Renvoie: GetEventLog200Response

Paramètres

Réponse

Retourne: CreateFeedPost200Response

Paramètres

Réponse

Retourne: CreateFeedPostPublic200Response

Paramètres

Réponse

Renvoie: DeleteFeedPostPublic200Response

req tenantId afterId

Paramètres

Réponse

Retourne : GetFeedPosts200Response

req tenantId afterId

Paramètres

Réponse

Retourne : GetFeedPostsPublic200Response

Paramètres

Réponse

Retourne: GetFeedPostsStats200Response

Paramètres

Réponse

Renvoie : GetUserReactsPublic200Response

Paramètres

Réponse

Renvoie : ReactFeedPostPublic200Response

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Paramètres

Réponse

Retourne : CreateFeedPostPublic200Response

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Paramètres

Réponse

Retourne: AddHashTag200Response

Exemple

Exemple de addHashTag

Copy

1

2const tenantId: string = 'tenant_7b2f6c2b';

3const createBody: CreateHashTagBody = {

4 tag: 'feature-request',

5 label: 'Feature Request',

6 description: 'Requests for new functionality in the web client',

7 isActive: true,

8 visibility: 'public',

9 allowedDomains: ['example.com', 'internal.example.com']

10};

11const result: AddHashTag200Response = await addHashTag(tenantId, createBody);

12const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {

13 tag: 'bug',

14 label: 'Bug',

15 description: 'Use for reproducible bugs reported by users',

16 isActive: true,

17 visibility: 'public'

18});

19

Paramètres

Réponse

Renvoie : AddHashTagsBulk200Response

Exemple

Exemple pour addHashTagsBulk

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_3f2b9a';

4 const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {

5 tags: [

6 { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },

7 { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }

8 ]

9 };

10 const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

11 const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

12 console.log(result, resultWithNoTenant);

13})();

14

Paramètres

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de deleteHashTag

Copy

1

2const tag: string = 'breaking-news';

3const tenantId: string = 'tenant_42';

4const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;

5const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);

6

Paramètres

Réponse

Retourne: GetHashTags200Response

Exemple

Exemple getHashTags

Copy

1

2(async () => {

3 const tenantId: string = "acme-corp-7a9f";

4 const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);

5 const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);

6 console.log(tagsPage1, tagsPage2);

7})();

8

Paramètres

Réponse

Renvoie: PatchHashTag200Response

Exemple

Exemple de patchHashTag

Copy

1

2const tag: string = 'release-2026';

3const tenantId: string = 'tenant_42';

4const updateHashTagBody: UpdateHashTagBody = {

5 displayName: 'Release 2026',

6 description: 'Discussions and notes for the 2026 product release',

7 isActive: true

8};

9const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

10

Paramètres

Réponse

Retourne: CreateModerator200Response

Exemple

Exemple de createModerator

Copy

1

2const tenantId: string = "tenant_prod_us-east_01";

3const createModeratorBody: CreateModeratorBody = {

4 email: "maria.lopez+mod@fastcompany.com",

5 username: "mlopez_mod",

6 displayName: "Maria Lopez",

7 roles: ["content_moderator"],

8 notifyOnReports: true,

9 metadata: { region: "us-east", team: "community" }

10};

11const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

12

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de deleteModerator

Copy

1

2const tenantId: string = 'acme-tenant-987';

3const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';

4const sendEmail: string = 'true';

5const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

6

Paramètres

Réponse

Renvoie: GetModerator200Response

Exemple

Exemple de getModerator

Copy

1

2const tenantId: string = "tenant_eu_4f8d2b9e";

3const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // source optionnelle (pourrait être indéfinie)

4const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

5

Paramètres

Réponse

Renvoie : GetModerators200Response

Exemple

Exemple de getModerators

Copy

1

2const tenantId: string = "tenant_corp_7f9b2a";

3const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);

4const skip: number = 50;

5const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

6

Paramètres

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de sendInvite

Copy

1

2const tenantId: string = 'acme-tenant-004';

3const id: string = 'comment_9b7f3a2c';

4const fromName: string = 'María Hernández';

5const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

6

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple pour updateModerator

Copy

1

2const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';

3const id: string = 'mod_92a7c4';

4const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };

5const updateModeratorBodyWithOptional: UpdateModeratorBody = {

6 displayName: 'Sophia Patel',

7 email: 'sophia.patel@newsroom.example',

8 permissions: ['remove_comments', 'ban_user'],

9 notifyOnFlag: true // paramètre optionnel démontré

10};

11const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);

12

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteNotificationCount

Copy

1

2const tenantId: string = 'tenant_7f3a1b2c4d9e';

3const notificationId: string = 'notif_8c9d0a1b2f3e4b7';

4const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);

5

Paramètres

Réponse

Retourne: GetCachedNotificationCount200Response

Exemple

Exemple de getCachedNotificationCount

Copy

1

2const tenantId: string = 'acme-tenant-01';

3const baseNotificationId: string = 'notif-000123';

4const idSuffix: string | undefined = undefined; // exemple de paramètre optionnel

5const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;

6const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);

7console.log(result);

8

Paramètres

Réponse

Renvoie : GetNotificationCount200Response

Exemple

Exemple de getNotificationCount

Copy

1

2const tenantId: string = 'tenant_8a9b7c';

3const userId: string = 'user_42b3c';

4const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';

5const fromCommentId: string | undefined = undefined;

6const viewed: boolean = false;

7const type: string = 'mention';

8const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

9

Paramètres

Réponse

Renvoie : GetNotifications200Response

Exemple

Exemple de getNotifications

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_8f3b1a2c';

4 const userId: string = 'user_42';

5 const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';

6 const fromCommentId: string = 'cmt_9a7b';

7 const viewed: boolean = false;

8 const type: string = 'mention';

9 const skip: number = 0;

10 const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

11 console.log(response);

12})();

13

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple pour updateNotification

Copy

1

2const tenantId: string = "tenant_86a7b3";

3const id: string = "notif_20260112_01";

4const userId: string = "moderator_42";

5const updateNotificationBody: UpdateNotificationBody = {

6 name: "Flagged comment alert",

7 enabled: true,

8 channels: ["email"],

9 recipients: ["mod-team@news-site.com"],

10 threshold: 1

11};

12

13(async () => {

14 const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

15 console.log(result);

16})();

17

Paramètres

Réponse

Renvoie: AddPageAPIResponse

Paramètres

Réponse

Renvoie : DeletePageAPIResponse

Paramètres

Réponse

Renvoie : GetPageByURLIdAPIResponse

Paramètres

Réponse

Renvoie: GetPagesAPIResponse

Paramètres

Réponse

Retourne : PatchPageAPIResponse

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deletePendingWebhookEvent

Copy

1

2const tenantId: string = 'tenant_7f4e2b';

3const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';

4const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);

5console.log(result);

6

Paramètres

Réponse

Renvoie : GetPendingWebhookEventCount200Response

Exemple

Exemple de getPendingWebhookEventCount

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_9c3b2b';

4 const commentId: string = 'cmt_f4a1b2';

5 const externalId: string = 'ext-789';

6 const eventType: string = 'comment.created';

7 const type: string = 'delivery';

8 const domain: string = 'app.example.com';

9 const attemptCountGT: number = 2;

10

11 const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(

12 tenantId,

13 commentId,

14 externalId,

15 eventType,

16 type,

17 domain,

18 attemptCountGT

19 );

20

21 console.log(result);

22})();

23

Paramètres

Réponse

Retourne : GetPendingWebhookEvents200Response

Exemple

Exemple de getPendingWebhookEvents

Copy

1

2const tenantId: string = "tenant_78b2f1";

3const commentId: string = "cmt_0042";

4const eventType: string = "comment.created";

5const domain: string = "blog.example.com";

6const attemptCountGT: number = 1;

7const skip: number = 0;

8

9const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(

10 tenantId,

11 commentId,

12 undefined, // externalId

13 eventType,

14 undefined, // type

15 domain,

16 attemptCountGT,

17 skip

18);

19

Paramètres

Réponse

Renvoie: CreateQuestionConfig200Response

Exemple

Exemple de createQuestionConfig

Copy

1

2const tenantId: string = "tenant_live_7f8b3c2a";

3const customOptions: QuestionConfigCustomOptionsInner[] = [

4 { value: "under18", label: "Under 18" },

5 { value: "18-24", label: "18-24" },

6 { value: "25-34", label: "25-34", defaultSelected: true }

7];

8const createQuestionConfigBody: CreateQuestionConfigBody = {

9 key: "age_range",

10 label: "What is your age range?",

11 required: false, // facultatif : démontrer les champs optionnels omis vs inclus

12 renderingType: QuestionRenderingType.Dropdown,

13 options: customOptions,

14 whenSave: QuestionWhenSave.Always

15};

16const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

17

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteQuestionConfig

Copy

1

2async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {

3 if (!id) return null;

4 const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

5 return result;

6}

7const tenantId: string = 'tenant_acme_001';

8const optionalConfigId: string | undefined = 'qcfg_20260112_01';

9(async (): Promise<void> => {

10 const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);

11 void deleted;

12})();

13

Paramètres

Réponse

Renvoie: GetQuestionConfig200Response

Exemple

Exemple de getQuestionConfig

Copy

1

2const tenantId: string = 'acme-corp-47';

3const questionId: string = 'q-2026-01-12-01';

4const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);

5function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {

6 // includeMetadata est facultatif; implémentation omise par souci de concision

7 return undefined;

8}

9const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);

10const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

11

Paramètres

Réponse

Renvoie : GetQuestionConfigs200Response

Exemple

Exemple getQuestionConfigs

Copy

1

2const tenantId: string = 'tenant-42a7b9';

3const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);

4const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);

5

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de updateQuestionConfig

Copy

1

2const tenantId: string = 'tenant-82b3a';

3const id: string = 'qst-20260112';

4const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;

5const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

6

Paramètres

Réponse

Renvoie : CreateQuestionResult200Response

Exemple

Exemple de createQuestionResult

Copy

1

2const tenantId: string = "fc_tenant_7a3c_us-east-1";

3const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };

4const createQuestionResultBody: CreateQuestionResultBody = {

5 questionId: "q_42",

6 commenterId: "user_1984",

7 answer: "yes",

8 score: 4,

9 meta: [metaItem] // métadonnées optionnelles démontrées

10} as CreateQuestionResultBody;

11const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

12

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteQuestionResult

Copy

1

2const tenantId: string = 'acme-tenant-01';

3const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';

4const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);

5console.log(deletedResult);

6

Paramètres

Réponse

Renvoie : GetQuestionResult200Response

Exemple

Exemple de getQuestionResult

Copy

1

2const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";

3const questionId: string = "question_72f1b9c3a4";

4const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);

5console.log(result);

6

Paramètres

Réponse

Renvoie: GetQuestionResults200Response

Exemple

Exemple de getQuestionResults

Copy

1

2const tenantId: string = 'tenant_42';

3const urlId: string = 'news/2025/fastcomments-release';

4const userId: string = 'user_8b7f3c';

5const startDate: string = '2025-01-01T00:00:00Z';

6const questionIds: string = 'q123,q124';

7const skip: number = 20;

8const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

9

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de updateQuestionResult

Copy

1

2const tenantId: string = 'tenant_84f2b9';

3const id: string = 'question_3a7c1d';

4const updateQuestionResultBody: UpdateQuestionResultBody = {

5 result: { verdict: 'helpful', confidence: 0.92 },

6 reviewer: { id: 'mod_102', name: 'Aisha Rahman' },

7 notifyUser: true // paramètre optionnel inclus

8};

9const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

10

Paramètres

Réponse

Renvoie : AggregateQuestionResults200Response

Paramètres

Réponse

Renvoie : BulkAggregateQuestionResults200Response

Paramètres

Réponse

Retourne : CombineCommentsWithQuestionResults200Response

Paramètres

Réponse

Retourne : AddSSOUserAPIResponse

Paramètres

Réponse

Renvoie : DeleteSSOUserAPIResponse

Paramètres

Réponse

Renvoie: GetSSOUserByEmailAPIResponse

Paramètres

Réponse

Retourne : GetSSOUserByIdAPIResponse

Paramètres

Réponse

Retourne : GetSSOUsers200Response

Paramètres

Réponse

Renvoie: PatchSSOUserAPIResponse

Paramètres

Réponse

Renvoie : PutSSOUserAPIResponse

Paramètres

Réponse

Retourne: CreateSubscriptionAPIResponse

Paramètres

Réponse

Retourne : DeleteSubscriptionAPIResponse

Paramètres

Réponse

Retourne : GetSubscriptionsAPIResponse

Paramètres

Réponse

Renvoie: GetTenantDailyUsages200Response

Exemple

Exemple de getTenantDailyUsages

Copy

1

2const tenantId: string = "tenant_89f3c2-prod";

3const yearNumber: number = 2026;

4const monthNumber: number = 1;

5const skip: number = 0;

6const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

7

Paramètres

Réponse

Renvoie : CreateTenantPackage200Response

Exemple

Exemple de createTenantPackage

Copy

1

2const tenantId: string = "tenant_7f3b1a9c";

3const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };

4const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };

5const createTenantPackageBody: CreateTenantPackageBody = {

6 packageName: "Premium Plus",

7 tenantPackage,

8 customConfig,

9 notes: "Enable advanced moderation and image uploads" // paramètre optionnel démontré

10};

11const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

12

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deleteTenantPackage

Copy

1

2const tenantId: string = 'fc-tenant-8a9c2b';

3const packageId: string = 'pkg-47f3c9';

4const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

5

Paramètres

Réponse

Renvoie: GetTenantPackage200Response

Exemple

Exemple getTenantPackage

Copy

1

2const tenantId: string = 'tenant_westus_01';

3const packageId: string = 'pkg_premium_annual_2026';

4interface FetchOptions { includeArchived?: boolean }

5const options: FetchOptions = { includeArchived: false };

6const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

7

Paramètres

Réponse

Renvoie: GetTenantPackages200Response

Exemple

Exemple getTenantPackages

Copy

1

2const tenantId: string = 'tenant_4f3a9c2d';

3const skip: number = 25;

4const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);

5const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

6

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de replaceTenantPackage

Copy

1

2const tenantId: string = 'tenant-9b72f2';

3const packageId: string = 'pkg-prod-v2';

4const replaceTenantPackageBody: ReplaceTenantPackageBody = {

5 name: 'Premium Moderation Bundle',

6 enabled: true,

7 maxModerators: 4,

8 // les champs optionnels comme "notes" ou "trialExpiry" sont intentionnellement omis ici

9} as ReplaceTenantPackageBody;

10const result: FlagCommentPublic200Response = await replaceTenantPackage(

11 tenantId,

12 packageId,

13 replaceTenantPackageBody

14);

15