FastComments Rust SDK

cargo add fastcomments-sdk

Le SDK nécessite l'édition Rust 2021 ou une version ultérieure.

Le SDK Rust de FastComments se compose de plusieurs modules :

• Client Module - Client API généré automatiquement pour les API REST de FastComments

  • Définitions de types complètes pour tous les modèles d'API
  • Points de terminaison à la fois authentifiés (DefaultApi) et publics (PublicApi)
  • Prise en charge complète d'async/await avec tokio
  • Voir client/README.md pour la documentation détaillée de l'API

• SSO Module - Utilitaires Single Sign-On côté serveur

  • Génération sécurisée de jetons pour l'authentification des utilisateurs
  • Prise en charge des modes SSO simple et sécurisé
  • Signature des jetons basée sur HMAC-SHA256

• Core Types - Définitions de types partagées et utilitaires

  • Modèles de commentaires et structures de métadonnées
  • Configurations des utilisateurs et des locataires
  • Fonctions utilitaires pour les opérations courantes

Utilisation de l'API publique

use fastcomments_sdk::client::apis::configuration::Configuration;
use fastcomments_sdk::client::apis::public_api;

#[tokio::main]
async fn main() {
    // Créer la configuration de l'API
    let config = Configuration::new();

    // Récupérer les commentaires d'une page
    let result = public_api::get_comments_public(
        &config,
        public_api::GetCommentsPublicParams {
            tenant_id: "your-tenant-id".to_string(),
            urlid: Some("page-url-id".to_string()),
            url: None,
            count_only: None,
            skip: None,
            limit: None,
            sort_dir: None,
            page: None,
            sso_hash: None,
            simple_sso_hash: None,
            has_no_comment: None,
            has_comment: None,
            comment_id_filter: None,
            child_ids: None,
            start_date_time: None,
            starts_with: None,
        },
    )
    .await;

    match result {
        Ok(response) => {
            println!("Found {} comments", response.comments.len());
            for comment in response.comments {
                println!("Comment: {:?}", comment);
            }
        }
        Err(e) => eprintln!("Error fetching comments: {:?}", e),
    }
}

Utilisation de l'API authentifiée

use fastcomments_sdk::client::apis::configuration::{ApiKey, Configuration};
use fastcomments_sdk::client::apis::default_api;

#[tokio::main]
async fn main() {
    // Créer la configuration avec la clé API
    let mut config = Configuration::new();
    config.api_key = Some(ApiKey {
        prefix: None,
        key: "your-api-key".to_string(),
    });

    // Récupérer les commentaires en utilisant l'API authentifiée
    let result = default_api::get_comments(
        &config,
        default_api::GetCommentsParams {
            tenant_id: "your-tenant-id".to_string(),
            skip: None,
            limit: None,
            sort_dir: None,
            urlid: Some("page-url-id".to_string()),
            url: None,
            is_spam: None,
            user_id: None,
            all_comments: None,
            for_moderation: None,
            parent_id: None,
            is_flagged: None,
            is_flagged_tag: None,
            is_by_verified: None,
            is_pinned: None,
            asc: None,
            include_imported: None,
            origin: None,
            tags: None,
        },
    )
    .await;

    match result {
        Ok(response) => {
            println!("Total comments: {}", response.count);
            for comment in response.comments {
                println!("Comment ID: {}, Text: {}", comment.id, comment.comment);
            }
        }
        Err(e) => eprintln!("Error: {:?}", e),
    }
}

Utilisation de SSO pour l'authentification

use fastcomments_sdk::sso::{
    fastcomments_sso::FastCommentsSSO,
    secure_sso_user_data::SecureSSOUserData,
};

fn main() {
    let api_key = "your-api-key".to_string();

    // Créer les données utilisateur SSO sécurisées (côté serveur uniquement !)
    let user_data = SecureSSOUserData::new(
        "user-123".to_string(),           // ID utilisateur
        "user@example.com".to_string(),   // Adresse e-mail
        "John Doe".to_string(),            // Nom d'utilisateur
        "https://example.com/avatar.jpg".to_string(), // URL de l'avatar
    );

    // Générer le token SSO
    let sso = FastCommentsSSO::new_secure(api_key, &user_data).unwrap();
    let token = sso.create_token().unwrap();

    println!("SSO Token: {}", token);
    // Transmettez ce token à votre frontend pour l'authentification
}

401 Unauthorized Errors

Si vous obtenez des erreurs 401 lorsque vous utilisez l'API authentifiée :

1. Vérifiez votre clé API : Assurez-vous d'utiliser la clé API correcte depuis votre tableau de bord FastComments
2. Vérifiez le tenant ID : Assurez-vous que le tenant ID correspond à votre compte
3. Format de la clé API : La clé API doit être passée dans la Configuration :

let mut config = Configuration::new();
config.api_key = Some(ApiKey {
    prefix: None,
    key: "YOUR_API_KEY".to_string(),
});

SSO Token Issues

Si les jetons SSO ne fonctionnent pas :

1. Utilisez le mode sécurisé en production : Toujours utiliser FastCommentsSSO::new_secure() avec votre clé API pour la production
2. Côté serveur uniquement : Générez les jetons SSO sur votre serveur, n'exposez jamais votre clé API aux clients
3. Vérifiez les données utilisateur : Assurez-vous que tous les champs requis (id, email, username) sont fournis

Async Runtime Errors

Le SDK utilise tokio pour les opérations asynchrones. Assurez-vous de :

1. Add tokio to your dependencies:

   [dependencies]
   tokio = { version = "1", features = ["full"] }

2. Use the tokio runtime:

   #[tokio::main]
   async fn main() {
    // Votre code asynchrone ici
   }

Identifiants de diffusion

Vous verrez que vous devez passer un broadcastId dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permet d'ignorer l'événement si vous prévoyez d'appliquer les modifications de manière optimiste côté client

(ce que vous souhaiterez probablement faire car cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une même session du navigateur.

Agrège les documents en les groupant (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

Retourne : GetAuditLogs200Response

Paramètres

Réponse

Renvoie: BlockFromCommentPublic200Response

Paramètres

Réponse

Retourne: UnBlockCommentPublic200Response

Paramètres

Réponse

Renvoie : CheckedCommentsForBlocked200Response

Paramètres

Réponse

Retourne : BlockFromCommentPublic200Response

Paramètres

Réponse

Renvoie: CreateCommentPublic200Response

Paramètres

Réponse

Retourne : DeleteComment200Response

Paramètres

Réponse

Renvoie : DeleteCommentPublic200Response

Paramètres

Réponse

Renvoie : DeleteCommentVote200Response

Paramètres

Réponse

Renvoie : FlagComment200Response

Paramètres

Réponse

Renvoie : GetComment200Response

Paramètres

Réponse

Retourne : GetCommentText200Response

Paramètres

Réponse

Retourne : GetCommentVoteUserNames200Response

Paramètres

Réponse

Renvoie: GetComments200Response

req tenantId urlId

Paramètres

Réponse

Renvoie: GetCommentsPublic200Response

Paramètres

Réponse

Renvoie: LockComment200Response

Paramètres

Réponse

Renvoie: PinComment200Response

Paramètres

Réponse

Renvoie : SaveComment200Response

Paramètres

Réponse

Retourne : Vec<models::SaveComment200Response>

Paramètres

Réponse

Renvoie: SetCommentText200Response

Paramètres

Réponse

Renvoie : UnBlockCommentPublic200Response

Paramètres

Réponse

Retourne: FlagComment200Response

Paramètres

Réponse

Renvoie: LockComment200Response

Paramètres

Réponse

Renvoie : PinComment200Response

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Paramètres

Réponse

Renvoie: VoteComment200Response

Paramètres

Réponse

Renvoie : AddDomainConfig200Response

Paramètres

Réponse

Renvoie: DeleteDomainConfig200Response

Paramètres

Réponse

Renvoie : GetDomainConfig200Response

Paramètres

Réponse

Renvoie: GetDomainConfigs200Response

Paramètres

Réponse

Retourne: GetDomainConfig200Response

Paramètres

Réponse

Renvoie : GetDomainConfig200Response

Paramètres

Réponse

Retourne: CreateEmailTemplate200Response

Exemple

Exemple create_email_template

Copy

1

2let params: CreateEmailTemplateParams = CreateEmailTemplateParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 create_email_template_body: models::CreateEmailTemplateBody {

5 name: "New Comment Notification".to_string(),

6 subject: "New comment on your article".to_string(),

7 html_body: "<p>A new comment was posted on <strong>{article_title}</strong>.</p>".to_string(),

8 text_body: Some("A new comment was posted on {article_title}.".to_string()),

9 from_email: Some("no-reply@acme-news.com".to_string()),

10 enabled: Some(true),

11 },

12};

13let response: CreateEmailTemplate200Response = create_email_template(&configuration, params).await?;

14

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de delete_email_template

Copy

1

2async fn run_delete() -> Result<FlagCommentPublic200Response, Error> {

3 let params: DeleteEmailTemplateParams = DeleteEmailTemplateParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "welcome-email-template".to_string(),

6 };

7 let response: FlagCommentPublic200Response = delete_email_template(&configuration, params).await?;

8 Ok(response)

9}

10

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de delete_email_template_render_error

Copy

1

2async fn delete_email_template_render_error_example() -> Result<FlagCommentPublic200Response, Error> {

3 let params: DeleteEmailTemplateRenderErrorParams = DeleteEmailTemplateRenderErrorParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "marketing/newsletter/welcome-email".to_string(),

6 error_id: "render-err-2026-01-12-01".to_string(),

7 };

8 let response: FlagCommentPublic200Response = delete_email_template_render_error(configuration, params).await?;

9 Ok(response)

10}

11

Paramètres

Réponse

Renvoie : GetEmailTemplate200Response

Exemple

get_email_template Exemple

Copy

1

2async fn fetch_template() -> Result<GetEmailTemplate200Response, Error> {

3 let params: GetEmailTemplateParams = GetEmailTemplateParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "welcome-email-template".to_string(),

6 };

7 let template: GetEmailTemplate200Response = get_email_template(&configuration, params).await?;

8 Ok(template)

9}

10

Paramètres

Réponse

Renvoie: GetEmailTemplateDefinitions200Response

Exemple

Exemple de get_email_template_definitions

Copy

1

2async fn run() -> Result<(), Error> {

3 let config: configuration::Configuration = configuration::Configuration::default();

4 let params: GetEmailTemplateDefinitionsParams = GetEmailTemplateDefinitionsParams {

5 tenant_id: "acme-corp-tenant".to_string(),

6 locale: Some("en-US".to_string()),

7 include_inactive: Some(false),

8 };

9 let resp: GetEmailTemplateDefinitions200Response = get_email_template_definitions(&config, params).await?;

10 let _definitions = resp;

11 Ok(())

12}

13

Paramètres

Réponse

Renvoie : GetEmailTemplateRenderErrors200Response

Exemple

Exemple de get_email_template_render_errors

Copy

1

2async fn example_call() -> Result<(), Error> {

3 let params: GetEmailTemplateRenderErrorsParams = GetEmailTemplateRenderErrorsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "welcome-email-template".to_string(),

6 skip: Some(10.0),

7 };

8 let _response: GetEmailTemplateRenderErrors200Response =

9 get_email_template_render_errors(&configuration, params).await?;

10 Ok(())

11}

12

Paramètres

Réponse

Renvoie: GetEmailTemplates200Response

Exemple

Exemple de get_email_templates

Copy

1

2async fn fetch_email_templates() -> Result<GetEmailTemplates200Response, Error> {

3 let params: GetEmailTemplatesParams = GetEmailTemplatesParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 skip: Some(20.0),

6 };

7 let templates: GetEmailTemplates200Response = get_email_templates(&configuration, params).await?;

8 Ok(templates)

9}

10

Paramètres

Réponse

Renvoie: RenderEmailTemplate200Response

Exemple

Exemple de render_email_template

Copy

1

2let params: RenderEmailTemplateParams = RenderEmailTemplateParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 render_email_template_body: models::RenderEmailTemplateBody {

5 template_id: "comment-notification".to_string(),

6 subject: Some("New comment on your article".to_string()),

7 placeholders: std::collections::HashMap::from([

8 ("article_title".to_string(), "Rust Gains Momentum in 2026".to_string()),

9 ("comment_author".to_string(), "Jane Doe".to_string()),

10 ("comment_snippet".to_string(), "Great insights — thanks for sharing!".to_string()),

11 ]),

12 },

13 locale: Some("en-US".to_string()),

14};

15let rendered: RenderEmailTemplate200Response = render_email_template(&configuration, params).await?;

16

Paramètres

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de update_email_template

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: UpdateEmailTemplateParams = UpdateEmailTemplateParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "welcome-template-001".to_string(),

6 update_email_template_body: models::UpdateEmailTemplateBody {

7 name: Some("Welcome Template".to_string()),

8 subject: Some("Welcome to Acme News".to_string()),

9 body_html: Some("<p>Hi , welcome to Acme News!</p>".to_string()),

10 from_address: Some("no-reply@acme-news.com".to_string()),

11 reply_to: Some("support@acme-news.com".to_string()),

12 enabled: Some(true),

13 language: Some("en-US".to_string()),

14 custom_config: Some(models::CustomConfigParameters {

15 tracking_pixel_url: Some("https://acme-news.com/pixel".to_string()),

16 }),

17 },

18 };

19

20 let response: FlagCommentPublic200Response = update_email_template(&configuration, params).await?;

21 let _ = response;

22 Ok(())

23}

24

req tenantId urlId userIdWS

Paramètres

Réponse

Retourne: GetEventLog200Response

req tenantId urlId userIdWS

Paramètres

Réponse

Retourne: GetEventLog200Response

Paramètres

Réponse

Renvoie : CreateFeedPost200Response

Paramètres

Réponse

Retourne: CreateFeedPostPublic200Response

Paramètres

Réponse

Renvoie: DeleteFeedPostPublic200Response

req tenantId afterId

Paramètres

Réponse

Renvoie : GetFeedPosts200Response

req tenantId afterId

Paramètres

Réponse

Renvoie : GetFeedPostsPublic200Response

Paramètres

Réponse

Renvoie: GetFeedPostsStats200Response

Paramètres

Réponse

Renvoie : GetUserReactsPublic200Response

Paramètres

Réponse

Renvoie : ReactFeedPostPublic200Response

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Paramètres

Réponse

Retourne : CreateFeedPostPublic200Response

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Paramètres

Réponse

Renvoie: AddHashTag200Response

Exemple

Exemple add_hash_tag

Copy

1

2async fn run_add_hash_tag(configuration: &configuration::Configuration) -> Result<(), Error> {

3 let params: AddHashTagParams = AddHashTagParams {

4 tenant_id: Some("acme-corp-tenant".to_string()),

5 create_hash_tag_body: Some(models::CreateHashTagBody {

6 tag: "breaking-news".to_string(),

7 label: Some("Breaking News".to_string()),

8 visible: Some(true),

9 }),

10 };

11

12 let created: AddHashTag200Response = add_hash_tag(configuration, params).await?;

13 println!("{:#?}", created);

14 Ok(())

15}

16

Paramètres

Réponse

Renvoie : AddHashTagsBulk200Response

Exemple

Exemple add_hash_tags_bulk

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: AddHashTagsBulkParams = AddHashTagsBulkParams {

4 tenant_id: Some("acme-corp-tenant".to_string()),

5 bulk_create_hash_tags_body: Some(models::BulkCreateHashTagsBody {

6 tags: vec![

7 models::BulkCreateHashTagsBodyTagsInner {

8 name: "news/article".to_string(),

9 path: "news/article".to_string(),

10 description: Some("Article tag for front page".to_string()),

11 enabled: Some(true),

12 },

13 ],

14 }),

15 };

16

17 let response: AddHashTagsBulk200Response = add_hash_tags_bulk(&configuration, params).await?;

18 Ok(())

19}

20

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de delete_hash_tag

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: DeleteHashTagParams = DeleteHashTagParams {

4 tag: "news/politics".to_string(),

5 tenant_id: Some("acme-corp-tenant".to_string()),

6 delete_hash_tag_request: Some(models::DeleteHashTagRequest::default()),

7 };

8 let response: FlagCommentPublic200Response = delete_hash_tag(&configuration, params).await?;

9 Ok(())

10}

11

Paramètres

Réponse

Renvoie: GetHashTags200Response

Exemple

get_hash_tags Exemple

Copy

1

2async fn example_get_hash_tags() -> Result<GetHashTags200Response, Error> {

3 let params: GetHashTagsParams = GetHashTagsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 page: Some(1.0_f64),

6 };

7 let response: GetHashTags200Response = get_hash_tags(&configuration, params).await?;

8 Ok(response)

9}

10

Paramètres

Réponse

Renvoie : PatchHashTag200Response

Exemple

Exemple patch_hash_tag

Copy

1

2async fn run_patch_hash_tag() -> Result<PatchHashTag200Response, Error> {

3 let params: PatchHashTagParams = PatchHashTagParams {

4 tag: "breaking-news".to_string(),

5 tenant_id: Some("acme-corp-tenant".to_string()),

6 update_hash_tag_body: Some(models::UpdateHashTagBody {

7 name: "Breaking News".to_string(),

8 description: "Posts about breaking news and urgent updates".to_string(),

9 synonyms: vec!["breaking".to_string(), "urgent".to_string()],

10 is_active: true,

11 }),

12 };

13 let response: PatchHashTag200Response = patch_hash_tag(&configuration, params).await?;

14 Ok(response)

15}

16

Paramètres

Réponse

Retourne : CreateModerator200Response

Exemple

Exemple de create_moderator

Copy

1

2async fn run_create_moderator() -> Result<(), Error> {

3 let params: CreateModeratorParams = CreateModeratorParams {

4 tenant_id: "acme-corp-tenant".to_owned(),

5 create_moderator_body: models::CreateModeratorBody {

6 email: "jane.doe@acme.com".to_owned(),

7 display_name: "Jane Doe".to_owned(),

8 role: Some("moderator".to_owned()),

9 active: Some(true),

10 notes: Some("Handles product and support forums".to_owned()),

11 permissions: Some(vec!["approve_comment".to_owned(), "delete_comment".to_owned()]),

12 },

13 };

14

15 let _response: CreateModerator200Response = create_moderator(&configuration, params).await?;

16 Ok(())

17}

18

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de delete_moderator

Copy

1

2async fn run(configuration: &configuration::Configuration) -> Result<FlagCommentPublic200Response, Error> {

3 let params: DeleteModeratorParams = DeleteModeratorParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "moderator-1234".to_string(),

6 send_email: Some("true".to_string()),

7 };

8 let response: FlagCommentPublic200Response = delete_moderator(configuration, params).await?;

9 Ok(response)

10}

11

Paramètres

Réponse

Renvoie: GetModerator200Response

Exemple

Exemple de get_moderator

Copy

1

2async fn example() -> Result<(), Error> {

3 let params: GetModeratorParams = GetModeratorParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "moderator-42".to_string(),

6 include: Some(vec!["roles".to_string(), "recent_comments".to_string()]),

7 };

8 let moderator: GetModerator200Response = get_moderator(&configuration, params).await?;

9 println!("{:#?}", moderator);

10 Ok(())

11}

12

Paramètres

Réponse

Renvoie : GetModerators200Response

Exemple

Exemple get_moderators

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetModeratorsParams = GetModeratorsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 skip: Some(10.0),

6 };

7 let moderators: GetModerators200Response = get_moderators(&configuration, params).await?;

8 let _moderators = moderators;

9 Ok(())

10}

11

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple send_invite

Copy

1

2let params: SendInviteParams = SendInviteParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 id: "articles/2026/01/ai-news-12345".to_string(),

5 from_name: "Acme Newsroom".to_string(),

6 reply_to: Some("editorial@acme.com".to_string()),

7 message: Some("You have been invited to moderate comments on this article.".to_string()),

8};

9

10let invite_response: FlagCommentPublic200Response = send_invite(&configuration, params).await?;

11

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple update_moderator

Copy

1

2let params: UpdateModeratorParams = UpdateModeratorParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 id: "moderator-12345".to_string(),

5 update_moderator_body: models::UpdateModeratorBody {

6 username: "jane.doe".to_string(),

7 display_name: Some("Jane Doe".to_string()),

8 email: Some("jane.doe@acme.com".to_string()),

9 is_active: Some(true),

10 permissions: Some(vec!["moderate_comments".to_string(), "view_reports".to_string()]),

11 },

12};

13let response: FlagCommentPublic200Response = update_moderator(&configuration, params).await?;

14

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de delete_notification_count

Copy

1

2async fn run_delete_notification_count(configuration: &configuration::Configuration) -> Result<FlagCommentPublic200Response, Error> {

3 let params: DeleteNotificationCountParams = DeleteNotificationCountParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "notification-9f8b7a6".to_string(),

6 };

7 let response: FlagCommentPublic200Response = delete_notification_count(configuration, params).await?;

8 Ok(response)

9}

10

Paramètres

Réponse

Renvoie : GetCachedNotificationCount200Response

Exemple

Exemple de get_cached_notification_count

Copy

1

2async fn run_get_cached_notification_count() -> Result<(), Error> {

3 let params: GetCachedNotificationCountParams = GetCachedNotificationCountParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "news/article-12345".to_string(),

6 };

7 let preferred_channel: Option<String> = Some("email".to_string());

8 let response: GetCachedNotificationCount200Response =

9 get_cached_notification_count(&configuration, params).await?;

10 Ok(())

11}

12

Paramètres

Réponse

Retourne : GetNotificationCount200Response

Exemple

Exemple de get_notification_count

Copy

1

2async fn example_get_notification_count() -> Result<GetNotificationCount200Response, Error> {

3 let params: GetNotificationCountParams = GetNotificationCountParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 user_id: Some(String::from("user-12345")),

6 url_id: Some(String::from("news/article/2026/product-launch")),

7 from_comment_id: Some(String::from("cmt-000987")),

8 viewed: Some(false),

9 };

10 let response: GetNotificationCount200Response = get_notification_count(&configuration, params).await?;

11 Ok(response)

12}

13

Paramètres

Réponse

Retourne : GetNotifications200Response

Exemple

Exemple de get_notifications

Copy

1

2async fn fetch_notifications() -> Result<(), Error> {

3 let params: GetNotificationsParams = GetNotificationsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 user_id: Some("user-1234".to_string()),

6 url_id: Some("news/politics/article-2026-01-12".to_string()),

7 from_comment_id: Some("cmt-98765".to_string()),

8 viewed: Some(false),

9 skip: Some(0.0),

10 };

11 let notifications: GetNotifications200Response = get_notifications(&configuration, params).await?;

12 let _ = notifications;

13 Ok(())

14}

15

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de update_notification

Copy

1

2pub async fn run_update_notification(configuration: &configuration::Configuration) -> Result<FlagCommentPublic200Response, Error> {

3 let params: UpdateNotificationParams = UpdateNotificationParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "notification-67890".to_string(),

6 update_notification_body: models::UpdateNotificationBody {

7 title: Some("Flag Review Complete".to_string()),

8 message: Some("A moderator reviewed the flagged comment and marked it resolved.".to_string()),

9 resolved: Some(true),

10 channels: Some(vec!["email".to_string(), "in_app".to_string()]),

11 },

12 user_id: Some("moderator-007".to_string()),

13 };

14 let response: FlagCommentPublic200Response = update_notification(configuration, params).await?;

15 Ok(response)

16}

17

Paramètres

Réponse

Renvoie: AddPageApiResponse

Paramètres

Réponse

Renvoie : DeletePageApiResponse

Paramètres

Réponse

Retourne: GetPageByUrlidApiResponse

Paramètres

Réponse

Renvoie: GetPagesApiResponse

Paramètres

Réponse

Retourne : PatchPageApiResponse

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de delete_pending_webhook_event

Copy

1

2async fn run() -> Result<FlagCommentPublic200Response, Error> {

3 let event_id_opt: Option<String> = Some("webhook-event/news-article-2026-01-10-1234".to_string());

4 let event_id: String = event_id_opt.unwrap();

5 let params: DeletePendingWebhookEventParams = DeletePendingWebhookEventParams {

6 tenant_id: "acme-corp-tenant".to_string(),

7 id: event_id,

8 };

9 let response: FlagCommentPublic200Response = delete_pending_webhook_event(&configuration, params).await?;

10 Ok(response)

11}

12

Paramètres

Réponse

Renvoie : GetPendingWebhookEventCount200Response

Exemple

Exemple de get_pending_webhook_event_count

Copy

1

2async fn example() -> Result<GetPendingWebhookEventCount200Response, Error> {

3 let params: GetPendingWebhookEventCountParams = GetPendingWebhookEventCountParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: Some("cmt-12345".to_string()),

6 external_id: Some("news/article-98765".to_string()),

7 event_type: Some("comment.created".to_string()),

8 domain: Some("news.example.com".to_string()),

9 attempt_count_gt: Some(2.0),

10 };

11 let response: GetPendingWebhookEventCount200Response =

12 get_pending_webhook_event_count(&configuration, params).await?;

13 Ok(response)

14}

15

Paramètres

Réponse

Renvoie : GetPendingWebhookEvents200Response

Exemple

Exemple get_pending_webhook_events

Copy

1

2let params: GetPendingWebhookEventsParams = GetPendingWebhookEventsParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 comment_id: Some("cmt-12345".to_string()),

5 external_id: Some("article-98765".to_string()),

6 event_type: Some("comment.create".to_string()),

7 domain: Some("news.example.com".to_string()),

8 attempt_count_gt: Some(1.0),

9 skip: Some(0.0),

10};

11

12let pending: GetPendingWebhookEvents200Response = get_pending_webhook_events(&configuration, params).await?;

13

Paramètres

Réponse

Renvoie : CreateQuestionConfig200Response

Exemple

Exemple de create_question_config

Copy

1

2let params: CreateQuestionConfigParams = CreateQuestionConfigParams {

3 tenant_id: String::from("acme-corp-tenant"),

4 create_question_config_body: models::CreateQuestionConfigBody {

5 key: String::from("article-usefulness"),

6 label: Some(String::from("Was this article useful?")),

7 description: Some(String::from("Help us improve by rating this article.")),

8 required: Some(true),

9 rendering_type: Some(models::QuestionRenderingType::MultipleChoice),

10 custom_options: Some(vec![

11 models::QuestionConfigCustomOptionsInner { value: String::from("1"), label: Some(String::from("Not useful")) },

12 models::QuestionConfigCustomOptionsInner { value: String::from("3"), label: Some(String::from("Somewhat useful")) },

13 models::QuestionConfigCustomOptionsInner { value: String::from("5"), label: Some(String::from("Very useful")) },

14 ]),

15 enabled: Some(true),

16 },

17};

18let response: CreateQuestionConfig200Response = create_question_config(configuration, params).await?;

19

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

delete_question_config Exemple

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: DeleteQuestionConfigParams = DeleteQuestionConfigParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "news/article-comments-config-2025".to_string(),

6 force: Some(true),

7 };

8 let response: FlagCommentPublic200Response = delete_question_config(&configuration, params).await?;

9 Ok(())

10}

11

Paramètres

Réponse

Renvoie : GetQuestionConfig200Response

Exemple

Exemple de get_question_config

Copy

1

2async fn fetch_question_config() -> Result<(), Error> {

3 let tenant_env: Option<&str> = Some("prod");

4 let tenant_id: String = match tenant_env {

5 Some(env) => format!("acme-corp-tenant-{}", env),

6 None => "acme-corp-tenant".to_string(),

7 };

8 let params: GetQuestionConfigParams = GetQuestionConfigParams {

9 tenant_id,

10 id: "news/article/2026/01/12-politics".to_string(),

11 };

12 let response: GetQuestionConfig200Response = get_question_config(&configuration, params).await?;

13 let _status: ApiStatus = response.0;

14 Ok(())

15}

16

Paramètres

Réponse

Renvoie: GetQuestionConfigs200Response

Exemple

Exemple de get_question_configs

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetQuestionConfigsParams = GetQuestionConfigsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 skip: Some(10.0),

6 };

7 let response: GetQuestionConfigs200Response = get_question_configs(&configuration, params).await?;

8 let _cfgs: GetQuestionConfigs200Response = response;

9 Ok(())

10}

11

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de update_question_config

Copy

1

2async fn run_update() -> Result<(), Error> {

3 let params: UpdateQuestionConfigParams = UpdateQuestionConfigParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 id: String::from("news/article-2026-01-12"),

6 update_question_config_body: models::UpdateQuestionConfigBody {

7 question_text: String::from("Did you find this reporting accurate?"),

8 required: Some(true),

9 rendering_type: Some(models::QuestionRenderingType::Inline),

10 options: Some(vec![

11 models::QuestionConfigCustomOptionsInner { id: String::from("opt-yes"), label: String::from("Yes"), value: String::from("yes") },

12 models::QuestionConfigCustomOptionsInner { id: String::from("opt-no"), label: String::from("No"), value: String::from("no") },

13 ]),

14 when_save: Some(models::QuestionWhenSave::OnSubmit),

15 },

16 };

17 let response: FlagCommentPublic200Response = update_question_config(&configuration, params).await?;

18 Ok(())

19}

20

Paramètres

Réponse

Retourne: CreateQuestionResult200Response

Exemple

Exemple de create_question_result

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: CreateQuestionResultParams = CreateQuestionResultParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 create_question_result_body: models::CreateQuestionResultBody {

6 question_id: "feedback-article-2026".to_string(),

7 comment_id: Some("cmt-2026-001".to_string()),

8 user_id: Some("reader-007".to_string()),

9 answer: "yes".to_string(),

10 score: Some(4),

11 metadata: Some(std::collections::HashMap::from([(

12 "path".to_string(),

13 "news/politics/2026-election".to_string(),

14 )])),

15 anonymous: Some(false),

16 submitted_at: Some("2026-01-12T09:15:00Z".to_string()),

17 },

18 };

19

20 let created: CreateQuestionResult200Response = create_question_result(&configuration, params).await?;

21 Ok(())

22}

23

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de delete_question_result

Copy

1

2async fn run_delete() -> Result<(), Error> {

3 let params: DeleteQuestionResultParams = DeleteQuestionResultParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "news/article/12345/question/67890".to_string(),

6 dry_run: Some(false),

7 request_id: Some("req-20260112-7a3b".to_string()),

8 };

9 let response: FlagCommentPublic200Response = delete_question_result(&configuration, params).await?;

10 Ok(())

11}

12

Paramètres

Réponse

Renvoie: GetQuestionResult200Response

Exemple

Exemple get_question_result

Copy

1

2async fn run() -> Result<GetQuestionResult200Response, Error> {

3 let include_metadata: Option<bool> = Some(true);

4 let params: GetQuestionResultParams = GetQuestionResultParams {

5 tenant_id: "acme-corp-tenant".to_string(),

6 id: "news/article/2026/12345".to_string(),

7 };

8 let response: GetQuestionResult200Response = get_question_result(&configuration, params).await?;

9 Ok(response)

10}

11

Paramètres

Réponse

Renvoie : GetQuestionResults200Response

Exemple

Exemple pour get_question_results

Copy

1

2async fn example_get_question_results() -> Result<(), Error> {

3 let params = GetQuestionResultsParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 url_id: Some(String::from("news/article/2026/01/12/breaking")),

6 user_id: Some(String::from("user-98765")),

7 start_date: Some(String::from("2025-12-01")),

8 question_id: Some(String::from("q-42")),

9 question_ids: Some(String::from("q-42,q-43")),

10 skip: Some(10.0),

11 };

12 let results: GetQuestionResults200Response = get_question_results(&configuration, params).await?;

13 Ok(())

14}

15

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de update_question_result

Copy

1

2async fn run() -> Result<(), Error> {

3 let body: models::UpdateQuestionResultBody = models::UpdateQuestionResultBody {

4 question_id: "q-12345".to_string(),

5 result: true,

6 comment: Some("Marked by moderator after review".to_string()),

7 };

8

9 let params: UpdateQuestionResultParams = UpdateQuestionResultParams {

10 tenant_id: "acme-corp-tenant".to_string(),

11 id: "news/article/98765".to_string(),

12 update_question_result_body: body,

13 };

14

15 let response: FlagCommentPublic200Response = update_question_result(&configuration, params).await?;

16 println!("{:#?}", response);

17 Ok(())

18}

19

Paramètres

Réponse

Renvoie: AggregateQuestionResults200Response

Paramètres

Réponse

Renvoie : BulkAggregateQuestionResults200Response

Paramètres

Réponse

Renvoie : CombineCommentsWithQuestionResults200Response

Paramètres

Réponse

Renvoie: AddSsoUserApiResponse

Paramètres

Réponse

Renvoie: DeleteSsoUserApiResponse

Paramètres

Réponse

Renvoie : GetSsoUserByEmailApiResponse

Paramètres

Réponse

Renvoie: GetSsoUserByIdApiResponse

Paramètres

Réponse

Renvoie : GetSsoUsers200Response

Paramètres

Réponse

Renvoie : PatchSsoUserApiResponse

Paramètres

Réponse

Renvoie: PutSsoUserApiResponse

Paramètres

Réponse

Renvoie: CreateSubscriptionApiResponse

Paramètres

Réponse

Retourne: DeleteSubscriptionApiResponse

Paramètres

Réponse

Renvoie: GetSubscriptionsApiResponse

Paramètres

Réponse

Renvoie : GetTenantDailyUsages200Response

Exemple

Exemple de get_tenant_daily_usages

Copy

1

2async fn example() -> Result<GetTenantDailyUsages200Response, Error> {

3 let params: GetTenantDailyUsagesParams = GetTenantDailyUsagesParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 year_number: Some(2024.0),

6 month_number: Some(9.0),

7 day_number: Some(15.0),

8 skip: Some(0.0),

9 };

10 let response: GetTenantDailyUsages200Response = get_tenant_daily_usages(&configuration, params).await?;

11 Ok(response)

12}

13

Paramètres

Réponse

Renvoie : CreateTenantPackage200Response

Exemple

Exemple de create_tenant_package

Copy

1

2async fn run_create_package() -> Result<(), Error> {

3 let params: CreateTenantPackageParams = CreateTenantPackageParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 create_tenant_package_body: models::CreateTenantPackageBody {

6 name: "Acme News Package".to_string(),

7 description: Some("Moderated comments for Acme News articles".to_string()),

8 plan: Some("standard".to_string()),

9 allow_gifs: Some(true),

10 gif_rating: Some(GifRating::GeneralAudience),

11 image_content_profanity_level: Some(ImageContentProfanityLevel::Moderate),

12 sso_security_level: Some(SsoSecurityLevel::Strict),

13 custom_config: Some(CustomConfigParameters {

14 max_comment_length: Some(1000),

15 require_moderation: Some(true),

16 }),

17 },

18 };

19 let response: CreateTenantPackage200Response = create_tenant_package(&configuration, params).await?;

20 let _package: TenantPackage = response.0;

21 Ok(())

22}

23

Paramètres

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de delete_tenant_package

Copy

1

2let params: DeleteTenantPackageParams = DeleteTenantPackageParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 id: "pkg-news-comments-2025-01".to_string(),

5 cascade: Some(true),

6};

7let response: FlagCommentPublic200Response = delete_tenant_package(&configuration, params).await?;

8

Paramètres

Réponse

Renvoie : GetTenantPackage200Response

Exemple

Exemple de get_tenant_package

Copy

1

2async fn example_get_tenant_package(configuration: &configuration::Configuration) -> Result<GetTenantPackage200Response, Error> {

3 let params: GetTenantPackageParams = GetTenantPackageParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "premium-plan".to_string(),

6 include_details: Some(true),

7 };

8 let package: GetTenantPackage200Response = get_tenant_package(configuration, params).await?;

9 Ok(package)

10}

11

Paramètres

Réponse

Retourne : GetTenantPackages200Response

Exemple

Exemple de get_tenant_packages

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetTenantPackagesParams = GetTenantPackagesParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 skip: Some(20.0),

6 };

7 let _packages: GetTenantPackages200Response = get_tenant_packages(&configuration, params).await?;

8 Ok(())

9}

10