anypost 1.0.0

Official Rust SDK for the Anypost 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

use std::sync::Arc;

use serde::Serialize;

use crate::error::Result;
use crate::http::HttpClient;
use crate::resources::{enc, to_value};
use crate::response::{Page, Response};
use crate::transport::Method;
use crate::types::params::ListParams;

/// Operations on the `/domains` endpoints.
pub struct Domains {
    http: Arc<HttpClient>,
}

impl Domains {
    pub(crate) fn new(http: Arc<HttpClient>) -> Self {
        Self { http }
    }

    /// List the team's domains, newest-first. Returns one page.
    pub async fn list(&self, params: ListParams) -> Result<Page> {
        self.http
            .list(
                "/domains",
                vec![
                    ("limit", params.limit.map(|n| n.to_string())),
                    ("after", params.after),
                ],
            )
            .await
    }

    /// List every domain, walking all pages.
    pub async fn list_all(&self, params: ListParams) -> Result<Vec<Response>> {
        self.http
            .list_all(
                "/domains",
                vec![("limit", params.limit.map(|n| n.to_string()))],
            )
            .await
    }

    /// Add a sending domain. The returned domain is `pending` until verified.
    pub async fn create(&self, body: impl Serialize) -> Result<Response> {
        self.http
            .request_object(Method::Post, "/domains", Some(to_value(body)?), false, None)
            .await
    }

    /// Retrieve a single domain by id.
    pub async fn get(&self, id: &str) -> Result<Response> {
        self.http
            .request_object(
                Method::Get,
                &format!("/domains/{}", enc(id)),
                None,
                false,
                None,
            )
            .await
    }

    /// Update a domain's tracking configuration. The domain `name` is immutable.
    pub async fn update(&self, id: &str, body: impl Serialize) -> Result<Response> {
        self.http
            .request_object(
                Method::Patch,
                &format!("/domains/{}", enc(id)),
                Some(to_value(body)?),
                false,
                None,
            )
            .await
    }

    /// Permanently delete a domain and its DKIM keys.
    pub async fn delete(&self, id: &str) -> Result<()> {
        self.http
            .request_empty(Method::Delete, &format!("/domains/{}", enc(id)))
            .await
    }

    /// Trigger a verification check. Always returns the current domain — read
    /// `status` and `verification_failure`; a still-`pending` domain does not
    /// raise. Safe to poll while DNS propagates.
    pub async fn verify(&self, id: &str) -> Result<Response> {
        self.http
            .request_object(
                Method::Post,
                &format!("/domains/{}/verify", enc(id)),
                None,
                false,
                None,
            )
            .await
    }
}