smartletter 1.2.0 → 1.3.0

package/dist/index.d.mts

@@ -384,7 +384,7 @@ interface TemplatesGetResponse {
         id: string;
         key: string;
         type: "string" | "number";
-        fallback_value: (string | number) | null;
+        fallback_value: string | number | null;
         required: boolean;
         created_at: string;
         updated_at: string;
@@ -524,11 +524,13 @@ interface NewslettersListResponse {
         subject: string;
         preheader: string | null;
         status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+        kind: "newsletter" | "broadcast";
+        from: string;
         audience_limit: number | null;
         scheduled_for: string | null;
         send_started_at: string | null;
         send_finished_at: string | null;
-        pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+        pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
         recipient_estimate: number | null;
         ab_test: {
             variants: {
@@ -695,6 +697,14 @@ interface NewslettersCreateParams {
          */
         winnerMode?: "auto" | "manual";
     } | null;
+    /**
+     * `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.
+     */
+    kind?: "newsletter" | "broadcast";
+    /**
+     * 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.
+     */
+    from?: string | null;
 }
 interface NewslettersCreateResponse {
     object: "newsletter";
@@ -704,6 +714,8 @@ interface NewslettersCreateResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -723,7 +735,7 @@ interface NewslettersCreateResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -760,6 +772,8 @@ interface NewslettersGetResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -779,7 +793,7 @@ interface NewslettersGetResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -810,7 +824,10 @@ type NewslettersUpdateParams = {
 } & {
     subject?: string;
     preheader?: string | null;
-    topicId?: string;
+    /**
+     * Topic of the issue. `null` is accepted only for a broadcast, which has no topic.
+     */
+    topicId?: string | null;
     markdown?: string;
     html?: string;
     /**
@@ -928,6 +945,14 @@ type NewslettersUpdateParams = {
          */
         winnerMode?: "auto" | "manual";
     } | null;
+    /**
+     * Drafts only. See `POST /newsletters`.
+     */
+    kind?: "newsletter" | "broadcast";
+    /**
+     * Sender address of this issue; `null` goes back to the address of the newsletter.
+     */
+    from?: string | null;
 };
 interface NewslettersUpdateResponse {
     object: "newsletter";
@@ -937,6 +962,8 @@ interface NewslettersUpdateResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -956,7 +983,7 @@ interface NewslettersUpdateResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1001,6 +1028,8 @@ interface NewslettersDuplicateResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1020,7 +1049,7 @@ interface NewslettersDuplicateResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1090,6 +1119,8 @@ interface NewslettersSendResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1109,7 +1140,7 @@ interface NewslettersSendResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1155,6 +1186,8 @@ interface NewslettersScheduleResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1174,7 +1207,7 @@ interface NewslettersScheduleResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1211,6 +1244,8 @@ interface NewslettersUnscheduleResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1230,7 +1265,7 @@ interface NewslettersUnscheduleResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1267,6 +1302,8 @@ interface NewslettersPauseResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1286,7 +1323,7 @@ interface NewslettersPauseResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1323,6 +1360,8 @@ interface NewslettersResumeResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1342,7 +1381,7 @@ interface NewslettersResumeResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1384,6 +1423,8 @@ interface NewslettersSendMoreResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1403,7 +1444,7 @@ interface NewslettersSendMoreResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1536,6 +1577,8 @@ interface NewslettersAbWinnerResponse {
     subject: string;
     preheader: string | null;
     status: "draft" | "scheduled" | "sending" | "sent" | "paused" | "cancelled" | "held";
+    kind: "newsletter" | "broadcast";
+    from: string;
     body: {
         format: "markdown" | "html";
         content: string;
@@ -1555,7 +1598,7 @@ interface NewslettersAbWinnerResponse {
     scheduled_for: string | null;
     send_started_at: string | null;
     send_finished_at: string | null;
-    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate") | null;
+    pause_reason: ("manual" | "monthly_cap" | "auto_bounce_rate" | "auto_complaint_rate" | "test_batch_failed" | "workspace_suspended" | "plan_required" | "gmail_spam_rate" | "domain_required") | null;
     recipient_estimate: number | null;
     ab_test: {
         variants: {
@@ -1626,6 +1669,7 @@ interface ContactsListResponse {
             [k: string]: string | number | boolean;
         };
         tags: string[];
+        newsletter_subscribed: boolean;
         engagement: {
             emails_sent: number;
             emails_opened: number;
@@ -1658,6 +1702,10 @@ interface ContactsCreateParams {
      * Added to the contact's tags (also when the contact already exists).
      */
     tags?: string[];
+    /**
+     * 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.
+     */
+    newsletterSubscribed?: boolean;
 }
 interface ContactsCreateResponse {
     object: "contact";
@@ -1677,6 +1725,7 @@ interface ContactsCreateResponse {
         [k: string]: string | number | boolean;
     };
     tags: string[];
+    newsletter_subscribed: boolean;
     engagement: {
         emails_sent: number;
         emails_opened: number;
@@ -1720,6 +1769,10 @@ interface ContactsImportParams {
          * Merged into the tags of a contact already in the newsletter (never replaced).
          */
         tags?: string[] | null;
+        /**
+         * New contact: default `true`. `false` keeps them in the group only. A contact already in the group changes only with an explicit `true`.
+         */
+        newsletterSubscribed?: boolean | null;
         /**
          * `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`.
          */
@@ -1788,6 +1841,7 @@ interface ContactsGetResponse {
         [k: string]: string | number | boolean;
     };
     tags: string[];
+    newsletter_subscribed: boolean;
     engagement: {
         emails_sent: number;
         emails_opened: number;
@@ -1825,6 +1879,7 @@ interface ContactsUnsubscribeResponse {
         [k: string]: string | number | boolean;
     };
     tags: string[];
+    newsletter_subscribed: boolean;
     engagement: {
         emails_sent: number;
         emails_opened: number;
@@ -1854,6 +1909,7 @@ interface ContactsReactivateResponse {
         [k: string]: string | number | boolean;
     };
     tags: string[];
+    newsletter_subscribed: boolean;
     engagement: {
         emails_sent: number;
         emails_opened: number;
@@ -1895,6 +1951,10 @@ type ContactsUpdateParams = {
      * Removed from the current tags.
      */
     removeTags?: string[];
+    /**
+     * `true` subscribes the contact to the newsletter issues, `false` keeps them in the group only (broadcasts still reach them).
+     */
+    newsletterSubscribed?: boolean;
 };
 interface ContactsUpdateResponse {
     object: "contact";
@@ -1914,6 +1974,7 @@ interface ContactsUpdateResponse {
         [k: string]: string | number | boolean;
     };
     tags: string[];
+    newsletter_subscribed: boolean;
     engagement: {
         emails_sent: number;
         emails_opened: number;
@@ -1933,7 +1994,7 @@ interface ContactFieldsListResponse {
         label: string;
         type: "text" | "number" | "date" | "boolean" | "choice";
         options: string[] | null;
-        default_value: (string | number | boolean) | null;
+        default_value: string | number | boolean | null;
         in_signup: boolean;
         position: number;
         created_at: string;
@@ -1969,7 +2030,7 @@ interface ContactFieldsCreateResponse {
     label: string;
     type: "text" | "number" | "date" | "boolean" | "choice";
     options: string[] | null;
-    default_value: (string | number | boolean) | null;
+    default_value: string | number | boolean | null;
     in_signup: boolean;
     position: number;
     created_at: string;
@@ -1990,7 +2051,7 @@ interface ContactFieldsUpdateResponse {
     label: string;
     type: "text" | "number" | "date" | "boolean" | "choice";
     options: string[] | null;
-    default_value: (string | number | boolean) | null;
+    default_value: string | number | boolean | null;
     in_signup: boolean;
     position: number;
     created_at: string;
@@ -2366,7 +2427,7 @@ type SegmentsDomainSetParams = {
     id: string;
 } & {
     /**
-     * Subdomain you own, e.g. `news.acme.com` (a CNAME to Vercel).
+     * Subdomain you own, e.g. `news.acme.com` (a CNAME to `customers.smartletter.ai`).
      */
     domain: string;
 };
@@ -2516,6 +2577,7 @@ interface DomainsCreateResponse {
     id: string;
     name: string;
     status: "not_started" | "pending" | "verified" | "temporary_failure" | "failed";
+    review_status?: "none" | "pending" | "held" | "approved" | "rejected";
     created_at: string;
     region: string;
     records: {
@@ -2550,6 +2612,7 @@ interface DomainsListResponse {
         id: string;
         name: string;
         status: "not_started" | "pending" | "verified" | "temporary_failure" | "failed";
+        review_status?: "none" | "pending" | "held" | "approved" | "rejected";
         created_at: string;
         region: string;
     }[];
@@ -2562,6 +2625,7 @@ interface DomainsGetResponse {
     id: string;
     name: string;
     status: "not_started" | "pending" | "verified" | "temporary_failure" | "failed";
+    review_status?: "none" | "pending" | "held" | "approved" | "rejected";
     created_at: string;
     region: string;
     records: {
@@ -2841,7 +2905,7 @@ interface SequencesListResponse {
             type: "update_contact";
             action: "set_field";
             key: string;
-            value: (string | number | boolean) | null;
+            value: string | number | boolean | null;
         } | {
             id: string;
             type: "update_contact";
@@ -3025,7 +3089,7 @@ interface SequencesCreateParams {
         /**
          * update_contact set_field: `null` clears it.
          */
-        value?: (string | number | boolean) | null;
+        value?: string | number | boolean | null;
         /**
          * update_contact (un)subscribe_topic.
          */
@@ -3135,7 +3199,7 @@ interface SequencesCreateResponse {
         type: "update_contact";
         action: "set_field";
         key: string;
-        value: (string | number | boolean) | null;
+        value: string | number | boolean | null;
     } | {
         id: string;
         type: "update_contact";
@@ -3260,7 +3324,7 @@ interface SequencesGetResponse {
         type: "update_contact";
         action: "set_field";
         key: string;
-        value: (string | number | boolean) | null;
+        value: string | number | boolean | null;
     } | {
         id: string;
         type: "update_contact";
@@ -3445,7 +3509,7 @@ type SequencesUpdateParams = {
         /**
          * update_contact set_field: `null` clears it.
          */
-        value?: (string | number | boolean) | null;
+        value?: string | number | boolean | null;
         /**
          * update_contact (un)subscribe_topic.
          */
@@ -3555,7 +3619,7 @@ interface SequencesUpdateResponse {
         type: "update_contact";
         action: "set_field";
         key: string;
-        value: (string | number | boolean) | null;
+        value: string | number | boolean | null;
     } | {
         id: string;
         type: "update_contact";
@@ -3693,7 +3757,7 @@ interface SequencesActivateResponse {
         type: "update_contact";
         action: "set_field";
         key: string;
-        value: (string | number | boolean) | null;
+        value: string | number | boolean | null;
     } | {
         id: string;
         type: "update_contact";
@@ -3818,7 +3882,7 @@ interface SequencesPauseResponse {
         type: "update_contact";
         action: "set_field";
         key: string;
-        value: (string | number | boolean) | null;
+        value: string | number | boolean | null;
     } | {
         id: string;
         type: "update_contact";
@@ -3943,7 +4007,7 @@ interface SequencesArchiveResponse {
         type: "update_contact";
         action: "set_field";
         key: string;
-        value: (string | number | boolean) | null;
+        value: string | number | boolean | null;
     } | {
         id: string;
         type: "update_contact";
@@ -4706,6 +4770,7 @@ type ThreadsReplyResponse = {
     delivery: string | null;
 } | {
     object: "inbox_message";
+    id: string;
     email_id: string;
     status: "sent";
 };
@@ -4881,6 +4946,7 @@ type MessagesSendResponse = {
     delivery: string;
 } | {
     object: "inbox_message";
+    id: string;
     email_id: string;
     status: "sent";
 };

package/dist/index.mjs

@@ -43,7 +43,7 @@ var Client = class {
     }
     this.key = resolved;
     this.baseUrl = (options.baseUrl || env("SMARTLETTER_BASE_URL") || DEFAULT_BASE_URL).replace(/\/+$/, "");
-    this.userAgent = options.userAgent ?? `smartletter-node/${"1.2.0"}`;
+    this.userAgent = options.userAgent ?? `smartletter-node/${"1.3.0"}`;
   }
   async call(op, args, options = {}) {
     const headers = new Headers(options.headers);
@@ -641,6 +641,12 @@ var OPERATIONS = {
             wire: "winner_mode"
           }
         }
+      },
+      kind: {
+        wire: "kind"
+      },
+      from: {
+        wire: "from"
       }
     }
   },
@@ -755,6 +761,12 @@ var OPERATIONS = {
             wire: "winner_mode"
           }
         }
+      },
+      kind: {
+        wire: "kind"
+      },
+      from: {
+        wire: "from"
       }
     }
   },
@@ -939,6 +951,9 @@ var OPERATIONS = {
       },
       tags: {
         wire: "tags"
+      },
+      newsletterSubscribed: {
+        wire: "newsletter_subscribed"
       }
     }
   },
@@ -989,6 +1004,9 @@ var OPERATIONS = {
           tags: {
             wire: "tags"
           },
+          newsletterSubscribed: {
+            wire: "newsletter_subscribed"
+          },
           status: {
             wire: "status"
           },
@@ -1079,6 +1097,9 @@ var OPERATIONS = {
       },
       removeTags: {
         wire: "remove_tags"
+      },
+      newsletterSubscribed: {
+        wire: "newsletter_subscribed"
       }
     }
   },