smartletter 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -0
- package/dist/index.cjs +22 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +93 -27
- package/dist/index.d.mts +93 -27
- package/dist/index.mjs +22 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -4
package/dist/index.d.cts
CHANGED
|
@@ -384,7 +384,7 @@ interface TemplatesGetResponse {
|
|
|
384
384
|
id: string;
|
|
385
385
|
key: string;
|
|
386
386
|
type: "string" | "number";
|
|
387
|
-
fallback_value:
|
|
387
|
+
fallback_value: string | number | null;
|
|
388
388
|
required: boolean;
|
|
389
389
|
created_at: string;
|
|
390
390
|
updated_at: string;
|
|
@@ -524,11 +524,13 @@ interface NewslettersListResponse {
|
|
|
524
524
|
subject: string;
|
|
525
525
|
preheader: string | null;
|
|
526
526
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
527
|
+
kind: "newsletter" | "broadcast";
|
|
528
|
+
from: string;
|
|
527
529
|
audience_limit: number | null;
|
|
528
530
|
scheduled_for: string | null;
|
|
529
531
|
send_started_at: string | null;
|
|
530
532
|
send_finished_at: string | null;
|
|
531
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
533
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
532
534
|
recipient_estimate: number | null;
|
|
533
535
|
ab_test: {
|
|
534
536
|
variants: {
|
|
@@ -695,6 +697,14 @@ interface NewslettersCreateParams {
|
|
|
695
697
|
*/
|
|
696
698
|
winnerMode?: "auto" | "manual";
|
|
697
699
|
} | null;
|
|
700
|
+
/**
|
|
701
|
+
* `newsletter` (default) goes to the subscribers of the newsletter, or of a topic. `broadcast` goes to the contacts of the group (the rule `audience_filter_id` narrows it), subscribed or not, and takes no `topic_id`. A broadcast is never published in the archive.
|
|
702
|
+
*/
|
|
703
|
+
kind?: "newsletter" | "broadcast";
|
|
704
|
+
/**
|
|
705
|
+
* Sender address of this issue: `name@your-domain.com`, on the custom domain of the newsletter (a bare local part `name` also works). Omit or `null` for the address of the newsletter.
|
|
706
|
+
*/
|
|
707
|
+
from?: string | null;
|
|
698
708
|
}
|
|
699
709
|
interface NewslettersCreateResponse {
|
|
700
710
|
object: "newsletter";
|
|
@@ -704,6 +714,8 @@ interface NewslettersCreateResponse {
|
|
|
704
714
|
subject: string;
|
|
705
715
|
preheader: string | null;
|
|
706
716
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
717
|
+
kind: "newsletter" | "broadcast";
|
|
718
|
+
from: string;
|
|
707
719
|
body: {
|
|
708
720
|
format: "markdown" | "html";
|
|
709
721
|
content: string;
|
|
@@ -723,7 +735,7 @@ interface NewslettersCreateResponse {
|
|
|
723
735
|
scheduled_for: string | null;
|
|
724
736
|
send_started_at: string | null;
|
|
725
737
|
send_finished_at: string | null;
|
|
726
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
738
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
727
739
|
recipient_estimate: number | null;
|
|
728
740
|
ab_test: {
|
|
729
741
|
variants: {
|
|
@@ -760,6 +772,8 @@ interface NewslettersGetResponse {
|
|
|
760
772
|
subject: string;
|
|
761
773
|
preheader: string | null;
|
|
762
774
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
775
|
+
kind: "newsletter" | "broadcast";
|
|
776
|
+
from: string;
|
|
763
777
|
body: {
|
|
764
778
|
format: "markdown" | "html";
|
|
765
779
|
content: string;
|
|
@@ -779,7 +793,7 @@ interface NewslettersGetResponse {
|
|
|
779
793
|
scheduled_for: string | null;
|
|
780
794
|
send_started_at: string | null;
|
|
781
795
|
send_finished_at: string | null;
|
|
782
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
796
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
783
797
|
recipient_estimate: number | null;
|
|
784
798
|
ab_test: {
|
|
785
799
|
variants: {
|
|
@@ -810,7 +824,10 @@ type NewslettersUpdateParams = {
|
|
|
810
824
|
} & {
|
|
811
825
|
subject?: string;
|
|
812
826
|
preheader?: string | null;
|
|
813
|
-
|
|
827
|
+
/**
|
|
828
|
+
* Topic of the issue. `null` is accepted only for a broadcast, which has no topic.
|
|
829
|
+
*/
|
|
830
|
+
topicId?: string | null;
|
|
814
831
|
markdown?: string;
|
|
815
832
|
html?: string;
|
|
816
833
|
/**
|
|
@@ -928,6 +945,14 @@ type NewslettersUpdateParams = {
|
|
|
928
945
|
*/
|
|
929
946
|
winnerMode?: "auto" | "manual";
|
|
930
947
|
} | null;
|
|
948
|
+
/**
|
|
949
|
+
* Drafts only. See `POST /newsletters`.
|
|
950
|
+
*/
|
|
951
|
+
kind?: "newsletter" | "broadcast";
|
|
952
|
+
/**
|
|
953
|
+
* Sender address of this issue; `null` goes back to the address of the newsletter.
|
|
954
|
+
*/
|
|
955
|
+
from?: string | null;
|
|
931
956
|
};
|
|
932
957
|
interface NewslettersUpdateResponse {
|
|
933
958
|
object: "newsletter";
|
|
@@ -937,6 +962,8 @@ interface NewslettersUpdateResponse {
|
|
|
937
962
|
subject: string;
|
|
938
963
|
preheader: string | null;
|
|
939
964
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
965
|
+
kind: "newsletter" | "broadcast";
|
|
966
|
+
from: string;
|
|
940
967
|
body: {
|
|
941
968
|
format: "markdown" | "html";
|
|
942
969
|
content: string;
|
|
@@ -956,7 +983,7 @@ interface NewslettersUpdateResponse {
|
|
|
956
983
|
scheduled_for: string | null;
|
|
957
984
|
send_started_at: string | null;
|
|
958
985
|
send_finished_at: string | null;
|
|
959
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
986
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
960
987
|
recipient_estimate: number | null;
|
|
961
988
|
ab_test: {
|
|
962
989
|
variants: {
|
|
@@ -1001,6 +1028,8 @@ interface NewslettersDuplicateResponse {
|
|
|
1001
1028
|
subject: string;
|
|
1002
1029
|
preheader: string | null;
|
|
1003
1030
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1031
|
+
kind: "newsletter" | "broadcast";
|
|
1032
|
+
from: string;
|
|
1004
1033
|
body: {
|
|
1005
1034
|
format: "markdown" | "html";
|
|
1006
1035
|
content: string;
|
|
@@ -1020,7 +1049,7 @@ interface NewslettersDuplicateResponse {
|
|
|
1020
1049
|
scheduled_for: string | null;
|
|
1021
1050
|
send_started_at: string | null;
|
|
1022
1051
|
send_finished_at: string | null;
|
|
1023
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1052
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1024
1053
|
recipient_estimate: number | null;
|
|
1025
1054
|
ab_test: {
|
|
1026
1055
|
variants: {
|
|
@@ -1090,6 +1119,8 @@ interface NewslettersSendResponse {
|
|
|
1090
1119
|
subject: string;
|
|
1091
1120
|
preheader: string | null;
|
|
1092
1121
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1122
|
+
kind: "newsletter" | "broadcast";
|
|
1123
|
+
from: string;
|
|
1093
1124
|
body: {
|
|
1094
1125
|
format: "markdown" | "html";
|
|
1095
1126
|
content: string;
|
|
@@ -1109,7 +1140,7 @@ interface NewslettersSendResponse {
|
|
|
1109
1140
|
scheduled_for: string | null;
|
|
1110
1141
|
send_started_at: string | null;
|
|
1111
1142
|
send_finished_at: string | null;
|
|
1112
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1143
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1113
1144
|
recipient_estimate: number | null;
|
|
1114
1145
|
ab_test: {
|
|
1115
1146
|
variants: {
|
|
@@ -1155,6 +1186,8 @@ interface NewslettersScheduleResponse {
|
|
|
1155
1186
|
subject: string;
|
|
1156
1187
|
preheader: string | null;
|
|
1157
1188
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1189
|
+
kind: "newsletter" | "broadcast";
|
|
1190
|
+
from: string;
|
|
1158
1191
|
body: {
|
|
1159
1192
|
format: "markdown" | "html";
|
|
1160
1193
|
content: string;
|
|
@@ -1174,7 +1207,7 @@ interface NewslettersScheduleResponse {
|
|
|
1174
1207
|
scheduled_for: string | null;
|
|
1175
1208
|
send_started_at: string | null;
|
|
1176
1209
|
send_finished_at: string | null;
|
|
1177
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1210
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1178
1211
|
recipient_estimate: number | null;
|
|
1179
1212
|
ab_test: {
|
|
1180
1213
|
variants: {
|
|
@@ -1211,6 +1244,8 @@ interface NewslettersUnscheduleResponse {
|
|
|
1211
1244
|
subject: string;
|
|
1212
1245
|
preheader: string | null;
|
|
1213
1246
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1247
|
+
kind: "newsletter" | "broadcast";
|
|
1248
|
+
from: string;
|
|
1214
1249
|
body: {
|
|
1215
1250
|
format: "markdown" | "html";
|
|
1216
1251
|
content: string;
|
|
@@ -1230,7 +1265,7 @@ interface NewslettersUnscheduleResponse {
|
|
|
1230
1265
|
scheduled_for: string | null;
|
|
1231
1266
|
send_started_at: string | null;
|
|
1232
1267
|
send_finished_at: string | null;
|
|
1233
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1268
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1234
1269
|
recipient_estimate: number | null;
|
|
1235
1270
|
ab_test: {
|
|
1236
1271
|
variants: {
|
|
@@ -1267,6 +1302,8 @@ interface NewslettersPauseResponse {
|
|
|
1267
1302
|
subject: string;
|
|
1268
1303
|
preheader: string | null;
|
|
1269
1304
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1305
|
+
kind: "newsletter" | "broadcast";
|
|
1306
|
+
from: string;
|
|
1270
1307
|
body: {
|
|
1271
1308
|
format: "markdown" | "html";
|
|
1272
1309
|
content: string;
|
|
@@ -1286,7 +1323,7 @@ interface NewslettersPauseResponse {
|
|
|
1286
1323
|
scheduled_for: string | null;
|
|
1287
1324
|
send_started_at: string | null;
|
|
1288
1325
|
send_finished_at: string | null;
|
|
1289
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1326
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1290
1327
|
recipient_estimate: number | null;
|
|
1291
1328
|
ab_test: {
|
|
1292
1329
|
variants: {
|
|
@@ -1323,6 +1360,8 @@ interface NewslettersResumeResponse {
|
|
|
1323
1360
|
subject: string;
|
|
1324
1361
|
preheader: string | null;
|
|
1325
1362
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1363
|
+
kind: "newsletter" | "broadcast";
|
|
1364
|
+
from: string;
|
|
1326
1365
|
body: {
|
|
1327
1366
|
format: "markdown" | "html";
|
|
1328
1367
|
content: string;
|
|
@@ -1342,7 +1381,7 @@ interface NewslettersResumeResponse {
|
|
|
1342
1381
|
scheduled_for: string | null;
|
|
1343
1382
|
send_started_at: string | null;
|
|
1344
1383
|
send_finished_at: string | null;
|
|
1345
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1384
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1346
1385
|
recipient_estimate: number | null;
|
|
1347
1386
|
ab_test: {
|
|
1348
1387
|
variants: {
|
|
@@ -1384,6 +1423,8 @@ interface NewslettersSendMoreResponse {
|
|
|
1384
1423
|
subject: string;
|
|
1385
1424
|
preheader: string | null;
|
|
1386
1425
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1426
|
+
kind: "newsletter" | "broadcast";
|
|
1427
|
+
from: string;
|
|
1387
1428
|
body: {
|
|
1388
1429
|
format: "markdown" | "html";
|
|
1389
1430
|
content: string;
|
|
@@ -1403,7 +1444,7 @@ interface NewslettersSendMoreResponse {
|
|
|
1403
1444
|
scheduled_for: string | null;
|
|
1404
1445
|
send_started_at: string | null;
|
|
1405
1446
|
send_finished_at: string | null;
|
|
1406
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1447
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1407
1448
|
recipient_estimate: number | null;
|
|
1408
1449
|
ab_test: {
|
|
1409
1450
|
variants: {
|
|
@@ -1536,6 +1577,8 @@ interface NewslettersAbWinnerResponse {
|
|
|
1536
1577
|
subject: string;
|
|
1537
1578
|
preheader: string | null;
|
|
1538
1579
|
status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
|
|
1580
|
+
kind: "newsletter" | "broadcast";
|
|
1581
|
+
from: string;
|
|
1539
1582
|
body: {
|
|
1540
1583
|
format: "markdown" | "html";
|
|
1541
1584
|
content: string;
|
|
@@ -1555,7 +1598,7 @@ interface NewslettersAbWinnerResponse {
|
|
|
1555
1598
|
scheduled_for: string | null;
|
|
1556
1599
|
send_started_at: string | null;
|
|
1557
1600
|
send_finished_at: string | null;
|
|
1558
|
-
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
|
|
1601
|
+
pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
|
|
1559
1602
|
recipient_estimate: number | null;
|
|
1560
1603
|
ab_test: {
|
|
1561
1604
|
variants: {
|
|
@@ -1626,6 +1669,7 @@ interface ContactsListResponse {
|
|
|
1626
1669
|
[k: string]: string | number | boolean;
|
|
1627
1670
|
};
|
|
1628
1671
|
tags: string[];
|
|
1672
|
+
newsletter_subscribed: boolean;
|
|
1629
1673
|
engagement: {
|
|
1630
1674
|
emails_sent: number;
|
|
1631
1675
|
emails_opened: number;
|
|
@@ -1658,6 +1702,10 @@ interface ContactsCreateParams {
|
|
|
1658
1702
|
* Added to the contact's tags (also when the contact already exists).
|
|
1659
1703
|
*/
|
|
1660
1704
|
tags?: string[];
|
|
1705
|
+
/**
|
|
1706
|
+
* Receives the newsletter issues (default `true` for a new contact). `false` adds the contact to the group only: they get broadcasts, not newsletters. A contact already in the group is never unsubscribed here: only `true` subscribes them.
|
|
1707
|
+
*/
|
|
1708
|
+
newsletterSubscribed?: boolean;
|
|
1661
1709
|
}
|
|
1662
1710
|
interface ContactsCreateResponse {
|
|
1663
1711
|
object: "contact";
|
|
@@ -1677,6 +1725,7 @@ interface ContactsCreateResponse {
|
|
|
1677
1725
|
[k: string]: string | number | boolean;
|
|
1678
1726
|
};
|
|
1679
1727
|
tags: string[];
|
|
1728
|
+
newsletter_subscribed: boolean;
|
|
1680
1729
|
engagement: {
|
|
1681
1730
|
emails_sent: number;
|
|
1682
1731
|
emails_opened: number;
|
|
@@ -1720,6 +1769,10 @@ interface ContactsImportParams {
|
|
|
1720
1769
|
* Merged into the tags of a contact already in the newsletter (never replaced).
|
|
1721
1770
|
*/
|
|
1722
1771
|
tags?: string[] | null;
|
|
1772
|
+
/**
|
|
1773
|
+
* New contact: default `true`. `false` keeps them in the group only. A contact already in the group changes only with an explicit `true`.
|
|
1774
|
+
*/
|
|
1775
|
+
newsletterSubscribed?: boolean | null;
|
|
1723
1776
|
/**
|
|
1724
1777
|
* `unsubscribed` keeps a contact who left on your previous platform: stored unsubscribed, never emailed, and a contact already in the newsletter is unsubscribed too. Default `active`.
|
|
1725
1778
|
*/
|
|
@@ -1788,6 +1841,7 @@ interface ContactsGetResponse {
|
|
|
1788
1841
|
[k: string]: string | number | boolean;
|
|
1789
1842
|
};
|
|
1790
1843
|
tags: string[];
|
|
1844
|
+
newsletter_subscribed: boolean;
|
|
1791
1845
|
engagement: {
|
|
1792
1846
|
emails_sent: number;
|
|
1793
1847
|
emails_opened: number;
|
|
@@ -1825,6 +1879,7 @@ interface ContactsUnsubscribeResponse {
|
|
|
1825
1879
|
[k: string]: string | number | boolean;
|
|
1826
1880
|
};
|
|
1827
1881
|
tags: string[];
|
|
1882
|
+
newsletter_subscribed: boolean;
|
|
1828
1883
|
engagement: {
|
|
1829
1884
|
emails_sent: number;
|
|
1830
1885
|
emails_opened: number;
|
|
@@ -1854,6 +1909,7 @@ interface ContactsReactivateResponse {
|
|
|
1854
1909
|
[k: string]: string | number | boolean;
|
|
1855
1910
|
};
|
|
1856
1911
|
tags: string[];
|
|
1912
|
+
newsletter_subscribed: boolean;
|
|
1857
1913
|
engagement: {
|
|
1858
1914
|
emails_sent: number;
|
|
1859
1915
|
emails_opened: number;
|
|
@@ -1895,6 +1951,10 @@ type ContactsUpdateParams = {
|
|
|
1895
1951
|
* Removed from the current tags.
|
|
1896
1952
|
*/
|
|
1897
1953
|
removeTags?: string[];
|
|
1954
|
+
/**
|
|
1955
|
+
* `true` subscribes the contact to the newsletter issues, `false` keeps them in the group only (broadcasts still reach them).
|
|
1956
|
+
*/
|
|
1957
|
+
newsletterSubscribed?: boolean;
|
|
1898
1958
|
};
|
|
1899
1959
|
interface ContactsUpdateResponse {
|
|
1900
1960
|
object: "contact";
|
|
@@ -1914,6 +1974,7 @@ interface ContactsUpdateResponse {
|
|
|
1914
1974
|
[k: string]: string | number | boolean;
|
|
1915
1975
|
};
|
|
1916
1976
|
tags: string[];
|
|
1977
|
+
newsletter_subscribed: boolean;
|
|
1917
1978
|
engagement: {
|
|
1918
1979
|
emails_sent: number;
|
|
1919
1980
|
emails_opened: number;
|
|
@@ -1933,7 +1994,7 @@ interface ContactFieldsListResponse {
|
|
|
1933
1994
|
label: string;
|
|
1934
1995
|
type: "text" | "number" | "date" | "boolean" | "choice";
|
|
1935
1996
|
options: string[] | null;
|
|
1936
|
-
default_value:
|
|
1997
|
+
default_value: string | number | boolean | null;
|
|
1937
1998
|
in_signup: boolean;
|
|
1938
1999
|
position: number;
|
|
1939
2000
|
created_at: string;
|
|
@@ -1969,7 +2030,7 @@ interface ContactFieldsCreateResponse {
|
|
|
1969
2030
|
label: string;
|
|
1970
2031
|
type: "text" | "number" | "date" | "boolean" | "choice";
|
|
1971
2032
|
options: string[] | null;
|
|
1972
|
-
default_value:
|
|
2033
|
+
default_value: string | number | boolean | null;
|
|
1973
2034
|
in_signup: boolean;
|
|
1974
2035
|
position: number;
|
|
1975
2036
|
created_at: string;
|
|
@@ -1990,7 +2051,7 @@ interface ContactFieldsUpdateResponse {
|
|
|
1990
2051
|
label: string;
|
|
1991
2052
|
type: "text" | "number" | "date" | "boolean" | "choice";
|
|
1992
2053
|
options: string[] | null;
|
|
1993
|
-
default_value:
|
|
2054
|
+
default_value: string | number | boolean | null;
|
|
1994
2055
|
in_signup: boolean;
|
|
1995
2056
|
position: number;
|
|
1996
2057
|
created_at: string;
|
|
@@ -2366,7 +2427,7 @@ type SegmentsDomainSetParams = {
|
|
|
2366
2427
|
id: string;
|
|
2367
2428
|
} & {
|
|
2368
2429
|
/**
|
|
2369
|
-
* Subdomain you own, e.g. `news.acme.com` (a CNAME to
|
|
2430
|
+
* Subdomain you own, e.g. `news.acme.com` (a CNAME to `customers.smartletter.ai`).
|
|
2370
2431
|
*/
|
|
2371
2432
|
domain: string;
|
|
2372
2433
|
};
|
|
@@ -2516,6 +2577,7 @@ interface DomainsCreateResponse {
|
|
|
2516
2577
|
id: string;
|
|
2517
2578
|
name: string;
|
|
2518
2579
|
status: "not_started" | "pending" | "verified" | "temporary_failure" | "failed";
|
|
2580
|
+
review_status?: "none" | "pending" | "held" | "approved" | "rejected";
|
|
2519
2581
|
created_at: string;
|
|
2520
2582
|
region: string;
|
|
2521
2583
|
records: {
|
|
@@ -2550,6 +2612,7 @@ interface DomainsListResponse {
|
|
|
2550
2612
|
id: string;
|
|
2551
2613
|
name: string;
|
|
2552
2614
|
status: "not_started" | "pending" | "verified" | "temporary_failure" | "failed";
|
|
2615
|
+
review_status?: "none" | "pending" | "held" | "approved" | "rejected";
|
|
2553
2616
|
created_at: string;
|
|
2554
2617
|
region: string;
|
|
2555
2618
|
}[];
|
|
@@ -2562,6 +2625,7 @@ interface DomainsGetResponse {
|
|
|
2562
2625
|
id: string;
|
|
2563
2626
|
name: string;
|
|
2564
2627
|
status: "not_started" | "pending" | "verified" | "temporary_failure" | "failed";
|
|
2628
|
+
review_status?: "none" | "pending" | "held" | "approved" | "rejected";
|
|
2565
2629
|
created_at: string;
|
|
2566
2630
|
region: string;
|
|
2567
2631
|
records: {
|
|
@@ -2841,7 +2905,7 @@ interface SequencesListResponse {
|
|
|
2841
2905
|
type: "update_contact";
|
|
2842
2906
|
action: "set_field";
|
|
2843
2907
|
key: string;
|
|
2844
|
-
value:
|
|
2908
|
+
value: string | number | boolean | null;
|
|
2845
2909
|
} | {
|
|
2846
2910
|
id: string;
|
|
2847
2911
|
type: "update_contact";
|
|
@@ -3025,7 +3089,7 @@ interface SequencesCreateParams {
|
|
|
3025
3089
|
/**
|
|
3026
3090
|
* update_contact set_field: `null` clears it.
|
|
3027
3091
|
*/
|
|
3028
|
-
value?:
|
|
3092
|
+
value?: string | number | boolean | null;
|
|
3029
3093
|
/**
|
|
3030
3094
|
* update_contact (un)subscribe_topic.
|
|
3031
3095
|
*/
|
|
@@ -3135,7 +3199,7 @@ interface SequencesCreateResponse {
|
|
|
3135
3199
|
type: "update_contact";
|
|
3136
3200
|
action: "set_field";
|
|
3137
3201
|
key: string;
|
|
3138
|
-
value:
|
|
3202
|
+
value: string | number | boolean | null;
|
|
3139
3203
|
} | {
|
|
3140
3204
|
id: string;
|
|
3141
3205
|
type: "update_contact";
|
|
@@ -3260,7 +3324,7 @@ interface SequencesGetResponse {
|
|
|
3260
3324
|
type: "update_contact";
|
|
3261
3325
|
action: "set_field";
|
|
3262
3326
|
key: string;
|
|
3263
|
-
value:
|
|
3327
|
+
value: string | number | boolean | null;
|
|
3264
3328
|
} | {
|
|
3265
3329
|
id: string;
|
|
3266
3330
|
type: "update_contact";
|
|
@@ -3445,7 +3509,7 @@ type SequencesUpdateParams = {
|
|
|
3445
3509
|
/**
|
|
3446
3510
|
* update_contact set_field: `null` clears it.
|
|
3447
3511
|
*/
|
|
3448
|
-
value?:
|
|
3512
|
+
value?: string | number | boolean | null;
|
|
3449
3513
|
/**
|
|
3450
3514
|
* update_contact (un)subscribe_topic.
|
|
3451
3515
|
*/
|
|
@@ -3555,7 +3619,7 @@ interface SequencesUpdateResponse {
|
|
|
3555
3619
|
type: "update_contact";
|
|
3556
3620
|
action: "set_field";
|
|
3557
3621
|
key: string;
|
|
3558
|
-
value:
|
|
3622
|
+
value: string | number | boolean | null;
|
|
3559
3623
|
} | {
|
|
3560
3624
|
id: string;
|
|
3561
3625
|
type: "update_contact";
|
|
@@ -3693,7 +3757,7 @@ interface SequencesActivateResponse {
|
|
|
3693
3757
|
type: "update_contact";
|
|
3694
3758
|
action: "set_field";
|
|
3695
3759
|
key: string;
|
|
3696
|
-
value:
|
|
3760
|
+
value: string | number | boolean | null;
|
|
3697
3761
|
} | {
|
|
3698
3762
|
id: string;
|
|
3699
3763
|
type: "update_contact";
|
|
@@ -3818,7 +3882,7 @@ interface SequencesPauseResponse {
|
|
|
3818
3882
|
type: "update_contact";
|
|
3819
3883
|
action: "set_field";
|
|
3820
3884
|
key: string;
|
|
3821
|
-
value:
|
|
3885
|
+
value: string | number | boolean | null;
|
|
3822
3886
|
} | {
|
|
3823
3887
|
id: string;
|
|
3824
3888
|
type: "update_contact";
|
|
@@ -3943,7 +4007,7 @@ interface SequencesArchiveResponse {
|
|
|
3943
4007
|
type: "update_contact";
|
|
3944
4008
|
action: "set_field";
|
|
3945
4009
|
key: string;
|
|
3946
|
-
value:
|
|
4010
|
+
value: string | number | boolean | null;
|
|
3947
4011
|
} | {
|
|
3948
4012
|
id: string;
|
|
3949
4013
|
type: "update_contact";
|
|
@@ -4706,6 +4770,7 @@ type ThreadsReplyResponse = {
|
|
|
4706
4770
|
delivery: string | null;
|
|
4707
4771
|
} | {
|
|
4708
4772
|
object: "inbox_message";
|
|
4773
|
+
id: string;
|
|
4709
4774
|
email_id: string;
|
|
4710
4775
|
status: "sent";
|
|
4711
4776
|
};
|
|
@@ -4881,6 +4946,7 @@ type MessagesSendResponse = {
|
|
|
4881
4946
|
delivery: string;
|
|
4882
4947
|
} | {
|
|
4883
4948
|
object: "inbox_message";
|
|
4949
|
+
id: string;
|
|
4884
4950
|
email_id: string;
|
|
4885
4951
|
status: "sent";
|
|
4886
4952
|
};
|