FastComments Rust SDK

cargo add fastcomments-sdk

SDK изисква Rust от изданието 2021 или по-ново.

FastComments Rust SDK се състои от няколко модула:

• Клиентски модул - Автоматично генериран API клиент за FastComments REST API-та

  • Пълни дефиниции на типовете за всички API модели
  • Както автентикирани (DefaultApi), така и публични (PublicApi) крайни точки
  • Пълна поддръжка на async/await с tokio
  • Вижте client/README.md за подробна документация на API-то

• SSO модул - Сървърни помощни средства за Single Sign-On

  • Сигурно генериране на токени за удостоверяване на потребители
  • Поддръжка както на прост, така и на защитен режим на SSO
  • Подписване на токени, базирано на HMAC-SHA256

• Основни типове - Споделени дефиниции на типове и помощни средства

  • Модели за коментари и структури за метаданни
  • Конфигурации на потребители и наематели
  • Помощни функции за често срещани операции

Използване на публичното API

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

#[tokio::main]
async fn main() {
    // Създаване на конфигурация за API
    let config = Configuration::new();

    // Извличане на коментари за страница
    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),
    }
}

Използване на удостовереното API

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

#[tokio::main]
async fn main() {
    // Създаване на конфигурация с API ключ
    let mut config = Configuration::new();
    config.api_key = Some(ApiKey {
        prefix: None,
        key: "your-api-key".to_string(),
    });

    // Извличане на коментари чрез удостоверено 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),
    }
}

Използване на SSO за удостоверяване

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

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

    // Създаване на защитени SSO данни за потребителя (само от страна на сървъра!)
    let user_data = SecureSSOUserData::new(
        "user-123".to_string(),           // Идентификатор на потребителя
        "user@example.com".to_string(),   // Имейл
        "John Doe".to_string(),            // Потребителско име
        "https://example.com/avatar.jpg".to_string(), // URL на аватара
    );

    // Генериране на SSO токен
    let sso = FastCommentsSSO::new_secure(api_key, &user_data).unwrap();
    let token = sso.create_token().unwrap();

    println!("SSO Token: {}", token);
    // Предайте този токен на фронтенда си за удостоверяване
}

401 Unauthorized грешки

Ако получавате грешки 401 при използване на автентикирано API:

1. Проверете вашия API ключ: Уверете се, че използвате правилния API ключ от таблото за управление на FastComments
2. Потвърдете tenant ID: Уверете се, че tenant ID съответства на вашия акаунт
3. Формат на API ключа: API ключът трябва да бъде подаден в Configuration:

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

Проблеми със SSO токените

Ако SSO токените не работят:

1. Използвайте сигурен режим за продукция: Винаги използвайте FastCommentsSSO::new_secure() с вашия API ключ в продукционна среда
2. Само от страна на сървъра: Генерирайте SSO токени на вашия сървър, никога не излагайте вашия API ключ на клиентите
3. Проверете данните на потребителя: Уверете се, че всички задължителни полета (id, email, username) са предоставени

Грешки на асинхронния runtime

SDK използва tokio за асинхронни операции. Уверете се, че:

1. Add tokio to your dependencies:

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

2. Use the tokio runtime:

   #[tokio::main]
   async fn main() {
    // Вашият асинхронен код тук
   }

Идентификатори за излъчване

Ще видите, че трябва да подадете broadcastId в някои API извиквания. Когато получавате събития, ще получите този идентификатор обратно, така че да знаете да игнорирате събитието, ако възнамерявате да приложите промените оптимистично на клиента (което вероятно ще искате да направите, тъй като това предлага най-доброто преживяване). Подайте тук UUID. Идентификаторът трябва да е достатъчно уникален, за да не се появява два пъти в рамките на една сесия на браузъра.

Агрегира документи чрез групиране (ако е предоставен groupBy) и прилагане на множество операции. Поддържат се различни операции (напр. sum, countDistinct, avg и т.н.).

Параметри

Отговор

Връща: AggregationResponse

Параметри

Отговор

Връща: GetAuditLogs200Response

Пример

Пример за get_audit_logs

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

Параметри

Отговор

Връща: BlockFromCommentPublic200Response

Пример

block_from_comment_public Пример

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

Параметри

Отговор

Връща: UnBlockCommentPublic200Response

Пример

un_block_comment_public Пример

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

Параметри

Отговор

Връща: CheckedCommentsForBlocked200Response

Пример

Пример за checked_comments_for_blocked

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

Параметри

Отговор

Връща: BlockFromCommentPublic200Response

Пример

Пример за block_user_from_comment

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

Параметри

Отговор

Връща: CreateCommentPublic200Response

Пример

Пример за create_comment_public

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

Параметри

Отговор

Връща: DeleteComment200Response

Пример

Пример за delete_comment

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

Параметри

Отговор

Връща: DeleteCommentPublic200Response

Пример

Пример за delete_comment_public

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

Параметри

Отговор

Връща: DeleteCommentVote200Response

Пример

Пример за delete_comment_vote

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

Параметри

Отговор

Връща: FlagComment200Response

Пример

Пример за flag_comment

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

Параметри

Връща

Връща: GetComment200Response

Пример

get_comment Пример

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

Параметри

Отговор

Връща: GetCommentText200Response

Пример

Пример за get_comment_text

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

Параметри

Отговор

Връща: GetCommentVoteUserNames200Response

Пример

get_comment_vote_user_names Пример

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

Параметри

Отговор

Връща: GetComments200Response

Пример

get_comments Пример

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

Параметри

Отговор

Връща: GetCommentsPublic200Response

Пример

Пример get_comments_public

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

Параметри

Отговор

Връща: LockComment200Response

Пример

Пример за lock_comment

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

Параметри

Отговор

Връща: PinComment200Response

Пример

Пример за pin_comment

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

Параметри

Отговор

Връща: SaveComment200Response

Пример

Пример за save_comment

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

Параметри

Отговор

Връща: Vec<models::SaveComment200Response>

Пример

Пример за save_comments_bulk

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

Параметри

Отговор

Връща: SetCommentText200Response

Пример

Пример на set_comment_text

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

Параметри

Отговор

Връща: UnBlockCommentPublic200Response

Пример

un_block_user_from_comment Пример

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

Параметри

Отговор

Връща: FlagComment200Response

Пример

un_flag_comment Пример

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

Параметри

Отговор

Връща: LockComment200Response

Пример

un_lock_comment Пример

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

Параметри

Отговор

Връща: PinComment200Response

Пример

Пример за un_pin_comment

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

update_comment Пример

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

Параметри

Отговор

Връща: VoteComment200Response

Пример

Пример на vote_comment

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

Параметри

Отговор

Връща: AddDomainConfig200Response

Параметри

Отговор

Връща: DeleteDomainConfig200Response

Параметри

Отговор

Връща: GetDomainConfig200Response

Параметри

Отговор

Връща: GetDomainConfigs200Response

Параметри

Отговор

Връща: GetDomainConfig200Response

Параметри

Отговор

Връща: GetDomainConfig200Response

Параметри

Отговор

Връща: CreateEmailTemplate200Response

Пример

Пример за create_email_template

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за delete_email_template

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

delete_email_template_render_error Пример

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

Параметри

Отговор

Връща: GetEmailTemplate200Response

Пример

get_email_template Пример

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

Отговор

Връща: GetEmailTemplateDefinitions200Response

Пример

Пример за get_email_template_definitions

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

Връща: GetEmailTemplateRenderErrors200Response

Example

Пример за get_email_template_render_errors

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

Параметри

Отговор

Връща: GetEmailTemplates200Response

Пример

Пример за 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(10.0),

6 };

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

8 Ok(templates)

9}

10

Параметри

Отговор

Връща: RenderEmailTemplate200Response

Пример

Пример за render_email_template

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

update_email_template Пример

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

Параметри

Отговор

Връща: GetEventLog200Response

Пример

Пример за get_event_log

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

Параметри

Отговор

Връща: GetEventLog200Response

Пример

get_global_event_log Пример

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

Параметри

Отговор

Връща: CreateFeedPost200Response

Пример

Пример за create_feed_post

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

Параметри

Отговор

Връща: CreateFeedPostPublic200Response

Пример

create_feed_post_public Пример

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

Параметри

Отговор

Връща: DeleteFeedPostPublic200Response

Пример

delete_feed_post_public Пример

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

Параметри

Отговор

Връща: GetFeedPosts200Response

Пример

get_feed_posts Пример

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

Параметри

Отговор

Връща: GetFeedPostsPublic200Response

Пример

Пример за get_feed_posts_public

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

Параметри

Отговор

Връща: GetFeedPostsStats200Response

Пример

get_feed_posts_stats Пример

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

Параметри

Отговор

Връща: GetUserReactsPublic200Response

Пример

get_user_reacts_public Пример

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

Параметри

Отговор

Връща: ReactFeedPostPublic200Response

Пример

Пример за react_feed_post_public

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

update_feed_post Пример

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

Параметри

Отговор

Връща: CreateFeedPostPublic200Response

Пример

Пример за update_feed_post_public

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример на flag_comment_public

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

Параметри

Отговор

Връща: AddHashTag200Response

Пример

add_hash_tag Пример

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

Параметри

Отговор

Връща: AddHashTagsBulk200Response

Пример

Пример за add_hash_tags_bulk

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

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за delete_hash_tag

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

Параметри

Отговор

Връща: GetHashTags200Response

Пример

Пример за get_hash_tags

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

Параметри

Отговор

Връща: PatchHashTag200Response

Пример

Пример за patch_hash_tag

Copy

1

2let params: PatchHashTagParams = PatchHashTagParams {

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

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

5 update_hash_tag_body: Some(models::UpdateHashTagBody {

6 label: Some("World News".to_string()),

7 description: Some("Articles related to world events.".to_string()),

8 enabled: Some(true),

9 }),

10};

11

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

13

Параметри

Отговор

Връща: CreateModerator200Response

Пример

Пример за create_moderator

Copy

1

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

3 let params: CreateModeratorParams = CreateModeratorParams {

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

5 create_moderator_body: models::CreateModeratorBody {

6 username: String::from("jane.moderator"),

7 email: String::from("jane.moderator@acme.com"),

8 display_name: Some(String::from("Jane Moderator")),

9 sections: Some(vec![String::from("news/article"), String::from("forums/general")]),

10 active: Some(true),

11 notes: Some(String::from("Senior moderator, PST timezone")),

12 },

13 };

14 let response: CreateModerator200Response = create_moderator(&configuration, params).await?;

15 Ok(())

16}

17

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример

delete_moderator Пример

Copy

1

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

3 let params: DeleteModeratorParams = DeleteModeratorParams {

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

5 id: String::from("moderator-9876"),

6 send_email: Some(String::from("true")),

7 };

8

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

10 Ok(())

11}

12

Параметри

Отговор

Връща: GetModerator200Response

Пример

Пример за get_moderator

Copy

1

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

3 let params = GetModeratorParams {

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

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

6 include_permissions: Some(true),

7 };

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

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

10 Ok(())

11}

12

Параметри

Отговор

Връща: GetModerators200Response

Пример

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

9}

10

Параметри

Отговор

Връща: FlagCommentPublic200Response

Пример