sentd 1.0.0

Official Rust SDK for the SENTD 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Request to send an email
#[derive(Debug, Clone, Serialize, Default)]
pub struct SendEmailRequest {
    pub from: String,
    pub to: Vec<String>,
    pub subject: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub html: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cc: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bcc: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reply_to: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attachments: Option<Vec<Attachment>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub headers: Option<HashMap<String, String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<HashMap<String, serde_json::Value>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tracking: Option<TrackingOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub routing: Option<RoutingOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_at: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_at_timezone: Option<String>,
}

/// Email attachment
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Attachment {
    pub filename: String,
    pub content: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content_type: Option<String>,
}

/// Tracking options
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TrackingOptions {
    pub opens: bool,
    pub clicks: bool,
}

/// Routing options
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RoutingOptions {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<String>,
}

/// Response from sending an email
#[derive(Debug, Clone, Deserialize)]
pub struct SendEmailResponse {
    pub data: SendEmailData,
}

#[derive(Debug, Clone, Deserialize)]
pub struct SendEmailData {
    pub id: String,
}

/// Email record
#[derive(Debug, Clone, Deserialize)]
pub struct Email {
    pub id: String,
    pub from: String,
    pub to: Vec<String>,
    pub subject: String,
    pub status: String,
    pub provider: Option<String>,
    pub metadata: Option<HashMap<String, serde_json::Value>>,
    pub created_at: String,
    pub sent_at: Option<String>,
    pub delivered_at: Option<String>,
}

/// Response from listing emails
#[derive(Debug, Clone, Deserialize)]
pub struct ListEmailsResponse {
    pub data: Vec<Email>,
    pub total: i64,
}

/// Response from getting an email
#[derive(Debug, Clone, Deserialize)]
pub struct GetEmailResponse {
    pub data: Email,
}

/// Request to send batch emails
#[derive(Debug, Clone, Serialize, Default)]
pub struct SendBatchRequest {
    pub emails: Vec<BatchEmail>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub html: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub template_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub template_data: Option<HashMap<String, serde_json::Value>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reply_to: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attachments: Option<Vec<Attachment>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tracking: Option<TrackingOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub routing: Option<RoutingOptions>,
}

/// Single email in a batch
#[derive(Debug, Clone, Serialize, Default)]
pub struct BatchEmail {
    pub to: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<HashMap<String, serde_json::Value>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_at: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub send_at_timezone: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<HashMap<String, serde_json::Value>>,
}

/// Response from sending batch
#[derive(Debug, Clone, Deserialize)]
pub struct SendBatchResponse {
    pub data: SendBatchData,
}

#[derive(Debug, Clone, Deserialize)]
pub struct SendBatchData {
    pub batch_id: String,
    pub email_ids: Vec<String>,
    pub accepted: i64,
    pub rejected: i64,
}

/// Email template
#[derive(Debug, Clone, Deserialize)]
pub struct Template {
    pub id: String,
    pub name: String,
    pub description: Option<String>,
    pub subject_template: String,
    pub html_template: String,
    pub text_template: Option<String>,
    pub variables: Option<Vec<TemplateVariable>>,
    pub default_from: Option<String>,
    pub reply_to: Option<String>,
    pub created_at: String,
    pub updated_at: String,
}

/// Template variable definition
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TemplateVariable {
    pub name: String,
    pub description: Option<String>,
    pub default_value: Option<String>,
    pub required: bool,
}

/// Request to create a template
#[derive(Debug, Clone, Serialize)]
pub struct CreateTemplateRequest {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    pub subject_template: String,
    pub html_template: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text_template: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub variables: Option<Vec<TemplateVariable>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_from: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reply_to: Option<String>,
}

/// Response containing a template
#[derive(Debug, Clone, Deserialize)]
pub struct TemplateResponse {
    pub data: Template,
}

/// Response from listing templates
#[derive(Debug, Clone, Deserialize)]
pub struct ListTemplatesResponse {
    pub data: Vec<Template>,
}

/// Response from previewing a template
#[derive(Debug, Clone, Deserialize)]
pub struct PreviewTemplateResponse {
    pub data: PreviewTemplateData,
}

#[derive(Debug, Clone, Deserialize)]
pub struct PreviewTemplateData {
    pub subject: String,
    pub html: String,
    pub text: Option<String>,
}

/// Sending domain
#[derive(Debug, Clone, Deserialize)]
pub struct Domain {
    pub id: String,
    pub domain: String,
    pub status: String,
    pub records: Option<Vec<DomainRecord>>,
    pub created_at: String,
    pub verified_at: Option<String>,
}

/// DNS record for domain verification
#[derive(Debug, Clone, Deserialize)]
pub struct DomainRecord {
    pub r#type: String,
    pub name: String,
    pub value: String,
    pub priority: Option<i32>,
    pub status: String,
}

/// Response containing a domain
#[derive(Debug, Clone, Deserialize)]
pub struct DomainResponse {
    pub data: Domain,
}

/// Response from listing domains
#[derive(Debug, Clone, Deserialize)]
pub struct ListDomainsResponse {
    pub data: Vec<Domain>,
}

/// Response from verifying a domain
#[derive(Debug, Clone, Deserialize)]
pub struct VerifyDomainResponse {
    pub data: VerifyDomainData,
}

#[derive(Debug, Clone, Deserialize)]
pub struct VerifyDomainData {
    pub verified: bool,
    pub records: Vec<DomainRecord>,
}

/// Webhook endpoint
#[derive(Debug, Clone, Deserialize)]
pub struct Webhook {
    pub id: String,
    pub url: String,
    pub events: Vec<String>,
    pub active: bool,
    pub secret: Option<String>,
    pub created_at: String,
    pub updated_at: String,
}

/// Request to create a webhook
#[derive(Debug, Clone, Serialize)]
pub struct CreateWebhookRequest {
    pub url: String,
    pub events: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active: Option<bool>,
}

/// Response containing a webhook
#[derive(Debug, Clone, Deserialize)]
pub struct WebhookResponse {
    pub data: Webhook,
}

/// Response from listing webhooks
#[derive(Debug, Clone, Deserialize)]
pub struct ListWebhooksResponse {
    pub data: Vec<Webhook>,
}

/// Analytics data
#[derive(Debug, Clone, Deserialize)]
pub struct AnalyticsResponse {
    pub data: AnalyticsData,
}

#[derive(Debug, Clone, Deserialize)]
pub struct AnalyticsData {
    pub total_sent: i64,
    pub total_delivered: i64,
    pub total_opened: i64,
    pub total_clicked: i64,
    pub total_bounced: i64,
    pub total_failed: i64,
    pub delivery_rate: f64,
    pub open_rate: f64,
    pub click_rate: f64,
    pub bounce_rate: f64,
    pub daily: Option<Vec<DailyStats>>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct DailyStats {
    pub date: String,
    pub sent: i64,
    pub delivered: i64,
    pub opened: i64,
    pub clicked: i64,
    pub bounced: i64,
    pub failed: i64,
}

/// Generic success response
#[derive(Debug, Clone, Deserialize)]
pub struct SuccessResponse {
    pub success: bool,
}