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

//! Webhook subscriptions.

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

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

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

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

    /// Register a webhook endpoint.
    pub async fn create(&self, params: WebhookParams) -> Result<Webhook, Error> {
        self.client
            .request(
                self.client
                    .build(Method::POST, "/v1/webhooks", &[], Some(&params)),
            )
            .await
    }

    /// Retrieve a webhook.
    pub async fn get(&self, id: &str) -> Result<Webhook, Error> {
        self.client
            .request(
                self.client
                    .build::<()>(Method::GET, &format!("/v1/webhooks/{id}"), &[], None),
            )
            .await
    }

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

    /// Remove a webhook.
    pub async fn delete(&self, id: &str) -> Result<(), Error> {
        self.client
            .request_unit(self.client.build::<()>(
                Method::DELETE,
                &format!("/v1/webhooks/{id}"),
                &[],
                None,
            ))
            .await
    }
}

/// Parameters for creating a webhook.
#[derive(Debug, Clone, Serialize)]
pub struct WebhookParams {
    /// HTTPS URL to POST events to.
    pub url: String,
    /// Event types to subscribe to, e.g. `["email.delivered"]`.
    pub events: Vec<String>,
}

/// Webhook record returned by the API.
#[derive(Debug, Clone, Deserialize)]
pub struct Webhook {
    /// Webhook id.
    pub id: String,
    /// Endpoint URL.
    pub url: String,
    /// Subscribed events.
    pub events: Vec<String>,
    /// Signing secret (only returned on create).
    #[serde(default)]
    pub secret: Option<String>,
    /// Creation timestamp.
    pub created_at: String,
}