sendry 0.2.0

Official Rust crate for the Sendry 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

//! SES sending regions and data residency.

use reqwest::Method;
use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::{client::Sendry, error::Error};

/// Regions resource handle.
#[derive(Debug, Clone)]
pub struct Regions {
    client: Sendry,
}

impl Regions {
    pub(crate) fn new(client: Sendry) -> Self {
        Self { client }
    }

    /// List available regions.
    pub async fn list(&self) -> Result<RegionList, Error> {
        self.client
            .request(
                self.client
                    .build::<()>(Method::GET, "/v1/regions", &[], None),
            )
            .await
    }

    /// Get org-level region settings.
    pub async fn get_org_settings(&self) -> Result<OrgRegionSettings, Error> {
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/organizations/me/region",
                &[],
                None,
            ))
            .await
    }

    /// Update org-level region settings.
    pub async fn update_org_settings(
        &self,
        params: UpdateOrgRegion,
    ) -> Result<OrgRegionSettings, Error> {
        self.client
            .request(self.client.build(
                Method::PATCH,
                "/v1/organizations/me/region",
                &[],
                Some(&params),
            ))
            .await
    }

    /// Override the region for a specific domain. Pass `None` for `region` to clear.
    pub async fn set_domain_region(
        &self,
        domain_id: &str,
        params: UpdateDomainRegion,
    ) -> Result<Value, Error> {
        self.client
            .request(self.client.build(
                Method::PATCH,
                &format!("/v1/domains/{domain_id}/region"),
                &[],
                Some(&params),
            ))
            .await
    }

    /// Per-region send-count breakdown for a date range.
    pub async fn get_region_analytics(
        &self,
        params: RegionAnalyticsParams,
    ) -> Result<RegionAnalyticsResponse, Error> {
        let q = params.to_query();
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/analytics/regions",
                &q,
                None,
            ))
            .await
    }
}

/// One region.
#[derive(Debug, Clone, Deserialize)]
pub struct Region {
    /// SES region code (e.g. `us-east-1`).
    pub region_code: String,
    /// Display name.
    pub display_name: String,
    /// Whether this is the org default.
    pub is_default: bool,
}

/// Wrapper returned by [`Regions::list`].
#[derive(Debug, Clone, Deserialize)]
pub struct RegionList {
    /// Regions.
    pub data: Vec<Region>,
}

/// Org region settings.
#[derive(Debug, Clone, Deserialize)]
pub struct OrgRegionSettings {
    /// Default region (may be null).
    pub default_region: Option<String>,
    /// Data residency: `none`, `eu`, `us`, or `ap`.
    pub data_residency: String,
}

/// Parameters for [`Regions::update_org_settings`].
#[derive(Debug, Clone, Default, Serialize)]
pub struct UpdateOrgRegion {
    /// Default region.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_region: Option<String>,
    /// Data residency.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data_residency: Option<String>,
}

/// Parameters for [`Regions::set_domain_region`].
#[derive(Debug, Clone, Default, Serialize)]
pub struct UpdateDomainRegion {
    /// Region code, or `None` to clear the override.
    pub region: Option<String>,
}

/// Parameters for [`Regions::get_region_analytics`].
#[derive(Debug, Clone, Default)]
pub struct RegionAnalyticsParams {
    /// ISO date.
    pub from: String,
    /// ISO date.
    pub to: String,
}

impl RegionAnalyticsParams {
    fn to_query(&self) -> Vec<(&'static str, String)> {
        vec![("from", self.from.clone()), ("to", self.to.clone())]
    }
}

/// One row of region analytics.
#[derive(Debug, Clone, Deserialize)]
pub struct RegionAnalyticsItem {
    /// Region code.
    pub region: String,
    /// Send count.
    pub count: u64,
    /// Share of total.
    pub percentage: f64,
}

/// Region analytics response.
#[derive(Debug, Clone, Deserialize)]
pub struct RegionAnalyticsResponse {
    /// Rows.
    pub data: Vec<RegionAnalyticsItem>,
}