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

//! Organisation profile and branding settings.

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

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

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

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

    /// Get the current organisation.
    pub async fn get_current(&self) -> Result<Organization, Error> {
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/organizations/me",
                &[],
                None,
            ))
            .await
    }

    /// Update the current organisation's name.
    pub async fn update(&self, params: UpdateOrganization) -> Result<Organization, Error> {
        self.client
            .request(self.client.build(
                Method::PATCH,
                "/v1/organizations/me",
                &[],
                Some(&params),
            ))
            .await
    }

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

    /// Update branding settings.
    pub async fn update_branding(
        &self,
        params: UpdateBranding,
    ) -> Result<BrandingSettings, Error> {
        self.client
            .request(self.client.build(
                Method::PATCH,
                "/v1/organizations/me/branding",
                &[],
                Some(&params),
            ))
            .await
    }
}

/// Organisation record.
#[derive(Debug, Clone, Deserialize)]
pub struct Organization {
    /// Org id.
    pub id: String,
    /// Display name.
    pub name: String,
    /// Plan.
    pub plan: String,
    /// Creation timestamp.
    #[serde(rename = "createdAt")]
    pub created_at: String,
}

/// Parameters for [`Organizations::update`].
#[derive(Debug, Clone, Serialize)]
pub struct UpdateOrganization {
    /// New name.
    pub name: String,
}

/// Branding settings.
#[derive(Debug, Clone, Deserialize)]
pub struct BrandingSettings {
    /// Hex colour.
    pub brand_color: String,
    /// Logo URL.
    pub brand_logo: Option<String>,
    /// Unsubscribe page heading.
    pub unsubscribe_heading: Option<String>,
    /// Unsubscribe page message.
    pub unsubscribe_message: Option<String>,
    /// Post-unsubscribe redirect URL.
    pub unsubscribe_redirect_url: Option<String>,
}

/// Parameters for [`Organizations::update_branding`]. All fields optional.
#[derive(Debug, Clone, Default, Serialize)]
pub struct UpdateBranding {
    /// Hex colour.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub brand_color: Option<String>,
    /// Logo URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub brand_logo: Option<String>,
    /// Unsubscribe page heading.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unsubscribe_heading: Option<String>,
    /// Unsubscribe page message.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unsubscribe_message: Option<String>,
    /// Post-unsubscribe redirect URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unsubscribe_redirect_url: Option<String>,
}