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

use std::borrow::Cow;

use crate::Endpoint;
use crate::api::domains::{DomainDetails, DomainId};
use crate::api::endpoint_with_path_segment;
use serde::Serialize;
use typed_builder::TypedBuilder;

/// Edit an existing domain. Only the ReturnPathDomain can be modified.
///
/// ```
/// use postmark::api::domains::EditDomainRequest;
/// let req = EditDomainRequest::builder()
///   .domain_id(36735)
///   .return_path_domain("pm-bounces.example.com")
///   .build();
/// ```
#[derive(Debug, Clone, PartialEq, Serialize)]
#[serde(rename_all = "PascalCase")]
#[derive(TypedBuilder)]
pub struct EditDomainRequest {
    /// Unique ID of the domain to edit.
    #[builder(setter(into))]
    #[serde(skip)]
    pub domain_id: DomainId,
    /// Custom Return-Path domain. Must be a subdomain of your From Email domain
    /// with a CNAME record pointing to `pm.mtasv.net`.
    #[builder(setter(into))]
    pub return_path_domain: String,
}

impl Endpoint for EditDomainRequest {
    type Request = EditDomainRequest;
    type Response = DomainDetails;

    fn endpoint(&self) -> Cow<'static, str> {
        endpoint_with_path_segment("/domains", &self.domain_id.to_string())
    }

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

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

#[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::*;

    const DOMAIN_ID: i64 = 36736;

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

        server.expect(
            Expectation::matching(request::method_path("PUT", format!("/domains/{DOMAIN_ID}")))
                .respond_with(json_encoded(json!({
                    "Name": "example.com",
                    "SPFVerified": false,
                    "SPFHost": "example.com",
                    "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
                    "DKIMVerified": false,
                    "WeakDKIM": false,
                    "DKIMHost": "20160921046319pm._domainkey.example.com",
                    "DKIMTextValue": "k=rsa;p=MIGfMA0GDRrFQJc5dZEBAQUAA4GNADCBiQKBgQCFn...",
                    "DKIMPendingHost": "20131031155228pm._domainkey.example.com",
                    "DKIMPendingTextValue": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
                    "DKIMRevokedHost": "",
                    "DKIMRevokedTextValue": "",
                    "SafeToRemoveRevokedKeyFromDNS": false,
                    "DKIMUpdateStatus": "Pending",
                    "ReturnPathDomain": "pm-bounces.example.com",
                    "ReturnPathDomainVerified": false,
                    "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
                    "ID": 36736
                }))),
        );

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

        let req = EditDomainRequest::builder()
            .domain_id(DOMAIN_ID)
            .return_path_domain("pm-bounces.example.com")
            .build();

        assert_eq!(
            serde_json::to_value(&req).unwrap(),
            json!({
                "ReturnPathDomain": "pm-bounces.example.com",
            })
        );

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

        assert_eq!(resp.return_path_domain, "pm-bounces.example.com");
        assert_eq!(resp.id, DOMAIN_ID);
    }
}