postmark 2.0.0

Postmark rust client
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

use std::borrow::Cow;

use crate::Endpoint;
use crate::api::templates::{TemplateId, TemplateType};
use crate::api::{DEFAULT_PAGE_COUNT, DEFAULT_PAGE_OFFSET, endpoint_with_query};
use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;
use url::form_urlencoded::Serializer;

/// List templates with pagination.
#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(rename_all = "PascalCase")]
#[derive(TypedBuilder)]
pub struct ListTemplatesRequest {
    /// Number of templates to return.
    #[serde(skip)]
    #[builder(default = DEFAULT_PAGE_COUNT)]
    pub count: i64,
    /// Number of templates to skip.
    #[serde(skip)]
    #[builder(default = DEFAULT_PAGE_OFFSET)]
    pub offset: i64,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct ListTemplatesResponse {
    /// Total number of templates associated with current server.
    pub total_count: i64,
    /// Templates list.
    pub templates: Vec<TemplateSummary>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct TemplateSummary {
    pub active: bool,
    pub template_id: TemplateId,
    pub name: String,
    pub alias: Option<String>,
    pub template_type: TemplateType,
    pub layout_template: Option<String>,
}

impl Endpoint for ListTemplatesRequest {
    type Request = ListTemplatesRequest;
    type Response = ListTemplatesResponse;

    fn endpoint(&self) -> Cow<'static, str> {
        let mut serializer = Serializer::new(String::new());
        serializer.append_pair("count", &self.count.to_string());
        serializer.append_pair("offset", &self.offset.to_string());
        endpoint_with_query("/templates", serializer.finish())
    }

    fn body(&self) -> &Self::Request {
        self
    }

    fn method(&self) -> http::Method {
        http::Method::GET
    }
}

#[cfg(test)]
mod tests {
    use httptest::matchers::request;
    use httptest::{Expectation, Server, responders::*};
    use serde_json::json;

    use crate::Query;
    use crate::reqwest::PostmarkClient;

    use super::*;

    #[tokio::test]
    pub async fn list_templates() {
        let server = Server::run();

        server.expect(
            Expectation::matching(request::method_path("GET", "/templates")).respond_with(
                json_encoded(json!({
                    "TotalCount": 2,
                    "Templates": [
                        {
                            "TemplateId": 1234,
                            "Name": "Password Recovery Email",
                            "Alias": "password-recovery",
                            "Active": true,
                            "TemplateType": "Standard",
                            "LayoutTemplate": "my-layout"
                        },
                        {
                            "TemplateId": 5678,
                            "Name": "Default Layout",
                            "Alias": "my-layout",
                            "Active": true,
                            "TemplateType": "Layout",
                            "LayoutTemplate": null
                        }
                    ]
                })),
            ),
        );

        let client = PostmarkClient::builder()
            .base_url(server.url("/").to_string())
            .build();

        let req = ListTemplatesRequest::builder().count(100).offset(0).build();

        let resp = req
            .execute(&client)
            .await
            .expect("Should get a response and be able to json decode it");

        assert_eq!(resp.total_count, 2);
        assert_eq!(resp.templates.len(), 2);
        assert_eq!(resp.templates[0].template_id, 1234);
        assert_eq!(
            resp.templates[0].alias.as_deref(),
            Some("password-recovery")
        );
    }

    #[test]
    fn list_templates_uses_default_pagination() {
        let req = ListTemplatesRequest::builder().build();
        assert_eq!(req.endpoint(), "/templates?count=100&offset=0");
    }
}