emailit 2.0.3

The official Rust SDK for the Emailit Email 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

//! Subscriber management within audiences.

use std::sync::Arc;

use crate::client::BaseClient;
use crate::collection::Collection;
use crate::error::Error;
use crate::types::{
    CreateSubscriberParams, ListSubscribersParams, Subscriber, UpdateSubscriberParams,
};

/// Service for managing subscribers within an audience.
///
/// Accessed via [`Emailit::subscribers`](crate::Emailit::subscribers).
/// All methods require the parent `audience_id`.
pub struct SubscriberService {
    pub(crate) client: Arc<BaseClient>,
}

impl SubscriberService {
    /// Adds a subscriber to an audience.
    ///
    /// `POST /v2/audiences/:audience_id/subscribers`
    pub async fn create(
        &self,
        audience_id: &str,
        params: CreateSubscriberParams,
    ) -> Result<Subscriber, Error> {
        let path = format!(
            "/v2/audiences/{}/subscribers",
            urlencoding::encode(audience_id)
        );
        self.client
            .request("POST", &path, to_body(&params), None)
            .await
    }

    /// Retrieves a subscriber by ID within an audience.
    ///
    /// `GET /v2/audiences/:audience_id/subscribers/:id`
    pub async fn get(&self, audience_id: &str, id: &str) -> Result<Subscriber, Error> {
        let path = format!(
            "/v2/audiences/{}/subscribers/{}",
            urlencoding::encode(audience_id),
            urlencoding::encode(id)
        );
        self.client.request("GET", &path, None, None).await
    }

    /// Updates a subscriber within an audience.
    ///
    /// `POST /v2/audiences/:audience_id/subscribers/:id`
    pub async fn update(
        &self,
        audience_id: &str,
        id: &str,
        params: UpdateSubscriberParams,
    ) -> Result<Subscriber, Error> {
        let path = format!(
            "/v2/audiences/{}/subscribers/{}",
            urlencoding::encode(audience_id),
            urlencoding::encode(id)
        );
        self.client
            .request("POST", &path, to_body(&params), None)
            .await
    }

    /// Lists subscribers in an audience with optional pagination and filters.
    ///
    /// `GET /v2/audiences/:audience_id/subscribers`
    pub async fn list(
        &self,
        audience_id: &str,
        params: Option<ListSubscribersParams>,
    ) -> Result<Collection<Subscriber>, Error> {
        let path = format!(
            "/v2/audiences/{}/subscribers",
            urlencoding::encode(audience_id)
        );
        let query = params.map(|p| {
            let mut q = Vec::new();
            if let Some(page) = p.page {
                q.push(("page", page.to_string()));
            }
            if let Some(limit) = p.limit {
                q.push(("limit", limit.to_string()));
            }
            if let Some(subscribed) = p.subscribed {
                q.push(("subscribed", subscribed.to_string()));
            }
            q
        });
        self.client
            .request::<Collection<Subscriber>>("GET", &path, None, query.as_deref())
            .await
    }

    /// Removes a subscriber from an audience.
    ///
    /// `DELETE /v2/audiences/:audience_id/subscribers/:id`
    pub async fn delete(&self, audience_id: &str, id: &str) -> Result<Subscriber, Error> {
        let path = format!(
            "/v2/audiences/{}/subscribers/{}",
            urlencoding::encode(audience_id),
            urlencoding::encode(id)
        );
        self.client.request("DELETE", &path, None, None).await
    }
}

fn to_body(v: &impl serde::Serialize) -> Option<serde_json::Value> {
    serde_json::to_value(v).ok()
}