smartletter 1.1.0 → 1.3.0

package/README.md

@@ -97,6 +97,54 @@ const event = smartletter.webhooks.verify({
 });
 ```
 
+## Changelog
+
+### 1.3.0
+
+New fields only, nothing renamed or removed.
+
+- `newsletters.create` and `newsletters.update` take `kind` and `from`. `kind: "newsletter"` (the default) goes to the subscribers of the newsletter or of a topic. `kind: "broadcast"` goes to the contacts of the group, subscribed or not, takes no `topicId` and never shows in the archive. `from` is the sender address of this issue, on the newsletter's custom domain (`name@your-domain.com`, or just `name`). Every newsletter returned has `kind` and `from`.
+- `newsletters.update` accepts `topicId: null` for a broadcast.
+- `contacts.create`, `contacts.update` and `contacts.import` take `newsletterSubscribed`. `false` adds the contact to the group only: they get broadcasts, not newsletter issues. A new contact defaults to `true`. An existing contact changes only with an explicit `true` (`contacts.update` also takes `false`). Every contact returned has `newsletter_subscribed`.
+- Sending needs a verified domain of your own. Without one, the API answers `403 domain_required_to_send`; a young domain still in review answers `403 domain_under_review`. `pause_reason` may be `domain_required`, and domains return `review_status`.
+- `threads.reply` and `messages.send` always return `id`, also when the message is queued before its row exists.
+
+### 1.2.0
+
+**Breaking changes.** Two fields of the API's answers are renamed to snake_case, like every other field. There is no alias: the old name is gone.
+
+- `body.blocks[].blockId` is now `block_id` in every newsletter returned with its body (`newsletters.get`, `newsletters.create`, `newsletters.update`, `newsletters.duplicate`…). Read `block.block_id`.
+- `POST /agent-tasks/{id}/complete` answers `{ newsletter_id, scheduled_for, review }` instead of `{ newsletterId, scheduledFor, review }` (the MCP tool `agent_tasks.complete` too). This route is not in the SDK: update the scripts that call it.
+
+Other API changes:
+
+- `newsletters.list`: the `status` filter takes `cancelled` and `held`. `failed` is no longer in the type (no newsletter ever has it); the API still accepts it and returns an empty list.
+- `pause_reason` may be `gmail_spam_rate` (paused after too many spam reports at Gmail). It was already sent; the type now lists it.
+- `newsletters.test` returns `variants`: the number of emails sent (one per A/B variant, 1 without a test).
+- `segments.domain.remove` returns `id` (the newsletter's id), like every deletion.
+- `sequences.unenroll` returns the enrollment's real status: `exited` when the contact was taken out, `completed` or `exited` unchanged when the run was already over.
+- `topics.list` returns `has_more: true` when the newsletter has more than 200 topics (it returns the newest 200).
+- `threads.list` and `sequences.enrollments` take the standard pagination: `limit`, `after` and `before`. `threads.list` used to refuse `before`; `sequences.enrollments` ignored `after` and `before` (its `limit` still defaults to 100).
+- `contacts.create` documents its `200` answer: an address already there returns the existing contact with `existed: true`, unchanged.
+
+Response types now come from the API's response schemas, which are checked against what the API really answers. They no longer come from the documentation examples. The runtime is unchanged. Only the types are more exact:
+
+- `object`, statuses and event names are literal types, for example `"list"`, `"sent"` or `"email.delivered"`, instead of `string`.
+- Fields the examples left out are now typed, and so are the fields they showed as `null` or `[]` (until now `unknown`).
+- 125 fields that can be `null` are now `T | null`. Under `strictNullChecks`, handle the `null` case.
+- Fields that were in an example but never in a response are gone:
+  - `body` in the `newsletters.list` items;
+  - the spam fields on sent and draft inbox messages;
+  - `reasons.invalid` in `contacts.import`.
+- Shapes that vary are unions. Narrow on `direction` (inbox messages), `body.format` (newsletters), the step and trigger `type` (sequences), or `deleted` (`sequences.remove`).
+- Dictionaries whose keys you choose are `Record<string, …>`: `custom_fields`, `metadata`, `properties` and filter `rules`.
+- Free-form objects are `Record<string, unknown>` too: the condition step's `rule` and the items of its `yes` and `no` branches (sequences), and the webhook `payload.data` (`webhooks.test`, `webhooks.deliveries`, `webhooks.retryDelivery`).
+- `links.x` in `segments.archive.get` and `segments.archive.update` is optional: it is missing when no X link is set.
+- Webhook `events` (`webhooks.list`, `webhooks.get`) is a union of event names, such as `"email.delivered"`, instead of `string[]`.
+- `messages.send` returns the message sent (`status: "sent"`), or `{ object, email_id, status }` when the email was queued but its record could not be saved. `threads.reply` returns the same, or the saved draft (`status: "draft"`) with `draft: true`.
+
+Answers may gain fields in a later version. The types stay open for reading: a field the API adds does not break your code. Lists of values (statuses, event names) may grow too, so keep a default branch when you switch on one.
+
 ## License
 
 MIT

package/dist/index.cjs

@@ -81,7 +81,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.1.0"}`;
+    this.userAgent = options.userAgent ?? `smartletter-node/${"1.3.0"}`;
   }
   async call(op, args, options = {}) {
     const headers = new Headers(options.headers);
@@ -679,6 +679,12 @@ var OPERATIONS = {
             wire: "winner_mode"
           }
         }
+      },
+      kind: {
+        wire: "kind"
+      },
+      from: {
+        wire: "from"
       }
     }
   },
@@ -793,6 +799,12 @@ var OPERATIONS = {
             wire: "winner_mode"
           }
         }
+      },
+      kind: {
+        wire: "kind"
+      },
+      from: {
+        wire: "from"
       }
     }
   },
@@ -977,6 +989,9 @@ var OPERATIONS = {
       },
       tags: {
         wire: "tags"
+      },
+      newsletterSubscribed: {
+        wire: "newsletter_subscribed"
       }
     }
   },
@@ -1027,6 +1042,9 @@ var OPERATIONS = {
           tags: {
             wire: "tags"
           },
+          newsletterSubscribed: {
+            wire: "newsletter_subscribed"
+          },
           status: {
             wire: "status"
           },
@@ -1117,6 +1135,9 @@ var OPERATIONS = {
       },
       removeTags: {
         wire: "remove_tags"
+      },
+      newsletterSubscribed: {
+        wire: "newsletter_subscribed"
       }
     }
   },
@@ -2111,14 +2132,20 @@ var OPERATIONS = {
     method: "GET",
     path: "/sequences/{id}/enrollments",
     pathParams: ["id"],
-    paginated: false,
+    paginated: true,
     idempotent: false,
     query: {
-      status: {
-        wire: "status"
-      },
       limit: {
         wire: "limit"
+      },
+      after: {
+        wire: "after"
+      },
+      before: {
+        wire: "before"
+      },
+      status: {
+        wire: "status"
       }
     }
   },
@@ -2375,9 +2402,18 @@ var OPERATIONS = {
     method: "GET",
     path: "/threads",
     pathParams: [],
-    paginated: false,
+    paginated: true,
     idempotent: false,
     query: {
+      limit: {
+        wire: "limit"
+      },
+      after: {
+        wire: "after"
+      },
+      before: {
+        wire: "before"
+      },
       inboxId: {
         wire: "inbox_id"
       },
@@ -2395,12 +2431,6 @@ var OPERATIONS = {
       },
       unread: {
         wire: "unread"
-      },
-      limit: {
-        wire: "limit"
-      },
-      after: {
-        wire: "after"
       }
     }
   },