shipmail 0.1.24 → 0.1.26

package/README.md

@@ -21,6 +21,8 @@ Official TypeScript SDK for the [Shipmail](https://shipmail.to) API. Zero runtim
 - [Threads](#threads)
 - [Webhooks](#webhooks)
 - [Suppressions](#suppressions)
+- [Audiences](#audiences)
+- [Newsletters](#newsletters)
 - [Status](#status)
 - [Pagination](#pagination)
 - [Webhook verification](#webhook-verification)
@@ -232,6 +234,72 @@ for await (const item of shipmail.suppressions.listAutoPaginating({ limit: 100 }
 }
 ```
 
+## Audiences
+
+```ts
+const audience = await shipmail.audiences.create({
+  name: "Newsletter",
+  consent_source: "Website signup form",
+});
+
+await shipmail.audiences.subscribers.add(audience.id, {
+  email_address: "jane@example.com",
+  merge_fields: { plan: "pro" },
+});
+```
+
+## Newsletters
+
+```ts
+import { readFile } from "node:fs/promises";
+
+const newsletterDomains = await shipmail.newsletters.domains.list({ limit: 25 });
+const hero = await shipmail.newsletters.assets.upload({
+  filename: "hero.png",
+  content_type: "image/png",
+  data: await readFile("hero.png"),
+});
+
+const newsletter = await shipmail.newsletters.create({
+  audience_id: "aud_...",
+  newsletter_domain_id: newsletterDomains.data[0].id,
+  name: "July changelog",
+  subject: "What shipped in July",
+  preview_text: "A quick product update",
+  blocks: [
+    { type: "heading", level: 1, text: "July updates" },
+    { type: "callout", variant: "info", title: "Quick note", body: "A short intro." },
+    { type: "paragraph", body: "A quick product update." },
+    { type: "image", url: hero.url, alt: "Product screenshot" },
+    {
+      type: "columns",
+      ratio: "50-50",
+      left: { title: "For teams", body: "Shared inbox improvements." },
+      right: { title: "For agents", body: "API and MCP improvements." },
+    },
+  ],
+});
+
+await shipmail.newsletters.preview(newsletter.id);
+
+await shipmail.newsletters.sendTest(newsletter.id, {
+  recipient_email: "owner@example.com",
+});
+
+await shipmail.newsletters.preflight(newsletter.id);
+
+await shipmail.newsletters.schedule(newsletter.id, {
+  scheduled_at: "2026-08-01T09:00:00.000Z",
+});
+```
+
+Newsletter test sends and schedules must pass preflight. Guardrail failures throw
+`ValidationError` with the failed preflight items in `error.details`.
+Preflight responses include `url_breakdown` so you can see which links, image
+URLs, and video thumbnails count against the 20 unique URL limit.
+Block prose fields are plain text in API requests. Use newlines for paragraph
+breaks, and use `body_html` or `custom_html` only when you need raw HTML.
+
 ## Status
 
 ```ts
@@ -263,7 +331,7 @@ for await (const domain of shipmail.domains.listAutoPaginating({ limit: 25 })) {
 }
 ```
 
-`listAutoPaginating` is available on `domains`, `mailboxes`, `messages`, `threads`, `webhooks`, `webhooks.listDeliveriesAutoPaginating`, and `suppressions`.
+`listAutoPaginating` is available on `domains`, `mailboxes`, `messages`, `threads`, `webhooks`, `webhooks.listDeliveriesAutoPaginating`, `suppressions`, `newsletters.domains`, and `newsletters.assets`.
 
 ## Webhook verification
 

package/dist/index.cjs

@@ -117,9 +117,9 @@ function mapErrorFromResponse(status, body, requestId) {
 
 // src/pagination.ts
 var Page = class {
-  constructor(client, path, query) {
+  constructor(client, path2, query) {
     this.client = client;
-    this.path = path;
+    this.path = path2;
     this.query = query;
   }
   async *[Symbol.asyncIterator]() {
@@ -619,6 +619,149 @@ var Messages = class extends ApiResource {
   }
 };
 
+// src/resources/newsletters.ts
+function path(id) {
+  return `/newsletters/${encodeURIComponent(id)}`;
+}
+var NewsletterDomains = class extends ApiResource {
+  list(params, options) {
+    return this.client.request({
+      method: "GET",
+      path: "/newsletter-domains",
+      query: { cursor: params?.cursor, limit: params?.limit },
+      methodOptions: options
+    });
+  }
+  listAutoPaginating(params) {
+    return new Page(this.client, "/newsletter-domains", { limit: params?.limit });
+  }
+};
+var NewsletterAssets = class extends ApiResource {
+  list(params, options) {
+    return this.client.request({
+      method: "GET",
+      path: "/newsletter-assets",
+      query: {
+        cursor: params?.cursor,
+        limit: params?.limit,
+        kind: params?.kind,
+        q: params?.q
+      },
+      methodOptions: options
+    });
+  }
+  listAutoPaginating(params) {
+    return new Page(this.client, "/newsletter-assets", {
+      limit: params?.limit,
+      kind: params?.kind,
+      q: params?.q
+    });
+  }
+  upload(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/newsletter-assets",
+      query: { filename: params.filename },
+      rawBody: params.data,
+      contentType: params.content_type,
+      methodOptions: options
+    });
+  }
+};
+var Newsletters = class extends ApiResource {
+  constructor(client) {
+    super(client);
+    this.domains = new NewsletterDomains(client);
+    this.assets = new NewsletterAssets(client);
+  }
+  create(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/newsletters",
+      body: params,
+      methodOptions: options
+    });
+  }
+  createFromChangelog(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/newsletters/from-changelog",
+      body: params,
+      methodOptions: options
+    });
+  }
+  list(params, options) {
+    return this.client.request({
+      method: "GET",
+      path: "/newsletters",
+      query: { cursor: params?.cursor, limit: params?.limit },
+      methodOptions: options
+    });
+  }
+  listAutoPaginating(params) {
+    return new Page(this.client, "/newsletters", { limit: params?.limit });
+  }
+  get(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: path(id),
+      methodOptions: options
+    });
+  }
+  update(id, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: path(id),
+      body: params,
+      methodOptions: options
+    });
+  }
+  preflight(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/preflight`,
+      methodOptions: options
+    });
+  }
+  preview(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/preview`,
+      methodOptions: options
+    });
+  }
+  sendTest(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/test-send`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  schedule(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/schedule`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  cancel(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/cancel`,
+      methodOptions: options
+    });
+  }
+  resume(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/resume`,
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/status.ts
 var Status = class extends ApiResource {
   get(options) {
@@ -787,7 +930,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.1.24";
+var VERSION = "0.1.26";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -811,6 +954,12 @@ function isApiErrorBody(value) {
   const error = obj["error"];
   return typeof error["type"] === "string" && typeof error["message"] === "string";
 }
+function rawBodyToBlobPart(rawBody) {
+  if (rawBody instanceof ArrayBuffer) return rawBody;
+  const buffer = new ArrayBuffer(rawBody.byteLength);
+  new Uint8Array(buffer).set(rawBody);
+  return buffer;
+}
 var ShipMailClient = class {
   /**
    * Create a new ShipMail client.
@@ -836,6 +985,7 @@ var ShipMailClient = class {
     this.domains = new Domains(this);
     this.mailboxes = new Mailboxes(this);
     this.messages = new Messages(this);
+    this.newsletters = new Newsletters(this);
     this.suppressions = new Suppressions(this);
     this.threads = new Threads(this);
     this.webhooks = new Webhooks(this);
@@ -879,7 +1029,7 @@ var ShipMailClient = class {
         let body = null;
         if (options.rawBody !== void 0) {
           headers["Content-Type"] = options.contentType ?? "application/octet-stream";
-          body = new Blob([options.rawBody]);
+          body = new Blob([rawBodyToBlobPart(options.rawBody)]);
         } else if (options.body !== void 0) {
           headers["Content-Type"] = "application/json";
           body = JSON.stringify(options.body);
@@ -919,8 +1069,8 @@ var ShipMailClient = class {
     }
     throw lastError ?? new ShipMailError("Request failed after retries");
   }
-  buildUrl(path, query) {
-    const url = new URL(`${this.baseUrl}${path}`);
+  buildUrl(path2, query) {
+    const url = new URL(`${this.baseUrl}${path2}`);
     if (query) {
       for (const [key, value] of Object.entries(query)) {
         if (value !== void 0) {