sevk 1.0.0

Rust SDK for Sevk API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Broadcasts resource

use crate::client::Client;
use crate::error::Error;
use crate::types::{
    Broadcast, BroadcastAnalytics, BroadcastCostEstimate, BroadcastEmail, BroadcastStatus,
    CreateBroadcastRequest, EmptyResponse, ItemsList, ListParams, PaginatedList, SendTestRequest,
    UpdateBroadcastRequest,
};

/// Broadcasts API resource
pub struct Broadcasts<'a> {
    client: &'a Client,
}

impl<'a> Broadcasts<'a> {
    /// Create a new Broadcasts resource
    pub fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// List all broadcasts
    pub async fn list(
        &self,
        params: Option<ListParams>,
    ) -> Result<PaginatedList<Broadcast>, Error> {
        let params = params.unwrap_or_default();
        let query_params = params.to_query_params();
        self.client
            .get_with_params("/broadcasts", &query_params)
            .await
    }

    /// Get a broadcast by ID
    pub async fn get(&self, id: &str) -> Result<Broadcast, Error> {
        self.client.get(&format!("/broadcasts/{}", id)).await
    }

    /// Create a new broadcast
    pub async fn create(&self, data: CreateBroadcastRequest) -> Result<Broadcast, Error> {
        self.client.post("/broadcasts", &data).await
    }

    /// Update a broadcast
    pub async fn update(
        &self,
        id: &str,
        data: UpdateBroadcastRequest,
    ) -> Result<Broadcast, Error> {
        self.client
            .put(&format!("/broadcasts/{}", id), &data)
            .await
    }

    /// Delete a broadcast
    pub async fn delete(&self, id: &str) -> Result<EmptyResponse, Error> {
        self.client.delete(&format!("/broadcasts/{}", id)).await
    }

    /// Send a broadcast
    pub async fn send(&self, id: &str) -> Result<Broadcast, Error> {
        self.client
            .post(&format!("/broadcasts/{}/send", id), &serde_json::json!({}))
            .await
    }

    /// Cancel a scheduled broadcast
    pub async fn cancel(&self, id: &str) -> Result<Broadcast, Error> {
        self.client
            .post(
                &format!("/broadcasts/{}/cancel", id),
                &serde_json::json!({}),
            )
            .await
    }

    /// Send a test email for a broadcast
    pub async fn send_test(
        &self,
        id: &str,
        emails: Vec<String>,
    ) -> Result<EmptyResponse, Error> {
        let request = SendTestRequest { emails };
        self.client
            .post(&format!("/broadcasts/{}/test", id), &request)
            .await
    }

    /// Get broadcast analytics
    pub async fn get_analytics(&self, id: &str) -> Result<BroadcastAnalytics, Error> {
        self.client
            .get(&format!("/broadcasts/{}/analytics", id))
            .await
    }

    /// Get broadcast status
    pub async fn get_status(&self, id: &str) -> Result<BroadcastStatus, Error> {
        self.client
            .get(&format!("/broadcasts/{}/status", id))
            .await
    }

    /// Get broadcast emails
    pub async fn get_emails(
        &self,
        id: &str,
        params: Option<ListParams>,
    ) -> Result<PaginatedList<BroadcastEmail>, Error> {
        let params = params.unwrap_or_default();
        let query_params = params.to_query_params();
        self.client
            .get_with_params(&format!("/broadcasts/{}/emails", id), &query_params)
            .await
    }

    /// Estimate broadcast cost
    pub async fn estimate_cost(&self, id: &str) -> Result<BroadcastCostEstimate, Error> {
        self.client
            .get(&format!("/broadcasts/{}/estimate-cost", id))
            .await
    }

    /// List active broadcasts
    pub async fn list_active(&self) -> Result<ItemsList<Broadcast>, Error> {
        self.client.get("/broadcasts/active").await
    }
}