FastComments SDK ל-Rust

cargo add fastcomments-sdk

ה-SDK דורש מהדורת Rust 2021 או מאוחרת יותר.

The FastComments Rust SDK consists of several modules:

• Client Module - לקוח API עבור FastComments REST APIs

  • הגדרות סוגים מלאות עבור כל מודלי ה-API
  • שלושה לקוחות API המכסים את כל השיטות של FastComments:
    • default_api (DefaultApi) - שיטות מאומתות במפתח API לשימוש בצד השרת
    • public_api (PublicApi) - שיטות ציבוריות, ללא מפתח API, בטוחות לשימוש מדפדפנים ואפליקציות מובייל
    • moderation_api (ModerationApi) - חבילה נרחבת של API של מודרציה בזמן אמת ומהירה. כל שיטת מודרציה מקבלת פרמטר sso ויכולה לאמת באמצעות SSO או עוגיית סשן של FastComments.com.
  • תמיכה מלאה ב-async/await עם tokio
  • ראה client/README.md לתיעוד API מפורט

• SSO Module - כלי Single Sign-On בצד השרת

  • יצירת אסימון מאובטח לאימות משתמש
  • תמיכה במצב SSO פשוט ומאובטח
  • חתימת אסימון מבוססת HMAC-SHA256

• Core Types - הגדרות סוג משותפות וכלים

  • מודלים של תגובות ומבני מטא-דאטה
  • הגדרות משתמש ודייר
  • פונקציות עזר לפעולות נפוצות

שימוש ב-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),
    }
}

שימוש ב-API המודרציה

שיטות המודרציה תומכות בלוח הבקרה של המודרטור. הן משתמשות ב-API-key ב-Configuration בדיוק כמו ה-API המאומת, וכל שיטה מקבלת אסימון sso אופציונלי כדי שהקריאה תתבצע מטעם מודרטור שאומת באמצעות SSO.

use fastcomments_sdk::client::apis::configuration::{ApiKey, Configuration};
use fastcomments_sdk::client::apis::moderation_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(),
    });

    // ספר תגובות שמחכות בתור המודרציה
    let result = moderation_api::get_count(
        &config,
        moderation_api::GetCountParams {
            text_search: None,
            by_ip_from_comment: None,
            filter: None,
            search_filters: None,
            demo: None,
            sso: None, // מסור אסימון SSO כדי לפעול בשם מודרטור שהאמתו אותו באמצעות SSO
        },
    )
    .await;

    match result {
        Ok(response) => println!("Comments to moderate: {}", response.count),
        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);
    // מסור את האסימון הזה ל-frontend שלך לצורך אימות
}

שגיאות 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. הוספתם את tokio לתלויות שלכם:

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

2. אתם משתמשים ב-runtime של tokio:

#[tokio::main]
async fn main() {
    // קוד אסינכרוני שלכם כאן
}

מזהי שידור

תראה שעליך להעביר את broadcastId בחלק מקריאות ה-API. כשאתה מקבל אירועים, תקבל חזרה את המזהה הזה, כך תדע להתעלם מהאירוע אם אתה מתכנן ליישם שינויים באופן אופטימי בצד הלקוח (וככל הנראה תרצה לעשות זאת שכן זה מציע את חוויית המשתמש הטובה ביותר). העבר כאן UUID. המזהה צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים באותו סשן בדפדפן.

Aggregates מסמכים על‑ידי קיבוץ שלהם (אם groupBy סופק) ויישום של מספר פעולות. פעולות שונות (למשל sum, countDistinct, avg, וכו׳) נתמכות.

פרמטרים

תגובה

מחזיר: AggregateResponse

דוגמה

דוגמה לצבירה

Copy

1

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

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

4 let aggregation_request = models::AggregationRequest::default();

5 let params = AggregateParams {

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

7 aggregation_request,

8 parent_tenant_id: Some("global-tenant".to_string()),

9 include_stats: Some(true),

10 };

11 let _response = aggregate(&config, params).await?;

12 Ok(())

13}

14

פרמטרים

תגובה

מחזיר: ModerationApiGetCommentsResponse

דוגמה

get_api_comments דוגמה

Copy

1

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

3 let params = GetApiCommentsParams {

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

5 page: Some(1.0),

6 count: Some(20.0),

7 text_search: Some("rust".to_string()),

8 by_ip_from_comment: None,

9 filters: Some("status:approved".to_string()),

10 search_filters: Some("author:john".to_string()),

11 sorts: Some("date:desc".to_string()),

12 demo: Some(false),

13 sso: None,

14 };

15 let _response = get_api_comments(&configuration, params).await?;

16 Ok(())

17}

18

פרמטרים

תגובה

מחזיר: ModerationExportStatusResponse

דוגמה

דוגמת get_api_export_status

Copy

1

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

3 let params = GetApiExportStatusParams {

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

5 batch_job_id: Some("batch-2023-09-01".to_string()),

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

7 };

8 let _status = get_api_export_status(&configuration, params).await?;

9 Ok(())

10}

11

Parameters

Response

מחזיר: ModerationApiGetCommentIdsResponse

Example

get_api_ids דוגמה

Copy

1

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

3 let params = GetApiIdsParams {

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

5 text_search: Some("breaking news".to_string()),

6 by_ip_from_comment: None,

7 filters: Some("status:approved".to_string()),

8 search_filters: None,

9 after_id: None,

10 demo: Some(false),

11 sso: Some("sso-token".to_string()),

12 };

13 let _response = get_api_ids(&config, params).await?;

14 Ok(())

15}

16

פרמטרים

תגובה

מחזירה: ModerationExportResponse

דוגמה

post_api_export דוגמה

Copy

1

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

3 let params = PostApiExportParams {

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

5 text_search: Some("news/article".to_string()),

6 by_ip_from_comment: Some("203.0.113.42".to_string()),

7 filters: Some("status:pending".to_string()),

8 search_filters: Some("created_at>2023-01-01".to_string()),

9 sorts: Some("created_at_desc".to_string()),

10 sso: None,

11 };

12 let _response = post_api_export(&configuration, params).await?;

13 Ok(())

14}

15

פרמטרים

תגובה

מחזיר: GetAuditLogsResponse

דוגמה

דוגמה get_audit_logs

Copy

1

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

3 let params = 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(1622505600.0),

9 before: None,

10 };

11 let _response: GetAuditLogsResponse = get_audit_logs(config, params).await?;

12 Ok(())

13}

14

פרמטרים

תגובה

מחזיר: BlockSuccess

דוגמה

דוגמה ל‑block_from_comment_public

Copy

1

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

3 let params = BlockFromCommentPublicParams {

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

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

6 public_block_from_comment_params: models::PublicBlockFromCommentParams::default(),

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

8 };

9 let _result: BlockSuccess = block_from_comment_public(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזירים: UnblockSuccess

דוגמה

דוגמה של un_block_comment_public

Copy

1

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

3 let params = UnBlockCommentPublicParams {

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

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

6 public_block_from_comment_params: models::PublicBlockFromCommentParams::default(),

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

8 };

9 let _result: UnblockSuccess = un_block_comment_public(configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: CheckBlockedCommentsResponse

דוגמה

דוגמה ל‑checked_comments_for_blocked

Copy

1

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

3 let params = CheckedCommentsForBlockedParams {

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

5 comment_ids: "cmt-001,cmt-002".to_string(),

6 sso: Some("user@example.com".to_string()),

7 };

8 let _response: CheckBlockedCommentsResponse = checked_comments_for_blocked(&config, params).await?;

9 Ok(())

10}

11

פרמטרים

תגובה

מחזיר: BlockSuccess

דוגמה

block_user_from_comment דוגמה

Copy

1

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

3 let params = BlockUserFromCommentParams {

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

5 id: "comment-9876".to_string(),

6 block_from_comment_params: models::BlockFromCommentParams {

7 reason: "spam".to_string(),

8 },

9 user_id: Some("user-42".to_string()),

10 anon_user_id: None,

11 };

12 let _result: BlockSuccess = block_user_from_comment(configuration, params).await?;

13 Ok(())

14}

15

פרמטרים

תגובה

מחזיר: SaveCommentsResponseWithPresence

דוגמה

create_comment_public דוגמה

Copy

1

2let params = CreateCommentPublicParams {

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

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

5 broadcast_id: "broadcast-2023-09-01".to_string(),

6 comment_data: models::CommentData {

7 text: "Great read!".to_string(),

8 },

9 session_id: Some("session-abc123".to_string()),

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

11};

12let response = create_comment_public(&configuration, params).await?;

13

פרמטרים

תגובה

מחזיר: DeleteCommentResult

דוגמה

דוגמת delete_comment

Copy

1

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

3 let params = DeleteCommentParams {

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

5 id: "comment-12345".to_string(),

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

7 is_live: Some(true),

8 };

9 let _result = delete_comment(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: PublicApiDeleteCommentResponse

דוגמה

דוגמה delete_comment_public

Copy

1

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

3 let params = DeleteCommentPublicParams {

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

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

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

7 edit_key: Some("edit-abc123".to_string()),

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

9 };

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

11 let _deleted: PublicApiDeleteCommentResponse = response;

12 Ok(())

13}

14

פרמטרים

תגובה

מחזיר: VoteDeleteResponse

דוגמה

delete_comment_vote דוגמה

Copy

1

2#[tokio::main]

3async fn main() -> Result<(), Error> {

4 let params = DeleteCommentVoteParams {

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

6 comment_id: "comment-12345".to_string(),

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

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

9 broadcast_id: "broadcast-abc".to_string(),

10 edit_key: Some("edit-key-xyz".to_string()),

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

12 };

13 let _response: VoteDeleteResponse = delete_comment_vote(&configuration, params).await?;

14 Ok(())

15}

16

פרמטרים

תגובה

מחזיר: FlagCommentResponse

דוגמה

flag_comment דוגמה

Copy

1

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

3 let params = FlagCommentParams {

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

5 id: "comment-9876".to_string(),

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

7 anon_user_id: None,

8 };

9 let _response = flag_comment(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: ApiGetCommentResponse

דוגמה

דוגמת get_comment

Copy

1

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

3 let params = GetCommentParams {

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

5 id: "comment-12345".to_string(),

6 include_deleted: Some(false),

7 };

8

9 let _response: ApiGetCommentResponse = get_comment(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

Returns: PublicApiGetCommentTextResponse

דוגמה

get_comment_text דוגמה

Copy

1

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

3 let params = GetCommentTextParams {

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

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

6 edit_key: Some("edit-key-abc".to_string()),

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

8 };

9 let _response = get_comment_text(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: GetCommentVoteUserNamesSuccessResponse

דוגמה

get_comment_vote_user_names דוגמה

Copy

1

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

3 let params = GetCommentVoteUserNamesParams {

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

5 comment_id: "news/article-123".to_string(),

6 dir: 1,

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

8 };

9 let _response: GetCommentVoteUserNamesSuccessResponse =

10 get_comment_vote_user_names(config, params).await?;

11 Ok(())

12}

13

פרמטרים

תגובה

מחזיר: ApiGetCommentsResponse

דוגמה

דוגמת get_comments

Copy

1

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

3 let params = GetCommentsParams {

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

5 page: Some(1),

6 limit: Some(20),

7 skip: Some(0),

8 as_tree: Some(true),

9 skip_children: Some(5),

10 limit_children: Some(10),

11 max_tree_depth: Some(3),

12 url_id: Some("news/article".to_string()),

13 user_id: Some("user-123".to_string()),

14 anon_user_id: Some("anon-456".to_string()),

15 context_user_id: Some("ctx-789".to_string()),

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

17 parent_id: Some("parent-001".to_string()),

18 direction: Some(models::SortDirections::Desc),

19 from_date: Some(1_640_995_200),

20 to_date: Some(1_641_081_600),

21 };

22 let _response = get_comments(&config, params).await?;

23 Ok(())

24}

25

בקשה tenantId urlId

פרמטרים

תגובה

מחזיר: GetCommentsResponseWithPresencePublicComment

דוגמה

דוגמת get_comments_public

Copy

1

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

3 let params = GetCommentsPublicParams {

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

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

6 page: Some(1),

7 direction: Some(models::SortDirections::Desc),

8 limit: Some(20),

9 includei10n: Some(true),

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

11 as_tree: Some(true),

12 max_tree_depth: Some(3),

13 hash_tags: Some(vec!["rust".to_string(), "programming".to_string()]),

14 ..Default::default()

15 };

16 let _response = get_comments_public(&configuration, params).await?;

17 Ok(())

18}

19

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

lock_comment דוגמה

Copy

1

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

3 let params = LockCommentParams {

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

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

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

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

8 };

9 let _resp = lock_comment(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: ChangeCommentPinStatusResponse

דוגמה

דוגמה של pin_comment

Copy

1

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

3 let params = PinCommentParams {

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

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

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

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

8 };

9 let _response = pin_comment(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

תגובה

מחזיר: ApiSaveCommentResponse

דוגמה

דוגמת save_comment

Copy

1

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

3 let params = SaveCommentParams {

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

5 create_comment_params: models::CreateCommentParams {

6 body: "Great insights on the latest tech trends.".to_string(),

7 user_id: "user-789".to_string(),

8 ..Default::default()

9 },

10 is_live: Some(true),

11 do_spam_check: Some(true),

12 send_emails: Some(false),

13 populate_notifications: Some(true),

14 };

15 let _response = save_comment(&configuration, params).await?;

16 Ok(())

17}

18

פרמטרים

תגובה

מחזיר: Vec<models::SaveCommentsBulkResponse>

דוגמה

save_comments_bulk דוגמה

Copy

1

2#[tokio::main]

3async fn main() -> Result<(), Box<dyn std::error::Error>> {

4 let params: SaveCommentsBulkParams = SaveCommentsBulkParams {

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

6 create_comment_params: vec![

7 models::CreateCommentParams::default(),

8 models::CreateCommentParams::default(),

9 ],

10 is_live: Some(true),

11 do_spam_check: Some(false),

12 send_emails: Some(true),

13 populate_notifications: Some(false),

14 };

15 let _responses: Vec<models::SaveCommentsBulkResponse> = save_comments_bulk(&configuration, params).await?;

16 Ok(())

17}

18

פרמטרים

תשובה

מחזיר: PublicApiSetCommentTextResponse

דוגמה

set_comment_text דוגמה

Copy

1

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

3 let comment_text_update_request = models::CommentTextUpdateRequest {

4 text: "Edited comment text after moderation".to_string(),

5 ..Default::default()

6 };

7 let params = SetCommentTextParams {

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

9 comment_id: "cmt-98765".to_string(),

10 broadcast_id: "news/article".to_string(),

11 comment_text_update_request,

12 edit_key: Some("edit-key-2024".to_string()),

13 sso: Some("sso-token-789".to_string()),

14 };

15 let _response = set_comment_text(&configuration, params).await?;

16 Ok(())

17}

18

פרמטרים

תגובה

מחזיר: UnblockSuccess

דוגמה

דוגמה של un_block_user_from_comment

Copy

1

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

3 let params = UnBlockUserFromCommentParams {

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

5 id: "comment-12345".to_string(),

6 un_block_from_comment_params: models::UnBlockFromCommentParams::default(),

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

8 anon_user_id: Some("anon-abcde".to_string()),

9 };

10 let result = un_block_user_from_comment(config, params).await?;

11 Ok(result)

12}

13

פרמטרים

תגובה

מחזיר: FlagCommentResponse

דוגמה

un_flag_comment דוגמה

Copy

1

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

3 let params = UnFlagCommentParams {

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

5 id: "comment-12345".to_string(),

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

7 anon_user_id: None,

8 };

9 let _response = un_flag_comment(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

דוגמת un_lock_comment

Copy

1

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

3 let params = UnLockCommentParams {

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

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

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

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

8 };

9 let _response = un_lock_comment(&configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזירה: ChangeCommentPinStatusResponse

דוגמה

un_pin_comment דוגמה

Copy

1

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

3 let params = UnPinCommentParams {

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

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

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

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

8 };

9 let _response: ChangeCommentPinStatusResponse = un_pin_comment(configuration, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

דוגמה לעדכון_תגובה

Copy

1

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

3 let updatable = models::UpdatableCommentParams {

4 content: "Edited comment about the latest news article".to_string(),

5 ..Default::default()

6 };

7 let params = UpdateCommentParams {

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

9 id: "comment-789".to_string(),

10 updatable_comment_params: updatable,

11 context_user_id: Some("reader-42".to_string()),

12 do_spam_check: Some(true),

13 is_live: Some(true),

14 };

15 let _ = update_comment(&configuration, params).await?;

16 Ok(())

17}

18

פרמטרים

תגובה

מחזיר: VoteResponse

דוגמה

דוגמה של vote_comment

Copy

1

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

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

4

5 let vote_body = models::VoteBodyParams {

6 vote_type: "upvote".to_string(),

7 weight: 1,

8 };

9

10 let params = VoteCommentParams {

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

12 comment_id: "comment-12345".to_string(),

13 url_id: "news/article".to_string(),

14 broadcast_id: "broadcast-67890".to_string(),

15 vote_body_params: vote_body,

16 session_id: Some("session-abcde".to_string()),

17 sso: None,

18 };

19

20 let _response = vote_comment(&config, params).await?;

21 Ok(())

22}

23

פרמטרים

תגובה

מחזירה: GetCommentsForUserResponse

דוגמה

דוגמה get_comments_for_user

Copy

1

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

3 let params = GetCommentsForUserParams {

4 user_id: Some("user-42".to_string()),

5 direction: Some(models::SortDirections::Desc),

6 replies_to_user_id: Some("reply-to-42".to_string()),

7 page: Some(1.0),

8 includei10n: Some(true),

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

10 is_crawler: Some(false),

11 };

12 let _response = get_comments_for_user(&configuration, params).await?;

13 Ok(())

14}

15

פרמטרים

תגובה

מחזיר: AddDomainConfigResponse

דוגמה

add_domain_config דוגמה

Copy

1

2let params = AddDomainConfigParams {

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

4 add_domain_config_params: models::AddDomainConfigParams {

5 domain: "news.example.com".to_string(),

6 config_type: "article".to_string(),

7 is_active: true,

8 description: Some("News article domain".to_string()),

9 },

10};

11

12let response = add_domain_config(&configuration, params).await?;

13

פרמטרים

תגובה

מחזיר: DeleteDomainConfigResponse

דוגמה

דוגמת delete_domain_config

Copy

1

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

3 let params = DeleteDomainConfigParams {

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

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

6 };

7 let _response: DeleteDomainConfigResponse = delete_domain_config(configuration, params).await?;

8 Ok(())

9}

10

פרמטרים

תשובה

מחזיר: GetDomainConfigResponse

דוגמה

דוגמה get_domain_config

Copy

1

2#[tokio::main]

3async fn main() -> Result<(), Error> {

4 let params = GetDomainConfigParams {

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

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

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

8 };

9 let _response = get_domain_config(&config, params).await?;

10 Ok(())

11}

12

פרמטרים

תגובה

מחזיר: GetDomainConfigsResponse

דוגמה

דוגמה get_domain_configs

Copy

1

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

3 let params = GetDomainConfigsParams {

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

5 };

6 let _response = get_domain_configs(&configuration, params).await?;

7 Ok(())

8}

9

פרמטרים

תגובה

מחזיר: PatchDomainConfigResponse

דוגמה

patch_domain_config דוגמה

Copy

1

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

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

4 let params = PatchDomainConfigParams {

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

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

7 patch_domain_config_params: models::PatchDomainConfigParams {

8 enable_comments: Some(true),

9 theme: Some("dark".to_string()),

10 },

11 };

12 let _response = patch_domain_config(&config, params).await?;

13 Ok(())

14}

15

פרמטרים

תגובה

מחזיר: PutDomainConfigResponse

דוגמה

דוגמת put_domain_config

Copy

1

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

3 let update_params = models::UpdateDomainConfigParams {

4 enable_comments: Some(true),

5 moderation_level: Some("strict".to_string()),

6 max_comment_length: Some(500),

7 ..Default::default()

8 };

9 let params = PutDomainConfigParams {

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

11 domain_to_update: "news.example.com".to_string(),

12 update_domain_config_params: update_params,

13 };

14 let _resp: PutDomainConfigResponse = put_domain_config(configuration, params).await?;

15 Ok(())

16}

17

פרמטרים

תגובה

מחזיר: CreateEmailTemplateResponse

דוגמה

דוגמת create_email_template

Copy

1

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

3 let params = CreateEmailTemplateParams {

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

5 create_email_template_body: models::CreateEmailTemplateBody {

6 name: "welcome".to_string(),

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

8 html_content: "<h1>Welcome</h1>".to_string(),

9 plain_text_content: Some("Welcome to Acme".to_string()),

10 },

11 };

12 let _response = create_email_template(&configuration, params).await?;

13 Ok(())

14}

15

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

delete_email_template דוגמה

Copy

1

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

3 let params = DeleteEmailTemplateParams {

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

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

6 };

7 let _ = delete_email_template(&config, params).await?;

8 Ok(())

9}

10

Parameters

Response

מחזיר: ApiEmptyResponse

Example

דוגמה של delete_email_template_render_error

Copy

1

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

3 let params = DeleteEmailTemplateRenderErrorParams {

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

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

6 error_id: "render-failure-123".to_string(),

7 };

8 let _ = delete_email_template_render_error(config, params).await?;

9 Ok(())

10}

11

פרמטרים

תגובה

מחזיר: GetEmailTemplateResponse

דוגמה

get_email_template דוגמה

Copy

1

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

3 let params: GetEmailTemplateParams = GetEmailTemplateParams {

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

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

6 };

7 let _response = get_email_template(&configuration, params).await?;

8 Ok(())

9}

10

פרמטרים

תגובה

מחזיר: GetEmailTemplateDefinitionsResponse

דוגמה

דוגמה של get_email_template_definitions

Copy

1

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

3 let params = GetEmailTemplateDefinitionsParams {

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

5 };

6 let _response = get_email_template_definitions(&configuration, params).await?;

7 Ok(())

8}

9

פרמטרים

תגובה

מחזיר: GetEmailTemplateRenderErrorsResponse

דוגמה

דוגמה get_email_template_render_errors

Copy

1

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

3 let params = GetEmailTemplateRenderErrorsParams {

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

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

6 skip: Some(5.0),

7 };

8 let _response: GetEmailTemplateRenderErrorsResponse = get_email_template_render_errors(config, params).await?;

9 Ok(())

10}

11

פרמטרים

תגובה

מחזיר: GetEmailTemplatesResponse

דוגמה

דוגמת get_email_templates

Copy

1

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

3 let params = GetEmailTemplatesParams {

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

5 skip: Some(10.0),

6 };

7 let _response = get_email_templates(&configuration, params).await?;

8 Ok(())

9}

10

פרמטרים

תגובה

מחזיר: RenderEmailTemplateResponse

דוגמה

דוגמה של render_email_template

Copy

1

2let mut vars = std::collections::HashMap::new();

3vars.insert("article_title".to_string(), "Breaking News".to_string());

4vars.insert("author".to_string(), "Jane Smith".to_string());

5

6let body = models::RenderEmailTemplateBody {

7 template_id: "newsletter".to_string(),

8 variables: vars,

9};

10

11let params = RenderEmailTemplateParams {

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

13 render_email_template_body: body,

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

15};

16

17let response = render_email_template(&configuration, params).await?;

18

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

דוגמה של update_email_template

Copy

1

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

3 let params = UpdateEmailTemplateParams {

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

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

6 update_email_template_body: models::UpdateEmailTemplateBody {

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

8 body_html: Some("<p>Hello, \{{user.name}}!</p>".to_string()),

9 body_text: None,

10 },

11 };

12 let _ = update_email_template(&config, params).await?;

13 Ok(())

14}

15

req tenantId urlId userIdWS

פרמטרים

תשובה

מחזיר: GetEventLogResponse

דוגמה

דוגמת get_event_log

Copy

1

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

3 let params = GetEventLogParams {

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

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

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

7 start_time: 1_640_995_200,

8 end_time: Some(1_640_995_300),

9 };

10 let _response: GetEventLogResponse = get_event_log(configuration, params).await?;

11 Ok(())

12}

13

req tenantId urlId userIdWS

פרמטרים

תגובה

מחזיר: GetEventLogResponse

דוגמה

דוגמת get_global_event_log

Copy

1

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

3 let params = GetGlobalEventLogParams {

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

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

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

7 start_time: 1_680_000_000,

8 end_time: Some(1_680_864_000),

9 };

10 let _response = get_global_event_log(configuration, params).await?;

11 Ok(())

12}

13

פרמטרים

תגובה

מחזירה: CreateFeedPostsResponse

דוגמה

create_feed_post דוגמה

Copy

1

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

3 let params = CreateFeedPostParams {

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

5 create_feed_post_params: models::CreateFeedPostParams {

6 text: "Launching new features".into(),

7 media: vec![],

8 },

9 broadcast_id: Some("broadcast-2023-09".into()),

10 is_live: Some(true),

11 do_spam_check: Some(true),

12 skip_dup_check: Some(false),

13 };

14 let _response = create_feed_post(configuration, params).await?;

15 Ok(())

16}

17

פרמטרים

תגובה

מחזיר: CreateFeedPostResponse

דוגמה

דוגמת create_feed_post_public

Copy

1

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

3 let params = CreateFeedPostPublicParams {

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

5 create_feed_post_params: models::CreateFeedPostParams {

6 title: "Breaking News".to_string(),

7 body: "Details about the news...".to_string(),

8 ..Default::default()

9 },

10 broadcast_id: Some("news/article".to_string()),

11 sso: Some("sso-token-abc".to_string()),

12 };

13 let _response = create_feed_post_public(configuration, params).await?;

14 Ok(())

15}

16

פרמטרים

תגובה

מחזיר: DeleteFeedPostPublicResponse

דוגמה

delete_feed_post_public דוגמה

Copy

1

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

3 let params = DeleteFeedPostPublicParams {

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

5 post_id: "news/article-123".to_string(),

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

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

8 };

9 let _response: DeleteFeedPostPublicResponse = delete_feed_post_public(&configuration, params).await?;

10 Ok(())

11}

12

req tenantId afterId

פרמטרים

תגובה

מחזיר: GetFeedPostsResponse

דוגמה

get_feed_posts דוגמה

Copy

1

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

3 let params = GetFeedPostsParams {

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

5 after_id: Some("post-12345".to_string()),

6 limit: Some(20),

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

8 };

9 let _response = get_feed_posts(config, params).await?;

10 Ok(())

11}

12

req tenantId afterId

פרמטרים

תגובה

מחזיר: PublicFeedPostsResponse

דוגמה

דוגמת get_feed_posts_public

Copy

1

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

3 let params = GetFeedPostsPublicParams {

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

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

6 limit: Some(20),

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

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

9 is_crawler: Some(false),

10 include_user_info: Some(true),

11 };

12 let _response = get_feed_posts_public(&configuration, params).await?;

13 Ok(())

14}

15

פרמטרים

תגובה

מחזיר: FeedPostsStatsResponse

דוגמה

get_feed_posts_stats דוגמה

Copy

1

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

3 let params = GetFeedPostsStatsParams {

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

5 post_ids: vec![

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

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

8 ],

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

10 };

11 let _response = get_feed_posts_stats(&configuration, params).await?;

12 Ok(())

13}

14

פרמטרים

תגובה

מחזיר: UserReactsResponse

דוגמה

דוגמת get_user_reacts_public

Copy

1

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

3 let params = 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("sso-token-xyz".to_string()),

10 };

11 let _response = get_user_reacts_public(&configuration, params).await?;

12 Ok(())

13}

14

Parameters

תשובה

מחזיר: ReactFeedPostResponse

דוגמה

react_feed_post_public דוגמה

Copy

1

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

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

4 let react_body = models::ReactBodyParams {

5 reaction: "like".to_string(),

6 };

7 let params = ReactFeedPostPublicParams {

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

9 post_id: "news/article/12345".to_string(),

10 react_body_params: react_body,

11 is_undo: Some(false),

12 broadcast_id: Some("broadcast-xyz".to_string()),

13 sso: Some("sso-token-abc".to_string()),

14 };

15 let _response: ReactFeedPostResponse = react_feed_post_public(&config, params).await?;

16 Ok(())

17}

18

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

update_feed_post דוגמה

Copy

1

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

3 let feed_post = models::FeedPost {

4 title: "Acme Corp Quarterly Update".to_string(),

5 content: Some("Q2 results exceeded expectations with a 15% revenue growth.".to_string()),

6 media: Some(vec![

7 models::FeedPostMediaItem {

8 asset: models::FeedPostMediaItemAsset {

9 url: "https://cdn.acme.com/media/q2-report.png".to_string(),

10 mime_type: Some("image/png".to_string()),

11 ..Default::default()

12 },

13 ..Default::default()

14 },

15 ]),

16 link: Some(models::FeedPostLink {

17 url: "https://www.acme.com/reports/q2".to_string(),

18 title: Some("Full Report".to_string()),

19 ..Default::default()

20 }),

21 ..Default::default()

22 };

23

24 let params = UpdateFeedPostParams {

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

26 id: "news/q2-update".to_string(),

27 feed_post,

28 };

29

30 update_feed_post(&configuration, params).await?;

31 Ok(())

32}

33

פרמטרים

תגובה

מחזירה: CreateFeedPostResponse

דוגמה

דוגמת update_feed_post_public

Copy

1

2let params = UpdateFeedPostPublicParams {

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

4 post_id: "news/article-123".into(),

5 update_feed_post_params: models::UpdateFeedPostParams {

6 title: Some("Updated Headline".into()),

7 content: Some("Revised content of the article with latest information.".into()),

8 ..Default::default()

9 },

10 broadcast_id: Some("broadcast-001".into()),

11 sso: Some("sso-token-abc123".into()),

12};

13

14let response: CreateFeedPostResponse = update_feed_post_public(&configuration, params).await?;

15

פרמטרים

תגובה

מחזיר: ApiEmptyResponse

דוגמה

דוגמת flag_comment_public

Copy

1

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

3 let params = FlagCommentPublicParams {

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

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

6 is_flagged: true,

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

8 };

9 flag_comment_public(configuration, params).await?;

10 Ok(())

11}

12

Parameters