lettr 1.0.0

Official Rust SDK for the Lettr 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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
use std::collections::HashMap;
use std::sync::Arc;

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

use crate::config::Config;

// ── Enum Types ────────────────────────────────────────────────────────────

/// Delivery state of an email.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum EmailState {
    Scheduled,
    Delivered,
    Bounced,
    Failed,
    /// An unknown state not yet covered by this enum.
    #[serde(untagged)]
    Unknown(String),
}

impl std::fmt::Display for EmailState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Scheduled => write!(f, "scheduled"),
            Self::Delivered => write!(f, "delivered"),
            Self::Bounced => write!(f, "bounced"),
            Self::Failed => write!(f, "failed"),
            Self::Unknown(s) => write!(f, "{s}"),
        }
    }
}

/// State of a scheduled email transmission.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum ScheduledEmailState {
    Submitted,
    Generating,
    Scheduled,
    Delivered,
    Bounced,
    Failed,
    Unknown,
    /// A state not yet covered by this enum.
    #[serde(untagged)]
    Other(String),
}

impl std::fmt::Display for ScheduledEmailState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Submitted => write!(f, "submitted"),
            Self::Generating => write!(f, "generating"),
            Self::Scheduled => write!(f, "scheduled"),
            Self::Delivered => write!(f, "delivered"),
            Self::Bounced => write!(f, "bounced"),
            Self::Failed => write!(f, "failed"),
            Self::Unknown => write!(f, "unknown"),
            Self::Other(s) => write!(f, "{s}"),
        }
    }
}

/// Type of an email event.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum EventType {
    Injection,
    Delivery,
    Bounce,
    Delay,
    OutOfBand,
    SpamComplaint,
    PolicyRejection,
    Click,
    Open,
    InitialOpen,
    AmpClick,
    AmpOpen,
    AmpInitialOpen,
    GenerationFailure,
    GenerationRejection,
    ListUnsubscribe,
    LinkUnsubscribe,
    /// An unknown event type not yet covered by this enum.
    #[serde(untagged)]
    Unknown(String),
}

impl std::fmt::Display for EventType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Injection => write!(f, "injection"),
            Self::Delivery => write!(f, "delivery"),
            Self::Bounce => write!(f, "bounce"),
            Self::Delay => write!(f, "delay"),
            Self::OutOfBand => write!(f, "out_of_band"),
            Self::SpamComplaint => write!(f, "spam_complaint"),
            Self::PolicyRejection => write!(f, "policy_rejection"),
            Self::Click => write!(f, "click"),
            Self::Open => write!(f, "open"),
            Self::InitialOpen => write!(f, "initial_open"),
            Self::AmpClick => write!(f, "amp_click"),
            Self::AmpOpen => write!(f, "amp_open"),
            Self::AmpInitialOpen => write!(f, "amp_initial_open"),
            Self::GenerationFailure => write!(f, "generation_failure"),
            Self::GenerationRejection => write!(f, "generation_rejection"),
            Self::ListUnsubscribe => write!(f, "list_unsubscribe"),
            Self::LinkUnsubscribe => write!(f, "link_unsubscribe"),
            Self::Unknown(s) => write!(f, "{s}"),
        }
    }
}

/// Service for the `/emails` endpoints.
#[derive(Clone, Debug)]
pub struct EmailsSvc(pub(crate) Arc<Config>);

impl EmailsSvc {
    /// Send a transactional email.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::{Lettr, CreateEmailOptions};
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let email = CreateEmailOptions::new("sender@example.com", ["user@example.com"], "Hello!")
    ///     .with_html("<h1>Welcome!</h1>")
    ///     .with_text("Welcome!");
    ///
    /// let response = client.emails.send(email).await?;
    /// println!("Request ID: {}", response.request_id);
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn send(&self, email: CreateEmailOptions) -> crate::Result<SendEmailResponse> {
        let request = self.0.build(Method::POST, "/emails").json(&email);
        let response = self.0.send(request).await?;
        let wrapper = response.json::<SendEmailResponseWrapper>().await?;
        Ok(wrapper.data)
    }

    /// Send a transactional email and return quota information.
    ///
    /// Same as [`send`](Self::send), but also parses rate-limit headers
    /// (`X-Monthly-Limit`, `X-Daily-Remaining`, etc.) from the response.
    /// Quota headers are only present for free-tier teams.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::{Lettr, CreateEmailOptions};
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let email = CreateEmailOptions::new("sender@example.com", ["user@example.com"], "Hello!")
    ///     .with_html("<h1>Welcome!</h1>");
    ///
    /// let result = client.emails.send_with_quota(email).await?;
    /// println!("Request ID: {}", result.response.request_id);
    /// if let Some(quota) = &result.quota {
    ///     println!("Monthly remaining: {:?}", quota.monthly_remaining);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn send_with_quota(
        &self,
        email: CreateEmailOptions,
    ) -> crate::Result<SendEmailWithQuotaResponse> {
        let request = self.0.build(Method::POST, "/emails").json(&email);
        let response = self.0.send(request).await?;
        let quota = QuotaInfo::from_headers(response.headers());
        let wrapper = response.json::<SendEmailResponseWrapper>().await?;
        Ok(SendEmailWithQuotaResponse {
            response: wrapper.data,
            quota,
        })
    }

    /// Retrieve a list of sent emails with optional filtering and pagination.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::Lettr;
    /// # use lettr::emails::ListEmailsOptions;
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let options = ListEmailsOptions::new().per_page(10);
    /// let response = client.emails.list(options).await?;
    ///
    /// for email in &response.events.data {
    ///     println!("{}: {:?}", email.event_id, email.subject);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn list(&self, options: ListEmailsOptions) -> crate::Result<ListEmailsResponse> {
        let mut request = self.0.build(Method::GET, "/emails");

        if let Some(per_page) = options.per_page {
            request = request.query(&[("per_page", per_page.to_string())]);
        }
        if let Some(ref cursor) = options.cursor {
            request = request.query(&[("cursor", cursor.as_str())]);
        }
        if let Some(ref recipients) = options.recipients {
            request = request.query(&[("recipients", recipients.as_str())]);
        }
        if let Some(ref from) = options.from {
            request = request.query(&[("from", from.as_str())]);
        }
        if let Some(ref to) = options.to {
            request = request.query(&[("to", to.as_str())]);
        }

        let response = self.0.send(request).await?;
        let wrapper = response.json::<ListEmailsResponseWrapper>().await?;
        Ok(wrapper.data)
    }

    /// Retrieve detailed events for a specific email by its request ID.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::Lettr;
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let detail = client.emails.get("request-id-here", None, None).await?;
    /// println!("State: {}, Recipients: {}", detail.state, detail.num_recipients);
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn get(
        &self,
        request_id: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> crate::Result<GetEmailResponse> {
        let path = format!("/emails/{request_id}");
        let mut request = self.0.build(Method::GET, &path);

        if let Some(from) = from {
            request = request.query(&[("from", from)]);
        }
        if let Some(to) = to {
            request = request.query(&[("to", to)]);
        }

        let response = self.0.send(request).await?;
        let wrapper = response.json::<GetEmailResponseWrapper>().await?;
        Ok(wrapper.data)
    }

    /// List email events with optional filtering and pagination.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::Lettr;
    /// # use lettr::emails::ListEmailEventsOptions;
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let options = ListEmailEventsOptions::new()
    ///     .events(vec!["delivery".into(), "bounce".into()])
    ///     .per_page(10);
    /// let response = client.emails.list_events(options).await?;
    ///
    /// for event in &response.events.data {
    ///     println!("{}: {}", &event.event_type, event.timestamp);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn list_events(
        &self,
        options: ListEmailEventsOptions,
    ) -> crate::Result<ListEmailEventsResponse> {
        let mut request = self.0.build(Method::GET, "/emails/events");

        if let Some(ref events) = options.events {
            let joined = events.join(",");
            request = request.query(&[("events", &joined)]);
        }
        if let Some(ref recipients) = options.recipients {
            let joined = recipients.join(",");
            request = request.query(&[("recipients", &joined)]);
        }
        if let Some(ref from) = options.from {
            request = request.query(&[("from", from.as_str())]);
        }
        if let Some(ref to) = options.to {
            request = request.query(&[("to", to.as_str())]);
        }
        if let Some(per_page) = options.per_page {
            request = request.query(&[("per_page", per_page.to_string())]);
        }
        if let Some(ref cursor) = options.cursor {
            request = request.query(&[("cursor", cursor.as_str())]);
        }
        if let Some(ref transmissions) = options.transmissions {
            request = request.query(&[("transmissions", transmissions.as_str())]);
        }
        if let Some(ref bounce_classes) = options.bounce_classes {
            request = request.query(&[("bounce_classes", bounce_classes.as_str())]);
        }

        let response = self.0.send(request).await?;
        let wrapper = response.json::<ListEmailEventsResponseWrapper>().await?;
        Ok(wrapper.data)
    }

    /// Schedule an email for future delivery.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::{Lettr, CreateEmailOptions};
    /// # use lettr::emails::ScheduleEmailOptions;
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let email = CreateEmailOptions::new("sender@example.com", ["user@example.com"], "Hello!")
    ///     .with_html("<h1>Scheduled!</h1>");
    ///
    /// let options = ScheduleEmailOptions::new(email, "2024-01-16T10:00:00Z");
    /// let response = client.emails.schedule(options).await?;
    /// println!("Request ID: {}", response.request_id);
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn schedule(
        &self,
        options: ScheduleEmailOptions,
    ) -> crate::Result<SendEmailResponse> {
        let request = self
            .0
            .build(Method::POST, "/emails/scheduled")
            .json(&options);
        let response = self.0.send(request).await?;
        let wrapper = response.json::<SendEmailResponseWrapper>().await?;
        Ok(wrapper.data)
    }

    /// Schedule an email and return quota information.
    ///
    /// Same as [`schedule`](Self::schedule), but also parses rate-limit headers.
    /// Quota headers are only present for free-tier teams.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::Lettr;
    /// # use lettr::emails::{CreateEmailOptions, ScheduleEmailOptions};
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let email = CreateEmailOptions::new("sender@example.com", ["user@example.com"], "Hello!")
    ///     .with_html("<h1>Scheduled!</h1>");
    ///
    /// let options = ScheduleEmailOptions::new(email, "2024-01-16T10:00:00Z");
    /// let result = client.emails.schedule_with_quota(options).await?;
    /// println!("Request ID: {}", result.response.request_id);
    /// if let Some(quota) = &result.quota {
    ///     println!("Daily remaining: {:?}", quota.daily_remaining);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn schedule_with_quota(
        &self,
        options: ScheduleEmailOptions,
    ) -> crate::Result<SendEmailWithQuotaResponse> {
        let request = self
            .0
            .build(Method::POST, "/emails/scheduled")
            .json(&options);
        let response = self.0.send(request).await?;
        let quota = QuotaInfo::from_headers(response.headers());
        let wrapper = response.json::<SendEmailResponseWrapper>().await?;
        Ok(SendEmailWithQuotaResponse {
            response: wrapper.data,
            quota,
        })
    }

    /// Retrieve details of a scheduled email.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::Lettr;
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// let scheduled = client.emails.get_scheduled("12345678901234567890").await?;
    /// println!("State: {}, Scheduled at: {:?}", scheduled.state, scheduled.scheduled_at);
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn get_scheduled(
        &self,
        transmission_id: &str,
    ) -> crate::Result<ScheduledTransmission> {
        let path = format!("/emails/scheduled/{transmission_id}");
        let request = self.0.build(Method::GET, &path);
        let response = self.0.send(request).await?;
        let wrapper = response
            .json::<ScheduledTransmissionResponseWrapper>()
            .await?;
        Ok(wrapper.data)
    }

    /// Cancel a scheduled email.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// # use lettr::Lettr;
    /// # async fn run() -> lettr::Result<()> {
    /// let client = Lettr::new("your-api-key");
    ///
    /// client.emails.cancel_scheduled("12345678901234567890").await?;
    /// println!("Scheduled email cancelled.");
    /// # Ok(())
    /// # }
    /// ```
    #[maybe_async::maybe_async]
    pub async fn cancel_scheduled(&self, transmission_id: &str) -> crate::Result<()> {
        let path = format!("/emails/scheduled/{transmission_id}");
        let request = self.0.build(Method::DELETE, &path);
        self.0.send(request).await?;
        Ok(())
    }
}

// ── Request Types ──────────────────────────────────────────────────────────

/// Options for sending an email via the Lettr API.
///
/// Use the builder methods to construct the email step by step.
///
/// At minimum, `from`, `to`, and either `html`, `text`, or `template_slug` must be provided.
/// The `subject` is required unless `template_slug` is provided.
#[must_use]
#[derive(Debug, Clone, Serialize)]
pub struct CreateEmailOptions {
    /// Sender email address.
    from: String,

    /// Sender display name.
    #[serde(skip_serializing_if = "Option::is_none")]
    from_name: Option<String>,

    /// Email subject. Optional when using a template.
    #[serde(skip_serializing_if = "Option::is_none")]
    subject: Option<String>,

    /// Recipient email addresses.
    to: Vec<String>,

    /// CC recipient email addresses.
    #[serde(skip_serializing_if = "Option::is_none")]
    cc: Option<Vec<String>>,

    /// BCC recipient email addresses.
    #[serde(skip_serializing_if = "Option::is_none")]
    bcc: Option<Vec<String>>,

    /// Reply-to email address.
    #[serde(skip_serializing_if = "Option::is_none")]
    reply_to: Option<String>,

    /// Reply-to display name.
    #[serde(skip_serializing_if = "Option::is_none")]
    reply_to_name: Option<String>,

    /// HTML body.
    #[serde(skip_serializing_if = "Option::is_none")]
    html: Option<String>,

    /// Plain text body.
    #[serde(skip_serializing_if = "Option::is_none")]
    text: Option<String>,

    /// AMP HTML content for supported email clients.
    #[serde(skip_serializing_if = "Option::is_none")]
    amp_html: Option<String>,

    /// Project ID for template lookup.
    #[serde(skip_serializing_if = "Option::is_none")]
    project_id: Option<u64>,

    /// Template slug for sending with a pre-defined template.
    #[serde(skip_serializing_if = "Option::is_none")]
    template_slug: Option<String>,

    /// Template version number.
    #[serde(skip_serializing_if = "Option::is_none")]
    template_version: Option<u32>,

    /// Tag for tracking and analytics.
    #[serde(skip_serializing_if = "Option::is_none")]
    tag: Option<String>,

    /// Custom metadata.
    #[serde(skip_serializing_if = "Option::is_none")]
    metadata: Option<HashMap<String, String>>,

    /// Custom email headers.
    #[serde(skip_serializing_if = "Option::is_none")]
    headers: Option<HashMap<String, String>>,

    /// Substitution data for template personalization.
    #[serde(skip_serializing_if = "Option::is_none")]
    substitution_data: Option<HashMap<String, String>>,

    /// Tracking and delivery options.
    #[serde(skip_serializing_if = "Option::is_none")]
    options: Option<EmailOptions>,

    /// File attachments.
    #[serde(skip_serializing_if = "Option::is_none")]
    attachments: Option<Vec<Attachment>>,
}

impl CreateEmailOptions {
    /// Creates a new [`CreateEmailOptions`] with a subject.
    ///
    /// # Example
    ///
    /// ```
    /// use lettr::CreateEmailOptions;
    ///
    /// let email = CreateEmailOptions::new(
    ///     "sender@example.com",
    ///     ["recipient@example.com"],
    ///     "Hello World",
    /// )
    /// .with_html("<h1>Hello!</h1>")
    /// .with_text("Hello!");
    /// ```
    pub fn new<T, A>(from: impl Into<String>, to: T, subject: impl Into<String>) -> Self
    where
        T: IntoIterator<Item = A>,
        A: Into<String>,
    {
        Self {
            from: from.into(),
            from_name: None,
            subject: Some(subject.into()),
            to: to.into_iter().map(Into::into).collect(),
            cc: None,
            bcc: None,
            reply_to: None,
            reply_to_name: None,
            html: None,
            text: None,
            amp_html: None,
            project_id: None,
            template_slug: None,
            template_version: None,
            tag: None,
            metadata: None,
            headers: None,
            substitution_data: None,
            options: None,
            attachments: None,
        }
    }

    /// Creates a new [`CreateEmailOptions`] for sending with a template (no subject required).
    ///
    /// # Example
    ///
    /// ```
    /// use lettr::CreateEmailOptions;
    ///
    /// let email = CreateEmailOptions::new_with_template(
    ///     "sender@example.com",
    ///     ["recipient@example.com"],
    ///     "welcome-email",
    /// )
    /// .with_substitution("first_name", "John");
    /// ```
    pub fn new_with_template<T, A>(
        from: impl Into<String>,
        to: T,
        template_slug: impl Into<String>,
    ) -> Self
    where
        T: IntoIterator<Item = A>,
        A: Into<String>,
    {
        Self {
            from: from.into(),
            from_name: None,
            subject: None,
            to: to.into_iter().map(Into::into).collect(),
            cc: None,
            bcc: None,
            reply_to: None,
            reply_to_name: None,
            html: None,
            text: None,
            amp_html: None,
            project_id: None,
            template_slug: Some(template_slug.into()),
            template_version: None,
            tag: None,
            metadata: None,
            headers: None,
            substitution_data: None,
            options: None,
            attachments: None,
        }
    }

    /// Sets the sender display name.
    #[inline]
    pub fn with_from_name(mut self, name: impl Into<String>) -> Self {
        self.from_name = Some(name.into());
        self
    }

    /// Sets the email subject.
    #[inline]
    pub fn with_subject(mut self, subject: impl Into<String>) -> Self {
        self.subject = Some(subject.into());
        self
    }

    /// Adds a CC recipient email address.
    #[inline]
    pub fn with_cc(mut self, address: impl Into<String>) -> Self {
        self.cc.get_or_insert_with(Vec::new).push(address.into());
        self
    }

    /// Adds a BCC recipient email address.
    #[inline]
    pub fn with_bcc(mut self, address: impl Into<String>) -> Self {
        self.bcc.get_or_insert_with(Vec::new).push(address.into());
        self
    }

    /// Sets the reply-to email address.
    #[inline]
    pub fn with_reply_to(mut self, address: impl Into<String>) -> Self {
        self.reply_to = Some(address.into());
        self
    }

    /// Sets the reply-to display name.
    #[inline]
    pub fn with_reply_to_name(mut self, name: impl Into<String>) -> Self {
        self.reply_to_name = Some(name.into());
        self
    }

    /// Sets the HTML body of the email.
    #[inline]
    pub fn with_html(mut self, html: impl Into<String>) -> Self {
        self.html = Some(html.into());
        self
    }

    /// Sets the plain text body of the email.
    #[inline]
    pub fn with_text(mut self, text: impl Into<String>) -> Self {
        self.text = Some(text.into());
        self
    }

    /// Sets the AMP HTML content for supported email clients.
    #[inline]
    pub fn with_amp_html(mut self, amp_html: impl Into<String>) -> Self {
        self.amp_html = Some(amp_html.into());
        self
    }

    /// Sets the template slug for sending with a pre-defined template.
    #[inline]
    pub fn with_template(mut self, slug: impl Into<String>) -> Self {
        self.template_slug = Some(slug.into());
        self
    }

    /// Sets the template version.
    #[inline]
    pub fn with_template_version(mut self, version: u32) -> Self {
        self.template_version = Some(version);
        self
    }

    /// Sets the project ID for template lookup.
    #[inline]
    pub fn with_project_id(mut self, project_id: u64) -> Self {
        self.project_id = Some(project_id);
        self
    }

    /// Sets the tag for tracking and analytics.
    #[inline]
    pub fn with_tag(mut self, tag: impl Into<String>) -> Self {
        self.tag = Some(tag.into());
        self
    }

    /// Adds a substitution data key-value pair for template personalization.
    #[inline]
    pub fn with_substitution(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.substitution_data
            .get_or_insert_with(HashMap::new)
            .insert(key.into(), value.into());
        self
    }

    /// Sets all substitution data at once.
    #[inline]
    pub fn with_substitution_data(mut self, data: HashMap<String, String>) -> Self {
        self.substitution_data = Some(data);
        self
    }

    /// Adds a metadata key-value pair.
    #[inline]
    pub fn with_metadata_entry(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.metadata
            .get_or_insert_with(HashMap::new)
            .insert(key.into(), value.into());
        self
    }

    /// Sets all metadata at once.
    #[inline]
    pub fn with_metadata(mut self, metadata: HashMap<String, String>) -> Self {
        self.metadata = Some(metadata);
        self
    }

    /// Adds a custom email header.
    #[inline]
    pub fn with_header(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.headers
            .get_or_insert_with(HashMap::new)
            .insert(key.into(), value.into());
        self
    }

    /// Sets all custom email headers at once.
    #[inline]
    pub fn with_headers(mut self, headers: HashMap<String, String>) -> Self {
        self.headers = Some(headers);
        self
    }

    /// Adds a file attachment.
    #[inline]
    pub fn with_attachment(mut self, attachment: Attachment) -> Self {
        self.attachments
            .get_or_insert_with(Vec::new)
            .push(attachment);
        self
    }

    /// Enables or disables click tracking.
    #[inline]
    pub fn with_click_tracking(mut self, enabled: bool) -> Self {
        self.options
            .get_or_insert_with(EmailOptions::default)
            .click_tracking = Some(enabled);
        self
    }

    /// Enables or disables open tracking.
    #[inline]
    pub fn with_open_tracking(mut self, enabled: bool) -> Self {
        self.options
            .get_or_insert_with(EmailOptions::default)
            .open_tracking = Some(enabled);
        self
    }

    /// Sets whether the email is transactional.
    #[inline]
    pub fn with_transactional(mut self, transactional: bool) -> Self {
        self.options
            .get_or_insert_with(EmailOptions::default)
            .transactional = Some(transactional);
        self
    }

    /// Enables or disables CSS inlining.
    #[inline]
    pub fn with_inline_css(mut self, enabled: bool) -> Self {
        self.options
            .get_or_insert_with(EmailOptions::default)
            .inline_css = Some(enabled);
        self
    }

    /// Enables or disables variable substitutions in content.
    #[inline]
    pub fn with_perform_substitutions(mut self, enabled: bool) -> Self {
        self.options
            .get_or_insert_with(EmailOptions::default)
            .perform_substitutions = Some(enabled);
        self
    }
}

/// Tracking and delivery options for an email.
#[must_use]
#[derive(Debug, Default, Clone, Serialize)]
pub struct EmailOptions {
    /// Enable click tracking.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub click_tracking: Option<bool>,

    /// Enable open tracking.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub open_tracking: Option<bool>,

    /// Mark as transactional email.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub transactional: Option<bool>,

    /// Inline CSS styles in HTML content.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub inline_css: Option<bool>,

    /// Perform variable substitutions in content.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub perform_substitutions: Option<bool>,
}

/// A file attachment for an email.
///
/// Attachments must be base64-encoded.
///
/// # Example
///
/// ```
/// use lettr::Attachment;
///
/// let attachment = Attachment::new("invoice.pdf", "application/pdf", "base64data...");
/// ```
#[must_use]
#[derive(Debug, Clone, Serialize)]
pub struct Attachment {
    /// Filename of the attachment.
    pub name: String,
    /// MIME type (e.g. `"application/pdf"`).
    #[serde(rename = "type")]
    pub content_type: String,
    /// Base64-encoded file content.
    pub data: String,
}

impl Attachment {
    /// Creates a new [`Attachment`].
    pub fn new(
        name: impl Into<String>,
        content_type: impl Into<String>,
        data: impl Into<String>,
    ) -> Self {
        Self {
            name: name.into(),
            content_type: content_type.into(),
            data: data.into(),
        }
    }
}

/// Options for listing sent emails.
#[must_use]
#[derive(Debug, Default, Clone)]
pub struct ListEmailsOptions {
    per_page: Option<u32>,
    cursor: Option<String>,
    recipients: Option<String>,
    from: Option<String>,
    to: Option<String>,
}

impl ListEmailsOptions {
    /// Creates new [`ListEmailsOptions`] with default values.
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the number of results per page (1-100).
    #[inline]
    pub fn per_page(mut self, per_page: u32) -> Self {
        self.per_page = Some(per_page);
        self
    }

    /// Sets the pagination cursor from a previous response.
    #[inline]
    pub fn cursor(mut self, cursor: impl Into<String>) -> Self {
        self.cursor = Some(cursor.into());
        self
    }

    /// Filters by recipient email address.
    #[inline]
    pub fn recipients(mut self, recipients: impl Into<String>) -> Self {
        self.recipients = Some(recipients.into());
        self
    }

    /// Filters emails sent on or after this date (YYYY-MM-DD format).
    #[inline]
    pub fn from_date(mut self, from: impl Into<String>) -> Self {
        self.from = Some(from.into());
        self
    }

    /// Filters emails sent on or before this date (YYYY-MM-DD format).
    #[inline]
    pub fn to_date(mut self, to: impl Into<String>) -> Self {
        self.to = Some(to.into());
        self
    }
}

/// Options for listing email events.
#[must_use]
#[derive(Debug, Default, Clone)]
pub struct ListEmailEventsOptions {
    events: Option<Vec<String>>,
    recipients: Option<Vec<String>>,
    from: Option<String>,
    to: Option<String>,
    per_page: Option<u32>,
    cursor: Option<String>,
    transmissions: Option<String>,
    bounce_classes: Option<String>,
}

impl ListEmailEventsOptions {
    /// Creates new [`ListEmailEventsOptions`] with default values.
    pub fn new() -> Self {
        Self::default()
    }

    /// Filters by event types (e.g. `["delivery", "bounce"]`).
    #[inline]
    pub fn events(mut self, events: Vec<String>) -> Self {
        self.events = Some(events);
        self
    }

    /// Filters by recipient email addresses.
    #[inline]
    pub fn recipients(mut self, recipients: Vec<String>) -> Self {
        self.recipients = Some(recipients);
        self
    }

    /// Filters events from this date (YYYY-MM-DD format).
    #[inline]
    pub fn from_date(mut self, from: impl Into<String>) -> Self {
        self.from = Some(from.into());
        self
    }

    /// Filters events until this date (YYYY-MM-DD format).
    #[inline]
    pub fn to_date(mut self, to: impl Into<String>) -> Self {
        self.to = Some(to.into());
        self
    }

    /// Sets the number of results per page (1-100).
    #[inline]
    pub fn per_page(mut self, per_page: u32) -> Self {
        self.per_page = Some(per_page);
        self
    }

    /// Sets the pagination cursor from a previous response.
    #[inline]
    pub fn cursor(mut self, cursor: impl Into<String>) -> Self {
        self.cursor = Some(cursor.into());
        self
    }

    /// Filters by transmission ID.
    #[inline]
    pub fn transmissions(mut self, transmissions: impl Into<String>) -> Self {
        self.transmissions = Some(transmissions.into());
        self
    }

    /// Filters by bounce classes (comma-separated, e.g. `"10,30"`).
    #[inline]
    pub fn bounce_classes(mut self, bounce_classes: impl Into<String>) -> Self {
        self.bounce_classes = Some(bounce_classes.into());
        self
    }
}

/// Options for scheduling an email for future delivery.
#[must_use]
#[derive(Debug, Clone, Serialize)]
pub struct ScheduleEmailOptions {
    /// The email to schedule.
    #[serde(flatten)]
    pub email: CreateEmailOptions,

    /// The UTC date/time when the email should be sent (ISO 8601).
    /// Must be at least 5 minutes in the future and within 3 days.
    pub scheduled_at: String,
}

impl ScheduleEmailOptions {
    /// Creates a new [`ScheduleEmailOptions`].
    pub fn new(email: CreateEmailOptions, scheduled_at: impl Into<String>) -> Self {
        Self {
            email,
            scheduled_at: scheduled_at.into(),
        }
    }
}

// ── Response Types ─────────────────────────────────────────────────────────

#[derive(Debug, Deserialize)]
struct SendEmailResponseWrapper {
    #[allow(dead_code)]
    message: String,
    data: SendEmailResponse,
}

/// Successful response from sending an email.
#[derive(Debug, Clone, Deserialize)]
pub struct SendEmailResponse {
    /// Unique request ID for the transmission.
    pub request_id: String,
    /// Number of accepted recipients.
    pub accepted: u32,
    /// Number of rejected recipients.
    pub rejected: u32,
}

/// Successful response from sending an email, including quota information.
///
/// Quota headers are only present for free-tier teams.
#[derive(Debug, Clone)]
pub struct SendEmailWithQuotaResponse {
    /// The email send response data.
    pub response: SendEmailResponse,
    /// Rate-limit / quota information (only present for free-tier teams).
    pub quota: Option<QuotaInfo>,
}

/// Rate-limit and quota information returned in response headers.
///
/// These headers are only present for free-tier teams.
#[derive(Debug, Clone)]
pub struct QuotaInfo {
    /// Total monthly email limit.
    pub monthly_limit: Option<u64>,
    /// Remaining emails allowed this month.
    pub monthly_remaining: Option<u64>,
    /// Unix timestamp when the monthly quota resets.
    pub monthly_reset: Option<u64>,
    /// Total daily email limit.
    pub daily_limit: Option<u64>,
    /// Remaining emails allowed today.
    pub daily_remaining: Option<u64>,
    /// Unix timestamp when the daily quota resets.
    pub daily_reset: Option<u64>,
}

impl QuotaInfo {
    fn from_headers(headers: &reqwest::header::HeaderMap) -> Option<Self> {
        let get = |name: &str| -> Option<u64> { headers.get(name)?.to_str().ok()?.parse().ok() };

        let info = Self {
            monthly_limit: get("X-Monthly-Limit"),
            monthly_remaining: get("X-Monthly-Remaining"),
            monthly_reset: get("X-Monthly-Reset"),
            daily_limit: get("X-Daily-Limit"),
            daily_remaining: get("X-Daily-Remaining"),
            daily_reset: get("X-Daily-Reset"),
        };

        // Only return Some if at least one header was present.
        if info.monthly_limit.is_some()
            || info.monthly_remaining.is_some()
            || info.daily_limit.is_some()
            || info.daily_remaining.is_some()
        {
            Some(info)
        } else {
            None
        }
    }
}

#[derive(Debug, Deserialize)]
struct ListEmailsResponseWrapper {
    #[allow(dead_code)]
    message: String,
    data: ListEmailsResponse,
}

/// Response from listing sent emails.
#[derive(Debug, Clone, Deserialize)]
pub struct ListEmailsResponse {
    /// Email events data with pagination.
    pub events: SentEmailEventsData,
}

/// Sent email events data container.
#[derive(Debug, Clone, Deserialize)]
pub struct SentEmailEventsData {
    /// List of sent email events.
    pub data: Vec<SentEmailListItem>,
    /// Total number of matching emails.
    pub total_count: u64,
    /// Start of the query date range.
    pub from: Option<String>,
    /// End of the query date range.
    pub to: Option<String>,
    /// Pagination information.
    pub pagination: Pagination,
}

/// A sent email list item (returned from list endpoint).
#[derive(Debug, Clone, Deserialize)]
pub struct SentEmailListItem {
    /// Unique event ID.
    pub event_id: String,
    /// Event type.
    #[serde(rename = "type")]
    pub event_type: EventType,
    /// Timestamp of the event.
    pub timestamp: String,
    /// Transmission request ID.
    #[serde(default)]
    pub request_id: Option<String>,
    /// Message ID.
    #[serde(default)]
    pub message_id: Option<String>,
    /// Email subject.
    #[serde(default)]
    pub subject: Option<String>,
    /// Sender email address.
    #[serde(default)]
    pub friendly_from: Option<String>,
    /// Sending domain.
    #[serde(default)]
    pub sending_domain: Option<String>,
    /// Recipient email address.
    #[serde(default)]
    pub rcpt_to: Option<String>,
    /// Raw recipient email address.
    #[serde(default)]
    pub raw_rcpt_to: Option<String>,
    /// Recipient domain.
    #[serde(default)]
    pub recipient_domain: Option<String>,
    /// Mailbox provider.
    #[serde(default)]
    pub mailbox_provider: Option<String>,
    /// Mailbox provider region.
    #[serde(default)]
    pub mailbox_provider_region: Option<String>,
    /// Sending IP address.
    #[serde(default)]
    pub sending_ip: Option<String>,
    /// Whether click tracking is enabled.
    #[serde(default)]
    pub click_tracking: Option<bool>,
    /// Whether open tracking is enabled.
    #[serde(default)]
    pub open_tracking: Option<bool>,
    /// Whether this is a transactional email.
    #[serde(default)]
    pub transactional: Option<bool>,
    /// Message size in bytes.
    #[serde(default)]
    pub msg_size: Option<u64>,
    /// Injection time.
    #[serde(default)]
    pub injection_time: Option<String>,
    /// Recipient metadata.
    #[serde(default)]
    pub rcpt_meta: Option<serde_json::Value>,
}

/// Pagination metadata for list responses.
#[derive(Debug, Clone, Deserialize)]
pub struct Pagination {
    /// Cursor for fetching the next page, if available.
    pub next_cursor: Option<String>,
    /// Number of results per page.
    pub per_page: u32,
}

#[derive(Debug, Deserialize)]
struct GetEmailResponseWrapper {
    #[allow(dead_code)]
    message: String,
    data: GetEmailResponse,
}

/// Response from getting email details.
#[derive(Debug, Clone, Deserialize)]
pub struct GetEmailResponse {
    /// Unique transmission ID.
    pub transmission_id: String,
    /// Derived delivery state.
    pub state: EmailState,
    /// Sender email address.
    pub from: String,
    /// Sender display name.
    #[serde(default)]
    pub from_name: Option<String>,
    /// Email subject line.
    pub subject: String,
    /// List of recipient email addresses.
    pub recipients: Vec<String>,
    /// Total number of recipients.
    pub num_recipients: u32,
    /// Scheduled delivery time, if applicable.
    #[serde(default)]
    pub scheduled_at: Option<String>,
    /// Delivery events for this email.
    pub events: Vec<EmailEvent>,
}

#[derive(Debug, Deserialize)]
struct ListEmailEventsResponseWrapper {
    #[allow(dead_code)]
    message: String,
    data: ListEmailEventsResponse,
}

/// Response from listing email events.
#[derive(Debug, Clone, Deserialize)]
pub struct ListEmailEventsResponse {
    /// Email events data with pagination.
    pub events: EmailEventsData,
}

/// Email events data container.
#[derive(Debug, Clone, Deserialize)]
pub struct EmailEventsData {
    /// List of email events.
    pub data: Vec<EmailEvent>,
    /// Total number of events matching the query.
    pub total_count: u64,
    /// Start of the date range.
    pub from: Option<String>,
    /// End of the date range.
    pub to: Option<String>,
    /// Pagination information.
    pub pagination: Pagination,
}

/// An email event with type-specific fields.
///
/// The `event_type` field determines which additional fields are present.
/// Fields specific to certain event types will be `None` for other types.
#[derive(Debug, Clone, Deserialize)]
pub struct EmailEvent {
    // ── Common required fields ──
    /// Unique event ID.
    pub event_id: String,
    /// Event type.
    #[serde(rename = "type")]
    pub event_type: EventType,
    /// Timestamp of the event (ISO 8601).
    pub timestamp: String,

    // ── Common optional fields ──
    /// Transmission request ID.
    #[serde(default)]
    pub request_id: Option<String>,
    /// Recipient email address.
    #[serde(default)]
    pub rcpt_to: Option<String>,
    /// Original recipient email address.
    #[serde(default)]
    pub raw_rcpt_to: Option<String>,
    /// Domain of the recipient.
    #[serde(default)]
    pub recipient_domain: Option<String>,
    /// Mailbox provider of the recipient.
    #[serde(default)]
    pub mailbox_provider: Option<String>,
    /// Region of the mailbox provider.
    #[serde(default)]
    pub mailbox_provider_region: Option<String>,
    /// SMTP message ID.
    #[serde(default)]
    pub message_id: Option<String>,
    /// Email subject line.
    #[serde(default)]
    pub subject: Option<String>,
    /// Friendly from address.
    #[serde(default)]
    pub friendly_from: Option<String>,
    /// The sending domain.
    #[serde(default)]
    pub sending_domain: Option<String>,
    /// IP address used to send the email.
    #[serde(default)]
    pub sending_ip: Option<String>,
    /// Whether click tracking was enabled.
    #[serde(default)]
    pub click_tracking: Option<bool>,
    /// Whether open tracking was enabled.
    #[serde(default)]
    pub open_tracking: Option<bool>,
    /// Whether this was a transactional message.
    #[serde(default)]
    pub transactional: Option<bool>,
    /// Message size in bytes.
    #[serde(default)]
    pub msg_size: Option<u64>,
    /// When the message was injected (ISO 8601).
    #[serde(default)]
    pub injection_time: Option<String>,
    /// Recipient metadata.
    #[serde(default)]
    pub rcpt_meta: Option<serde_json::Value>,
    /// Campaign identifier.
    #[serde(default)]
    pub campaign_id: Option<String>,
    /// Template identifier.
    #[serde(default)]
    pub template_id: Option<String>,
    /// Template version.
    #[serde(default)]
    pub template_version: Option<String>,
    /// IP pool used for sending.
    #[serde(default)]
    pub ip_pool: Option<String>,
    /// Envelope sender (MAIL FROM).
    #[serde(default)]
    pub msg_from: Option<String>,
    /// Recipient type.
    #[serde(default)]
    pub rcpt_type: Option<String>,
    /// Recipient tags.
    #[serde(default)]
    pub rcpt_tags: Option<Vec<String>>,
    /// Whether AMP was enabled.
    #[serde(default)]
    pub amp_enabled: Option<bool>,
    /// Delivery method (e.g. "esmtp").
    #[serde(default)]
    pub delv_method: Option<String>,
    /// Reception method (e.g. "rest").
    #[serde(default)]
    pub recv_method: Option<String>,
    /// Routing domain.
    #[serde(default)]
    pub routing_domain: Option<String>,
    /// Scheduled delivery time.
    #[serde(default)]
    pub scheduled_time: Option<String>,
    /// A/B test identifier.
    #[serde(default)]
    pub ab_test_id: Option<String>,
    /// A/B test version.
    #[serde(default)]
    pub ab_test_version: Option<String>,

    // ── Bounce/delay/out_of_band/policy_rejection fields ──
    /// Bounce classification code.
    #[serde(default)]
    pub bounce_class: Option<i64>,
    /// SMTP error code.
    #[serde(default)]
    pub error_code: Option<String>,
    /// Human-readable bounce/delay/failure reason.
    #[serde(default)]
    pub reason: Option<String>,
    /// Raw SMTP reason string.
    #[serde(default)]
    pub raw_reason: Option<String>,
    /// Number of delivery retries attempted.
    #[serde(default)]
    pub num_retries: Option<u32>,
    /// Device token if applicable.
    #[serde(default)]
    pub device_token: Option<String>,

    // ── Delivery/delay fields ──
    /// Time spent in queue in milliseconds.
    #[serde(default)]
    pub queue_time: Option<u64>,
    /// Whether TLS was used for outbound delivery.
    #[serde(default)]
    pub outbound_tls: Option<String>,

    // ── Click fields ──
    /// The URL that was clicked.
    #[serde(default)]
    pub target_link_url: Option<String>,
    /// The name/label of the clicked link.
    #[serde(default)]
    pub target_link_name: Option<String>,

    // ── Open/click shared fields ──
    /// Raw user agent string.
    #[serde(default)]
    pub user_agent: Option<String>,
    /// Parsed user agent information.
    #[serde(default)]
    pub user_agent_parsed: Option<UserAgentParsed>,
    /// Geolocation data.
    #[serde(default)]
    pub geo_ip: Option<GeoIp>,
    /// IP address of the open/click.
    #[serde(default)]
    pub ip_address: Option<String>,
    /// Whether initial open tracking pixel was used.
    #[serde(default)]
    pub initial_pixel: Option<bool>,

    // ── Spam complaint fields ──
    /// Feedback type (e.g. "abuse").
    #[serde(default)]
    pub fbtype: Option<String>,
    /// Who reported the spam.
    #[serde(default)]
    pub report_by: Option<String>,
    /// Where the spam report was sent.
    #[serde(default)]
    pub report_to: Option<String>,

    // ── Policy rejection fields ──
    /// Remote IP address.
    #[serde(default)]
    pub remote_addr: Option<String>,
}

/// Parsed user agent information from open/click events.
#[derive(Debug, Clone, Deserialize)]
pub struct UserAgentParsed {
    /// Browser or email client family.
    #[serde(default)]
    pub agent_family: Option<String>,
    /// Device brand (e.g. Apple, Samsung).
    #[serde(default)]
    pub device_brand: Option<String>,
    /// Device family (e.g. iPhone, Desktop).
    #[serde(default)]
    pub device_family: Option<String>,
    /// Operating system family.
    #[serde(default)]
    pub os_family: Option<String>,
    /// Operating system version.
    #[serde(default)]
    pub os_version: Option<String>,
    /// Whether the device is mobile.
    #[serde(default)]
    pub is_mobile: Option<bool>,
    /// Whether the request came through a proxy.
    #[serde(default)]
    pub is_proxy: Option<bool>,
    /// Whether the open was prefetched by an email provider.
    #[serde(default)]
    pub is_prefetched: Option<bool>,
}

/// Geolocation data from open/click events.
#[derive(Debug, Clone, Deserialize)]
pub struct GeoIp {
    /// ISO 3166-1 alpha-2 country code.
    #[serde(default)]
    pub country: Option<String>,
    /// Region or state code.
    #[serde(default)]
    pub region: Option<String>,
    /// City name.
    #[serde(default)]
    pub city: Option<String>,
    /// Latitude.
    #[serde(default)]
    pub latitude: Option<f64>,
    /// Longitude.
    #[serde(default)]
    pub longitude: Option<f64>,
    /// ZIP code.
    #[serde(default)]
    pub zip: Option<String>,
    /// Postal code.
    #[serde(default)]
    pub postal_code: Option<String>,
}

#[derive(Debug, Deserialize)]
struct ScheduledTransmissionResponseWrapper {
    #[allow(dead_code)]
    message: String,
    data: ScheduledTransmission,
}

/// A scheduled email transmission.
#[derive(Debug, Clone, Deserialize)]
pub struct ScheduledTransmission {
    /// Unique transmission ID.
    pub transmission_id: String,
    /// Current state of the transmission.
    pub state: ScheduledEmailState,
    /// Scheduled delivery time (ISO 8601).
    #[serde(default)]
    pub scheduled_at: Option<String>,
    /// Sender email address.
    pub from: String,
    /// Sender display name.
    #[serde(default)]
    pub from_name: Option<String>,
    /// Email subject line.
    pub subject: String,
    /// List of recipient email addresses.
    pub recipients: Vec<String>,
    /// Total number of recipients.
    pub num_recipients: u32,
    /// Delivery events for this transmission.
    pub events: Vec<EmailEvent>,
}