FastComments Rust SDK

cargo add fastcomments-sdk

The SDK requires Rust 2021 edition or later.

The FastComments Rust SDK consists of several modules:

• Client Module - Auto-generated API client for FastComments REST APIs

  • Complete type definitions for all API models
  • Both authenticated (DefaultApi) and public (PublicApi) endpoints
  • Full async/await support with tokio
  • See client/README.md for detailed API documentation

• SSO Module - Server-side Single Sign-On utilities

  • Secure token generation for user authentication
  • Support for both simple and secure SSO modes
  • HMAC-SHA256 based token signing

• Core Types - Shared type definitions and utilities

  • Comment models and metadata structures
  • User and tenant configurations
  • Helper functions for common operations

Using the Public API

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

#[tokio::main]
async fn main() {
    // Create API configuration
    let config = Configuration::new();

    // Fetch comments for a 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),
    }
}

Using the Authenticated API

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

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

    // Fetch comments using authenticated API
    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),
    }
}

Using SSO for Authentication

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

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

    // Create secure SSO user data (server-side only!)
    let user_data = SecureSSOUserData::new(
        "user-123".to_string(),           // User ID
        "user@example.com".to_string(),   // Email
        "John Doe".to_string(),            // Username
        "https://example.com/avatar.jpg".to_string(), // Avatar URL
    );

    // Generate SSO token
    let sso = FastCommentsSSO::new_secure(api_key, &user_data).unwrap();
    let token = sso.create_token().unwrap();

    println!("SSO Token: {}", token);
    // Pass this token to your frontend for authentication
}

401 Unauthorized Errors

If you're getting 401 errors when using the authenticated API:

1. Check your API key: Ensure you're using the correct API key from your FastComments dashboard
2. Verify the tenant ID: Make sure the tenant ID matches your account
3. API key format: The API key should be passed in the Configuration:

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

SSO Token Issues

If SSO tokens aren't working:

1. Use secure mode for production: Always use FastCommentsSSO::new_secure() with your API key for production
2. Server-side only: Generate SSO tokens on your server, never expose your API key to clients
3. Check user data: Ensure all required fields (id, email, username) are provided

Async Runtime Errors

The SDK uses tokio for async operations. Make sure to:

1. Add tokio to your dependencies:

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

2. Use the tokio runtime:

   #[tokio::main]
   async fn main() {
    // Your async code here
   }

Broadcast IDs

You'll see you're supposed to pass a broadcastId in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.

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

Parameters

Response

Returns: AggregationResponse

Example

aggregate Example

Copy

1

2let params: AggregateParams = AggregateParams {

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

4 aggregation_request: models::AggregationRequest {

5 query: Some(models::QueryPredicate {

6 field: "resource".to_string(),

7 op: "equals".to_string(),

8 value: models::QueryPredicateValue::String("news/article".to_string()),

9 }),

10 operations: vec![

11 models::AggregationOperation {

12 op_type: models::AggregationOpType::COUNT,

13 field: Some("id".to_string()),

14 alias: Some("comment_count".to_string()),

15 },

16 ],

17 group_by: Some(vec!["author_id".to_string()]),

18 size: Some(50),

19 sort: None,

20 },

21 parent_tenant_id: Some("acme-parent-tenant".to_string()),

22 include_stats: Some(true),

23};

24let aggregation_response: AggregationResponse = aggregate(&configuration, params).await?;

25

Parameters

Response

Returns: GetAuditLogs200Response

Example

get_audit_logs Example

Copy

1

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

3 let params: GetAuditLogsParams = GetAuditLogsParams {

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

5 limit: Some(100.0),

6 skip: Some(0.0),

7 order: Some(models::SortDir::Desc),

8 after: Some(1672531200.0),

9 before: Some(1675209600.0),

10 };

11 let response: GetAuditLogs200Response = get_audit_logs(&configuration, params).await?;

12 Ok(())

13}

14

Parameters

Response

Returns: BlockFromCommentPublic200Response

Example

block_from_comment_public Example

Copy

1

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

3 let params: BlockFromCommentPublicParams = BlockFromCommentPublicParams {

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

5 comment_id: "news/article/2026-03-25-12345".to_string(),

6 public_block_from_comment_params: models::PublicBlockFromCommentParams {

7 reason: "Repeated promotional links".to_string(),

8 reporter_id: Some("reader-2048".to_string()),

9 permanent: Some(false),

10 },

11 sso: Some("sso:user:acme:2048".to_string()),

12 };

13 let response: BlockFromCommentPublic200Response = block_from_comment_public(&configuration, params).await?;

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

15 Ok(())

16}

17

Parameters

Response

Returns: UnBlockCommentPublic200Response

Example

un_block_comment_public Example

Copy

1

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

3 let params: UnBlockCommentPublicParams = UnBlockCommentPublicParams {

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

5 comment_id: "news/article/2026-03-25/comment-98765".to_string(),

6 public_block_from_comment_params: models::PublicBlockFromCommentParams {

7 unblocked_by: "moderator@acme.com".to_string(),

8 reason: "Reviewed and determined not to be spam".to_string(),

9 },

10 sso: Some("sso-session-token-abc123".to_string()),

11 };

12 let response: UnBlockCommentPublic200Response = un_block_comment_public(&configuration, params).await?;

13 Ok(response)

14}

15

Parameters

Response

Returns: CheckedCommentsForBlocked200Response

Example

checked_comments_for_blocked Example

Copy

1

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

3 let params: CheckedCommentsForBlockedParams = CheckedCommentsForBlockedParams {

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

5 comment_ids: "article-98765:12345,article-98765:67890".to_string(),

6 sso: Some("sso-uid-4821".to_string()),

7 };

8 let response: CheckedCommentsForBlocked200Response = checked_comments_for_blocked(&configuration, params).await?;

9 Ok(response)

10}

11

Parameters

Response

Returns: BlockFromCommentPublic200Response

Example

block_user_from_comment Example

Copy

1

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

3 let params: BlockUserFromCommentParams = BlockUserFromCommentParams {

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

5 id: "news/article-2026-03-25/comment-842".to_string(),

6 block_from_comment_params: models::BlockFromCommentParams {

7 reason: Some("Repeated promotional links".to_string()),

8 duration_minutes: Some(7_200),

9 notify_user: Some(true),

10 },

11 user_id: Some("user-9812".to_string()),

12 anon_user_id: None,

13 };

14 let response: BlockFromCommentPublic200Response = block_user_from_comment(&configuration, params).await?;

15 Ok(())

16}

17

Parameters

Response

Returns: CreateCommentPublic200Response

Example

create_comment_public Example

Copy

1

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

3 let params: CreateCommentPublicParams = CreateCommentPublicParams {

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

5 url_id: "news/politics/2026-election-coverage".to_string(),

6 broadcast_id: "live-coverage-2026-03-25".to_string(),

7 comment_data: models::CommentData {

8 content: "Insightful piece — appreciate the depth of reporting.".to_string(),

9 author_name: Some("Jane Doe".to_string()),

10 author_email: Some("jane.doe@acme.com".to_string()),

11 is_anonymous: Some(false),

12 parent_id: None,

13 metadata: None,

14 },

15 session_id: Some("sess_6f7e8d9c".to_string()),

16 sso: Some("sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9".to_string()),

17 };

18 let resp: CreateCommentPublic200Response = create_comment_public(&configuration, params).await?;

19 Ok(())

20}

21

Parameters

Response

Returns: DeleteComment200Response

Example

delete_comment Example

Copy

1

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

3 let params: DeleteCommentParams = DeleteCommentParams {

4 tenant_id: "acme-newsroom".to_string(),

5 id: "news/article-2026/comments/abc123".to_string(),

6 context_user_id: Some("user-789".to_string()),

7 is_live: Some(true),

8 };

9 let response: DeleteComment200Response = delete_comment(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: DeleteCommentPublic200Response

Example

delete_comment_public Example

Copy

1

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

3 let params: DeleteCommentPublicParams = DeleteCommentPublicParams {

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

5 comment_id: String::from("news/article/2026/03/interesting-story#cmt-67890"),

6 broadcast_id: String::from("news-article-12345"),

7 edit_key: Some(String::from("editkey-3f2b9a")),

8 sso: Some(String::from("sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9")),

9 };

10 let response: DeleteCommentPublic200Response = delete_comment_public(&configuration, params).await?;

11 Ok(())

12}

13

Parameters

Response

Returns: DeleteCommentVote200Response

Example

delete_comment_vote Example

Copy

1

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

3 let params: DeleteCommentVoteParams = DeleteCommentVoteParams {

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

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

6 vote_id: "vote-67890".to_string(),

7 url_id: "news/world/article-2026".to_string(),

8 broadcast_id: "broadcast-1".to_string(),

9 edit_key: Some("editkey-abc123".to_string()),

10 sso: Some("sso-token-xyz".to_string()),

11 };

12 let response: DeleteCommentVote200Response = delete_comment_vote(&configuration, params).await?;

13 Ok(())

14}

15

Parameters

Response

Returns: FlagComment200Response

Example

flag_comment Example

Copy

1

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

3 let params: FlagCommentParams = FlagCommentParams {

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

5 id: "comment-20260325-842".to_string(),

6 user_id: Some("user-7b2f3d".to_string()),

7 anon_user_id: Some("anon-1a2b3c".to_string()),

8 };

9 let resp: FlagComment200Response = flag_comment(&configuration, params).await?;

10 Ok(resp)

11}

12

Parameters

Response

Returns: GetComment200Response

Example

get_comment Example

Copy

1

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

3 let params: GetCommentParams = GetCommentParams {

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

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

6 };

7 let _response: GetComment200Response = get_comment(&configuration, params).await?;

8 Ok(())

9}

10

Parameters

Response

Returns: GetCommentText200Response

Example

get_comment_text Example

Copy

1

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

3 let params: GetCommentTextParams = GetCommentTextParams {

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

5 comment_id: "news/article-2026-03-25-98765".to_string(),

6 edit_key: Some("edit_4f3d2b9a".to_string()),

7 sso: Some("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9".to_string()),

8 };

9 let comment: GetCommentText200Response = get_comment_text(&configuration, params).await?;

10 Ok(comment)

11}

12

Parameters

Response

Returns: GetCommentVoteUserNames200Response

Example

get_comment_vote_user_names Example

Copy

1

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

3 let params: GetCommentVoteUserNamesParams = GetCommentVoteUserNamesParams {

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

5 comment_id: String::from("news/article-12345/comment-6789"),

6 dir: 1,

7 sso: Some(String::from("sso-token-01a2b3")),

8 };

9 let response: GetCommentVoteUserNames200Response =

10 get_comment_vote_user_names(&configuration, params).await?;

11 Ok(response)

12}

13

Parameters

Response

Returns: GetComments200Response

Example

get_comments Example

Copy

1

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

3 let params: GetCommentsParams = GetCommentsParams {

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

5 page: Some(1),

6 limit: Some(25),

7 skip: Some(0),

8 as_tree: Some(true),

9 skip_children: Some(0),

10 limit_children: Some(5),

11 max_tree_depth: Some(3),

12 url_id: Some("news/article/technology/ai-ethics".to_string()),

13 user_id: Some("user_98765".to_string()),

14 anon_user_id: Some("anon_abc123".to_string()),

15 context_user_id: Some("moderator_12".to_string()),

16 hash_tag: Some("aiethics".to_string()),

17 parent_id: Some("comment_456".to_string()),

18 direction: None,

19 };

20 let comments: GetComments200Response = get_comments(&configuration, params).await?;

21 Ok(())

22}

23

req tenantId urlId

Parameters

Response

Returns: GetCommentsPublic200Response

Example

get_comments_public Example

Copy

1

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

3 let params: GetCommentsPublicParams = GetCommentsPublicParams {

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

5 url_id: "news/article/2026/03/25/top-story".to_string(),

6 page: Some(1), direction: Some(models::SortDirections::Desc),

7 sso: None, skip: Some(0), skip_children: Some(0),

8 limit: Some(50), limit_children: Some(10), count_children: Some(true),

9 fetch_page_for_comment_id: None, include_config: Some(true), count_all: Some(false),

10 includei10n: Some(false), locale: Some("en-US".to_string()), modules: None,

11 is_crawler: Some(false), include_notification_count: Some(false), as_tree: Some(true),

12 max_tree_depth: Some(3), use_full_translation_ids: Some(false), parent_id: None,

13 search_text: Some("climate policy debate".to_string()), hash_tags: Some(vec!["breaking".to_string(), "policy".to_string()]),

14 user_id: None, custom_config_str: None, after_comment_id: None, before_comment_id: None,

15 };

16 let response: GetCommentsPublic200Response = get_comments_public(configuration, params).await?;

17 Ok(response)

18}

19

Parameters

Response

Returns: LockComment200Response

Example

lock_comment Example

Copy

1

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

3 let params: LockCommentParams = LockCommentParams {

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

5 comment_id: String::from("cmt-20260325-789"),

6 broadcast_id: String::from("live/politics-debate-2026-03-25"),

7 sso: Some(String::from("sso-user-0a1b2c3d4e")),

8 };

9 let response: LockComment200Response = lock_comment(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

Response

Returns: PinComment200Response

Example

pin_comment Example

Copy

1

2let params: PinCommentParams = PinCommentParams {

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

4 comment_id: "cmt-987654321".to_string(),

5 broadcast_id: "news/article/2026-03-25".to_string(),

6 sso: Some("user-12345-ssotoken".to_string()),

7};

8let response: PinComment200Response = pin_comment(&configuration, params).await?;

9

Parameters

Response

Returns: SaveComment200Response

Example

save_comment Example

Copy

1

2let create_comment: models::CreateCommentParams = models::CreateCommentParams {

3 thread_key: "news/article/2026/03/25/budget-reform".to_string(),

4 body: "Great breakdown of the proposed changes — very informative and balanced.".to_string(),

5 user_name: Some("Jane Doe".to_string()),

6 user_email: Some("jane.doe@acme-corp.com".to_string()),

7 user_id: Some("user-9876".to_string()),

8 parent_id: None,

9};

10

11let save_params: SaveCommentParams = SaveCommentParams {

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

13 create_comment_params: create_comment,

14 is_live: Some(true),

15 do_spam_check: Some(true),

16 send_emails: Some(false),

17 populate_notifications: Some(true),

18};

19

20let saved: SaveComment200Response = save_comment(&configuration, save_params).await?;

21

Parameters

Response

Returns: Vec<models::SaveComment200Response>

Example

save_comments_bulk Example

Copy

1

2let params: SaveCommentsBulkParams = SaveCommentsBulkParams {

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

4 create_comment_params: vec![

5 models::CreateCommentParams {

6 thread_id: "news/article-2026-election".to_string(),

7 text: "Insightful reporting — thanks for the coverage!".to_string(),

8 author_name: "Jane Doe".to_string(),

9 author_email: "jane.doe@example.com".to_string(),

10 },

11 models::CreateCommentParams {

12 thread_id: "news/article-2026-election".to_string(),

13 text: "I disagree with the premise of this piece.".to_string(),

14 author_name: "John Smith".to_string(),

15 author_email: "john.smith@example.org".to_string(),

16 },

17 ],

18 is_live: Some(true),

19 do_spam_check: Some(true),

20 send_emails: Some(false),

21 populate_notifications: Some(true),

22};

23let saved: Vec<models::SaveComment200Response> = save_comments_bulk(&configuration, params).await?;

24

Parameters

Response

Returns: SetCommentText200Response

Example

set_comment_text Example

Copy

1

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

3 let params: SetCommentTextParams = SetCommentTextParams {

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

5 comment_id: "news/article/2026-03-25/comment-6789".to_string(),

6 broadcast_id: "comments-broadcast-main".to_string(),

7 comment_text_update_request: models::CommentTextUpdateRequest {

8 text: "Updated comment: thank you @jane_doe — here's an update about #rustlang".to_string(),

9 ..Default::default()

10 },

11 edit_key: Some("editkey-9f8e7d6c".to_string()),

12 sso: Some("sso-token-abc123".to_string()),

13 };

14 let result: SetCommentText200Response = set_comment_text(configuration, params).await?;

15 println!("set_comment_text result: {:?}", result);

16 Ok(())

17}

18

Parameters

Response

Returns: UnBlockCommentPublic200Response

Example

un_block_user_from_comment Example

Copy

1

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

3 let unblock_body: models::UnBlockFromCommentParams = models::UnBlockFromCommentParams {

4 reason: Some(String::from("False positive - reviewed by moderator")),

5 moderator_id: Some(String::from("moderator-42")),

6 };

7 let params: UnBlockUserFromCommentParams = UnBlockUserFromCommentParams {

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

9 id: String::from("news/article/comments/abc123"),

10 un_block_from_comment_params: unblock_body,

11 user_id: Some(String::from("user-9876")),

12 anon_user_id: Some(String::from("anon-5f4d")),

13 };

14 let result: UnBlockCommentPublic200Response = un_block_user_from_comment(&configuration, params).await?;

15 Ok(result)

16}

17

Parameters

Response

Returns: FlagComment200Response

Example

un_flag_comment Example

Copy

1

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

3 let params = UnFlagCommentParams {

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

5 id: String::from("news/article/comment-12345"),

6 user_id: Some(String::from("reader-987")),

7 anon_user_id: None,

8 };

9 let response: FlagComment200Response = un_flag_comment(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: LockComment200Response

Example

un_lock_comment Example

Copy

1

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

3 let params: UnLockCommentParams = UnLockCommentParams {

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

5 comment_id: "cmt-987654321".to_string(),

6 broadcast_id: "news/world-update-2026-04-25".to_string(),

7 sso: Some("sso-token-abcdef123456".to_string()),

8 };

9 let response: LockComment200Response = un_lock_comment(&configuration, params).await?;

10 let _ = response;

11 Ok(())

12}

13

Parameters

Response

Returns: PinComment200Response

Example

un_pin_comment Example

Copy

1

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

3 let params: UnPinCommentParams = UnPinCommentParams {

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

5 comment_id: "cmt-20260325-7a9".to_string(),

6 broadcast_id: "news/homepage/launch-article".to_string(),

7 sso: Some("sso-jwt-user-0a1b2c3d".to_string()),

8 };

9 let response: PinComment200Response = un_pin_comment(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

Response

Returns: FlagCommentPublic200Response

Example

update_comment Example

Copy

1

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

3 let tenant_id: String = "acme-corp-tenant".into();

4 let comment_id: String = "news/article/12345-6789".into();

5 let context_user_id: String = "reader-42".into();

6

7 let updatable: models::UpdatableCommentParams = models::UpdatableCommentParams {

8 body: Some("Updated comment: I appreciate the clarification on this report.".into()),

9 is_edited: Some(true),

10 tags: Some(vec!["clarification".into(), "follow-up".into()]),

11 };

12

13 let params: UpdateCommentParams = UpdateCommentParams {

14 tenant_id,

15 id: comment_id,

16 updatable_comment_params: updatable,

17 context_user_id: Some(context_user_id),

18 do_spam_check: Some(true),

19 is_live: Some(false),

20 };

21

22 let response: FlagCommentPublic200Response = update_comment(&configuration, params).await?;

23 Ok(())

24}

25

Parameters

Response

Returns: VoteComment200Response

Example

vote_comment Example

Copy

1

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

3 let params: VoteCommentParams = VoteCommentParams {

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

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

6 url_id: "news/politics/2026-election".to_string(),

7 broadcast_id: "broadcast-nytimes-001".to_string(),

8 vote_body_params: models::VoteBodyParams { ..Default::default() },

9 session_id: Some("sess-9f8e7d".to_string()),

10 sso: Some("user-42@example.com".to_string()),

11 };

12 let response: VoteComment200Response = vote_comment(&configuration, params).await?;

13 Ok(())

14}

15

Parameters

Response

Returns: AddDomainConfig200Response

Example

add_domain_config Example

Copy

1

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

3 let params: AddDomainConfigParams = AddDomainConfigParams {

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

5 add_domain_config_params: models::AddDomainConfigParams {

6 domain: "comments.acme.com".to_string(),

7 path: Some("/news/article".to_string()),

8 enable_cors: Some(true),

9 allowed_origins: Some(vec![

10 "https://acme.com".to_string(),

11 "https://www.acme.com".to_string()

12 ]),

13 sso_required: Some(false),

14 },

15 };

16 let response: AddDomainConfig200Response = add_domain_config(&configuration, params).await?;

17 Ok(response)

18}

19

Parameters

Response

Returns: DeleteDomainConfig200Response

Example

delete_domain_config Example

Copy

1

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

3 let params: DeleteDomainConfigParams = DeleteDomainConfigParams {

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

5 domain: "news/acme".to_string(),

6 site_id: Some("main-site".to_string()),

7 };

8 let response: DeleteDomainConfig200Response = delete_domain_config(&configuration, params).await?;

9 Ok(response)

10}

11

Parameters

Response

Returns: GetDomainConfig200Response

Example

get_domain_config Example

Copy

1

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

3 let params: GetDomainConfigParams = GetDomainConfigParams {

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

5 domain: String::from("news/world"),

6 include_subdomains: Some(true),

7 };

8 let config_response: GetDomainConfig200Response = get_domain_config(&configuration, params).await?;

9 Ok(config_response)

10}

11

Parameters

Response

Returns: GetDomainConfigs200Response

Example

get_domain_configs Example

Copy

1

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

3 let tenant_id_option: Option<String> = Some("acme-corp-tenant".to_string());

4 let tenant_id: String = tenant_id_option.expect("tenant id required");

5 let params: GetDomainConfigsParams = GetDomainConfigsParams { tenant_id };

6 let response: GetDomainConfigs200Response = get_domain_configs(&configuration, params).await?;

7 Ok(response)

8}

9

Parameters

Response

Returns: GetDomainConfig200Response

Example

patch_domain_config Example

Copy

1

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

3 let params: PatchDomainConfigParams = PatchDomainConfigParams {

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

5 domain_to_update: "blog.acme.com".to_string(),

6 patch_domain_config_params: models::PatchDomainConfigParams {

7 moderation_enabled: Some(true),

8 allowed_origins: Some(vec!["https://blog.acme.com".to_string()]),

9 custom_css: Some(".fc-comment{font-size:14px}".to_string()),

10 notify_on_new_comment: Some(true),

11 ..Default::default()

12 },

13 };

14 let resp: GetDomainConfig200Response = patch_domain_config(&configuration, params).await?;

15 println!("{:#?}", resp);

16 Ok(())

17}

18

Parameters

Response

Returns: GetDomainConfig200Response

Example

put_domain_config Example

Copy

1

2let cfg: &configuration::Configuration = &configuration;

3let params: PutDomainConfigParams = PutDomainConfigParams {

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

5 domain_to_update: "news/article".to_string(),

6 update_domain_config_params: models::UpdateDomainConfigParams {

7 allow_comments: Some(true),

8 moderation_required: Some(true),

9 allowed_origins: Some(vec![

10 "https://www.acme.com".to_string(),

11 "https://news.acme.com".to_string(),

12 ]),

13 custom_css_url: Some("https://cdn.acme.com/styles/comments.css".to_string()),

14 default_moderation: Some("pre".to_string()),

15 },

16};

17let response: GetDomainConfig200Response = put_domain_config(cfg, params).await?;

18

Parameters

Response

Returns: CreateEmailTemplate200Response

Example

create_email_template Example

Copy

1

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

3 let params: CreateEmailTemplateParams = CreateEmailTemplateParams {

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

5 create_email_template_body: models::CreateEmailTemplateBody {

6 name: "Article Comment Notification".into(),

7 subject: "New comment on your article".into(),

8 body_html: "<p>Hi {{recipient_name}},</p><p>{{comment_author}} left a comment on your article \"{{article_title}}\".</p>".into(),

9 from_name: Some("Acme News".into()),

10 from_email: Some("notifications@acme.example".into()),

11 reply_to: Some("no-reply@acme.example".into()),

12 enabled: Some(true),

13 tags: Some(vec!["comments".into(), "notifications".into()]),

14 },

15 };

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

17 Ok(())

18}

19

Parameters

Response

Returns: FlagCommentPublic200Response

Example

delete_email_template Example

Copy

1

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

3 let params: DeleteEmailTemplateParams = DeleteEmailTemplateParams {

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

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

6 };

7 let confirm_deletion: Option<bool> = Some(true);

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

9 Ok(())

10}

11

Parameters

Response

Returns: FlagCommentPublic200Response

Example

delete_email_template_render_error Example

Copy

1

2let error_id_opt: Option<String> = Some("render-failure-9f3b".to_string());

3let params: DeleteEmailTemplateRenderErrorParams = DeleteEmailTemplateRenderErrorParams {

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

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

6 error_id: error_id_opt.unwrap(),

7};

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

9

Parameters

Response

Returns: GetEmailTemplate200Response

Example

get_email_template Example

Copy

1

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

3 let tenant_id: String = "acme-corp-tenant".to_string();

4 let template_id: String = "welcome-new-subscriber".to_string();

5 let params: GetEmailTemplateParams = GetEmailTemplateParams {

6 tenant_id,

7 id: template_id,

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

9 };

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

11 let _ = template;

12 Ok(())

13}

14

Parameters

Response

Returns: GetEmailTemplateDefinitions200Response

Example

get_email_template_definitions Example

Copy

1

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

3 let params: GetEmailTemplateDefinitionsParams = GetEmailTemplateDefinitionsParams {

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

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

6 include_inactive: Some(false),

7 };

8 let templates: GetEmailTemplateDefinitions200Response =

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

10 Ok(())

11}

12

Parameters

Response

Returns: GetEmailTemplateRenderErrors200Response

Example

get_email_template_render_errors Example

Copy

1

2async fn run_example() -> 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

Parameters

Response

Returns: GetEmailTemplates200Response

Example

get_email_templates Example

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

6 };

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

8 Ok(templates)

9}

10

Parameters

Response

Returns: RenderEmailTemplate200Response

Example

render_email_template Example

Copy

1

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

3 let body = models::RenderEmailTemplateBody {

4 template_key: "welcome_email".to_string(),

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

6 from_address: "noreply@acme.com".to_string(),

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

8 ("user_name".to_string(), "Jane Doe".to_string()),

9 ("article_title".to_string(), "Breaking News: Rust Adoption Soars".to_string()),

10 ]),

11 };

12 let params = RenderEmailTemplateParams {

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

14 render_email_template_body: body,

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

16 };

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

18 Ok(rendered)

19}

20

Parameters

Response

Returns: FlagCommentPublic200Response

Example

update_email_template Example

Copy

1

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

3 let params: UpdateEmailTemplateParams = UpdateEmailTemplateParams {

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

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

6 update_email_template_body: models::UpdateEmailTemplateBody {

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

8 html_body: "<h1>Welcome, {{user_name}}</h1><p>Thanks for joining Acme.</p>".to_string(),

9 plain_body: Some("Welcome, {{user_name}}!\nThanks for joining Acme.".to_string()),

10 enabled: Some(true),

11 from_name: Some("Acme Support <support@acme.com>".to_string()),

12 },

13 };

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

15 Ok(response)

16}

17

req tenantId urlId userIdWS

Parameters

Response

Returns: GetEventLog200Response

Example

get_event_log Example

Copy

1

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

3 let params: GetEventLogParams = GetEventLogParams {

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

5 url_id: "news/article-2023-01-01".to_string(),

6 user_id_ws: "user-12345-ws".to_string(),

7 start_time: 1672531200i64,

8 end_time: 1672617599i64,

9 include_details: Some(true),

10 };

11 let response: GetEventLog200Response = get_event_log(&configuration, params).await?;

12 Ok(())

13}

14

req tenantId urlId userIdWS

Parameters

Response

Returns: GetEventLog200Response

Example

get_global_event_log Example

Copy

1

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

3 let include_deleted: Option<bool> = Some(false);

4 let params: GetGlobalEventLogParams = GetGlobalEventLogParams {

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

6 url_id: "news/article-123".to_string(),

7 user_id_ws: "user-789-ws".to_string(),

8 start_time: 1711411200i64,

9 end_time: 1711497599i64,

10 };

11 let response: GetEventLog200Response = get_global_event_log(&configuration, params).await?;

12 let _include_deleted = include_deleted;

13 Ok(())

14}

15

Parameters

Response

Returns: CreateFeedPost200Response

Example

create_feed_post Example

Copy

1

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

3 let params = CreateFeedPostParams {

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

5 create_feed_post_params: models::CreateFeedPostParams {

6 title: Some("Downtown Datacenter Outage".to_string()),

7 body: Some("Investigating a partial outage affecting login and API endpoints.".to_string()),

8 author_id: Some("ops-team".to_string()),

9 ..Default::default()

10 },

11 broadcast_id: Some("status-broadcast-2026-03-25".to_string()),

12 is_live: Some(true),

13 do_spam_check: Some(true),

14 skip_dup_check: Some(false),

15 };

16 let response: CreateFeedPost200Response = create_feed_post(&configuration, params).await?;

17 Ok(response)

18}

19

Parameters

Response

Returns: CreateFeedPostPublic200Response

Example

create_feed_post_public Example

Copy

1

2let create_feed_post_params: models::CreateFeedPostParams = models::CreateFeedPostParams {

3 title: "Acme Product Launch".to_string(),

4 body: "We're excited to announce our new product line that will change the way teams collaborate.".to_string(),

5 slug: "news/product-launch".to_string(),

6 links: Some(vec![models::FeedPostLink { url: "https://acme.com/launch".to_string(), title: Some("Launch details".to_string()) }]),

7 media: Some(vec![models::FeedPostMediaItem { assets: Some(vec![models::FeedPostMediaItemAsset { url: "https://cdn.acme.com/images/launch.jpg".to_string(), mime_type: Some("image/jpeg".to_string()) }]), caption: Some("Hero image".to_string()) }]),

8 tags: Some(vec!["announcement".to_string(), "product".to_string()]),

9};

10

11let params: CreateFeedPostPublicParams = CreateFeedPostPublicParams {

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

13 create_feed_post_params,

14 broadcast_id: Some("broadcast-2026-03-25".to_string()),

15 sso: Some("sso-token-xyz789".to_string()),

16};

17

18let response: CreateFeedPostPublic200Response = create_feed_post_public(&configuration, params).await?;

19

Parameters

Response

Returns: DeleteFeedPostPublic200Response

Example

delete_feed_post_public Example

Copy

1

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

3 let params: DeleteFeedPostPublicParams = DeleteFeedPostPublicParams {

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

5 post_id: "news/article-2026-03-25-12345".to_string(),

6 broadcast_id: Some("broadcast-9876".to_string()),

7 sso: Some("user-42-sso-token".to_string()),

8 };

9 let response: DeleteFeedPostPublic200Response = delete_feed_post_public(&configuration, params).await?;

10 Ok(())

11}

12

req tenantId afterId

Parameters

Response

Returns: GetFeedPosts200Response

Example

get_feed_posts Example

Copy

1

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

3 let params: GetFeedPostsParams = GetFeedPostsParams {

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

5 after_id: Some("post_98765".to_string()),

6 limit: Some(20),

7 tags: Some(vec!["news".to_string(), "technology".to_string()]),

8 };

9 let feed: GetFeedPosts200Response = get_feed_posts(&configuration, params).await?;

10 Ok(())

11}

12

req tenantId afterId

Parameters

Response

Returns: GetFeedPostsPublic200Response

Example

get_feed_posts_public Example

Copy

1

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

3 let params: GetFeedPostsPublicParams = GetFeedPostsPublicParams {

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

5 after_id: Some("post_987654".to_string()),

6 limit: Some(25),

7 tags: Some(vec!["news".to_string(), "technology".to_string()]),

8 sso: Some("sso-token-abc123".to_string()),

9 is_crawler: Some(false),

10 include_user_info: Some(true),

11 };

12 let response: GetFeedPostsPublic200Response = get_feed_posts_public(&configuration, params).await?;

13 Ok(response)

14}

15

Parameters

Response

Returns: GetFeedPostsStats200Response

Example

get_feed_posts_stats Example

Copy

1

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

3 let params: GetFeedPostsStatsParams = GetFeedPostsStatsParams {

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

5 post_ids: vec![

6 "news/article/2026/03/25/product-launch".to_string(),

7 "blog/product-updates/q1-2026".to_string(),

8 ],

9 sso: Some("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.examplepayload.signature".to_string()),

10 };

11 let stats: GetFeedPostsStats200Response = get_feed_posts_stats(&configuration, params).await?;

12 Ok(())

13}

14

Parameters

Response

Returns: GetUserReactsPublic200Response

Example

get_user_reacts_public Example

Copy

1

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

3 let params: GetUserReactsPublicParams = GetUserReactsPublicParams {

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

5 post_ids: Some(vec![

6 "news/article-123".to_string(),

7 "blog/post-456".to_string(),

8 ]),

9 sso: Some("john.doe@acme.com".to_string()),

10 };

11 let response: GetUserReactsPublic200Response = get_user_reacts_public(&configuration, params).await?;

12 Ok(response)

13}

14

Parameters

Response

Returns: ReactFeedPostPublic200Response

Example

react_feed_post_public Example

Copy

1

2let params: ReactFeedPostPublicParams = ReactFeedPostPublicParams {

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

4 post_id: "news/world/2026-election".to_string(),

5 react_body_params: models::ReactBodyParams { reaction: "like".to_string() },

6 is_undo: Some(false),

7 broadcast_id: Some("broadcast-2026-03-25".to_string()),

8 sso: Some("sso-token-6f4e2b".to_string()),

9};

10

11let response: ReactFeedPostPublic200Response = react_feed_post_public(&configuration, params).await?;

12

Parameters

Response

Returns: FlagCommentPublic200Response

Example

update_feed_post Example

Copy

1

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

3 let params: UpdateFeedPostParams = UpdateFeedPostParams {

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

5 id: "news/rocket-launch-2026".to_string(),

6 feed_post: models::FeedPost {

7 title: Some("Rocket Launch Successful".to_string()),

8 body: Some("Acme Rockets launched the Atlas X at 10:00 UTC with no anomalies.".to_string()),

9 author: Some("Acme Newsroom".to_string()),

10 media: Some(vec![

11 models::FeedPostMediaItem {

12 url: Some("https://cdn.acme.com/images/launch.jpg".to_string()),

13 caption: Some("Moments before liftoff".to_string()),

14 asset: None

15 }

16 ]),

17 links: Some(vec![

18 models::FeedPostLink {

19 title: Some("Detailed Coverage".to_string()),

20 url: Some("https://news.acme.com/coverage/atlas-x-launch".to_string())

21 }

22 ]),

23 published: Some(true)

24 }

25 };

26 let response: FlagCommentPublic200Response = update_feed_post(&configuration, params).await?;

27 Ok(())

28}

29

Parameters

Response

Returns: CreateFeedPostPublic200Response

Example

update_feed_post_public Example

Copy

1

2let params: UpdateFeedPostPublicParams = UpdateFeedPostPublicParams {

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

4 post_id: "news/article-2026-03-25".to_string(),

5 update_feed_post_params: models::UpdateFeedPostParams {

6 title: "Acme Widget Launch".to_string(),

7 body: "Acme today launched the next-generation Widget with improved performance and battery life.".to_string(),

8 tags: vec!["product".to_string(), "launch".to_string()],

9 media: vec![

10 models::FeedPostMediaItem {

11 url: "https://cdn.acme.com/images/widget-launch.jpg".to_string(),

12 asset: Some(models::FeedPostMediaItemAsset {

13 mime_type: "image/jpeg".to_string(),

14 size: Some(142000),

15 }),

16 }

17 ],

18 links: vec![

19 models::FeedPostLink {

20 url: "https://acme.com/blog/widget-launch".to_string(),

21 title: Some("Read the full announcement".to_string()),

22 }

23 ],

24 },

25 broadcast_id: Some("broadcast-2026-03".to_string()),

26 sso: Some("sso-token-9f8e7d".to_string()),

27};

28

29let response: CreateFeedPostPublic200Response = update_feed_post_public(configuration, params).await?;

30

Parameters

Response

Returns: FlagCommentPublic200Response

Example

flag_comment_public Example

Copy

1

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

3 let params: FlagCommentPublicParams = FlagCommentPublicParams {

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

5 comment_id: "news/article-2026-03-25-8a7b6c".to_string(),

6 is_flagged: true,

7 sso: Some("sso-token-user-123".to_string()),

8 };

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

10 Ok(response)

11}

12

Parameters

Response

Returns: AddHashTag200Response

Example

add_hash_tag Example

Copy

1

2let params: AddHashTagParams = AddHashTagParams {

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

4 create_hash_tag_body: Some(models::CreateHashTagBody {

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

6 display_name: Some("Breaking News".to_string()),

7 description: Some("Articles covering breaking news events".to_string()),

8 enabled: Some(true),

9 }),

10};

11

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

13

Parameters

Response

Returns: AddHashTagsBulk200Response

Example

add_hash_tags_bulk Example

Copy

1

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

3 let body = BulkCreateHashTagsBody {

4 tags: vec![

5 BulkCreateHashTagsBodyTagsInner {

6 tag: "news/article".to_string(),

7 path: "site/news".to_string(),

8 description: Some("Articles and press releases".to_string()),

9 is_active: Some(true),

10 custom_config: Some(CustomConfigParameters { score: Some(0.85) }),

11 },

12 BulkCreateHashTagsBodyTagsInner {

13 tag: "product/launch".to_string(),

14 path: "site/products".to_string(),

15 description: Some("New product launches".to_string()),

16 is_active: Some(true),

17 custom_config: Some(CustomConfigParameters { score: Some(0.95) }),

18 },

19 ],

20 };

21 let params: AddHashTagsBulkParams = AddHashTagsBulkParams {

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

23 bulk_create_hash_tags_body: Some(body),

24 };

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

26 Ok(())

27}

28

Parameters

Response

Returns: FlagCommentPublic200Response

Example

delete_hash_tag Example

Copy

1

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

3 let params = DeleteHashTagParams {

4 tag: "news/world-climate".to_owned(),

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

6 delete_hash_tag_request: None,

7 };

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

9 Ok(response)

10}

11

Parameters

Response

Returns: GetHashTags200Response

Example

get_hash_tags Example

Copy

1

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

3 let params: GetHashTagsParams = GetHashTagsParams {

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

5 page: Some(1.0),

6 };

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

8 Ok(response)

9}

10

Parameters