shipmail 0.1.31 → 0.1.33

package/README.md

@@ -18,6 +18,7 @@ Official TypeScript SDK for the [Shipmail](https://shipmail.to) API. Zero runtim
 - [Domains](#domains)
 - [Mailboxes](#mailboxes)
 - [Messages](#messages)
+- [Sandbox](#sandbox)
 - [Threads](#threads)
 - [Webhooks](#webhooks)
 - [Suppressions](#suppressions)
@@ -60,7 +61,12 @@ const message = await shipmail.messages.send({
   subject: "Hello",
   text: "Hi there",
   html: "<p>Hi there</p>",
+  client_reference: "crm-123",
+  metadata: { campaign: "onboarding" },
+  source_rfc_message_id: "<crm-123@example.com>",
 });
+
+const sameMessage = await shipmail.messages.list({ client_reference: "crm-123" });
 ```
 
 The SDK does not auto-read environment variables. Pass the key explicitly.
@@ -81,6 +87,7 @@ const shipmail = new ShipMailClient({
   timeout: 30_000,
   fetch: customFetch,
   defaultHeaders: { "x-app-name": "my-app" },
+  organizationId: "00000000-0000-4000-8000-000000000123",
 });
 ```
 
@@ -92,6 +99,7 @@ const shipmail = new ShipMailClient({
 | `timeout`        | `number`                 | `30_000`                     | Per-request timeout in ms.                                      |
 | `fetch`          | `typeof fetch`           | `globalThis.fetch`           | Custom fetch implementation.                                    |
 | `defaultHeaders` | `Record<string, string>` | `{}`                         | Headers added to every request.                                 |
+| `organizationId` | `string`                 | none                         | Delegated child organization for approved infrastructure calls. |
 
 ## Domains
 
@@ -99,6 +107,7 @@ const shipmail = new ShipMailClient({
 await shipmail.domains.create({ name: "example.com" });
 await shipmail.domains.list({ limit: 10 });
 await shipmail.domains.get("dom_...");
+await shipmail.domains.getDnsRecords("dom_...");
 await shipmail.domains.update("dom_...", { catch_all_mailbox_id: "mbx_..." });
 await shipmail.domains.delete("dom_...");
 await shipmail.domains.verify("dom_...");
@@ -121,12 +130,20 @@ await shipmail.domains.register({
 await shipmail.mailboxes.create({
   domain_id: "dom_...",
   address: "hello",
+  password: "StrongPass123",
   display_name: "Hello",
 });
 await shipmail.mailboxes.list({ domain_id: "dom_..." });
 await shipmail.mailboxes.get("mbx_...");
 await shipmail.mailboxes.update("mbx_...", { display_name: "New Name" });
+await shipmail.mailboxes.suspend("mbx_...");
+await shipmail.mailboxes.resume("mbx_...");
 await shipmail.mailboxes.resetPassword("mbx_...", { password: "NewPassword1" });
+const forwarding = await shipmail.mailboxes.createForwarding("mbx_...", {
+  destination: "owner@example.net",
+});
+const forwardingList = await shipmail.mailboxes.listForwarding("mbx_...");
+await shipmail.mailboxes.deleteForwarding("mbx_...", forwarding.id);
 const folders = await shipmail.mailboxes.listFolders("mbx_...");
 const folder = await shipmail.mailboxes.createFolder("mbx_...", {
   name: "VIP",
@@ -170,6 +187,28 @@ await shipmail.messages.reply("msg_...", {
 });
 ```
 
+## Sandbox
+
+Create a test API key (`sm_test_...`) to simulate email without contacting real recipients. Test messages, threads, rules, webhooks, quota, suppressions, and reputation are isolated from live mode.
+
+```ts
+const testClient = new ShipMailClient("sm_test_...");
+
+await testClient.messages.send({
+  mailbox_id: "mbx_...",
+  to: ["customer@example.com"],
+  subject: "Sandbox test",
+  text: "Not delivered",
+  sandbox_outcome: "bounced",
+});
+
+await testClient.mailboxes.injectSandboxInbound("mbx_...", {
+  from: "customer@example.com",
+  subject: "Re: Sandbox test",
+  text: "Fake inbound reply",
+});
+```
+
 ## Threads
 
 ```ts
@@ -200,6 +239,10 @@ await shipmail.webhooks.delete("whk_...");
 await shipmail.webhooks.rotateSecret("whk_...");
 await shipmail.webhooks.test("whk_...");
 await shipmail.webhooks.listDeliveries("whk_...");
+await shipmail.webhooks.getDelivery("whk_...", "dlv_...");
+await shipmail.webhooks.replayDelivery("whk_...", "dlv_...", {
+  idempotencyKey: "replay-dlv-123",
+});
 ```
 
 Supported event types:
@@ -308,6 +351,42 @@ URLs, and video thumbnails contribute to deliverability checks.
 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.
 
+## Partner beta
+
+Approved partner accounts can create isolated operator-owned organizations and read consolidated
+usage:
+
+```ts
+const child = await shipmail.partner.createOrganization(
+  {
+    name: "Operator",
+    external_reference: "operator_123",
+    owner_email: "owner@example.com",
+    mailbox_limit: 3,
+    data_classification: "internal_test",
+  },
+  { idempotencyKey: "operator-123" },
+);
+
+const delegated = new ShipMailClient({
+  apiKey: process.env.SHIPMAIL_API_KEY!,
+  organizationId: child.organization_id,
+});
+
+await delegated.domains.list();
+await delegated.mailboxes.create({
+  domain_id: "dom_...",
+  address: "support",
+  generate_password: true,
+});
+await shipmail.partner.usage();
+```
+
+Use a separate client for delegated infrastructure. Partner target context is not accepted by
+message, thread, calendar, contacts, export, suppression, billing, or password endpoints. The beta
+requires Shipmail approval and externally owned domains. Delegated mailbox creation must use
+`generate_password: true`; the generated primary password is never returned to the partner.
+
 ## Status
 
 ```ts
@@ -394,6 +473,7 @@ type MethodOptions = {
   signal?: AbortSignal;
   headers?: Record<string, string>;
   idempotencyKey?: string;
+  organizationId?: string;
 };
 ```
 

package/dist/index.cjs

@@ -446,6 +446,13 @@ var Domains = class extends ApiResource {
       methodOptions: options
     });
   }
+  getDnsRecords(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/domains/${encodeURIComponent(id)}/dns-records`,
+      methodOptions: options
+    });
+  }
   update(id, params, options) {
     return this.client.request({
       method: "PATCH",
@@ -488,6 +495,14 @@ var Domains = class extends ApiResource {
 
 // src/resources/mailboxes.ts
 var Mailboxes = class extends ApiResource {
+  injectSandboxInbound(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/sandbox/inbound`,
+      body: params,
+      methodOptions: options
+    });
+  }
   create(params, options) {
     return this.client.request({
       method: "POST",
@@ -536,6 +551,34 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
+  suspend(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/suspend`,
+      methodOptions: options
+    });
+  }
+  resume(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/resume`,
+      methodOptions: options
+    });
+  }
+  createExport(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/exports`,
+      methodOptions: options
+    });
+  }
+  getExport(id, exportId, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/mailboxes/${encodeURIComponent(id)}/exports/${encodeURIComponent(exportId)}`,
+      methodOptions: options
+    });
+  }
   listFolders(id, options) {
     return this.client.request({
       method: "GET",
@@ -653,6 +696,28 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
+  listForwarding(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/mailboxes/${encodeURIComponent(id)}/forwarding`,
+      methodOptions: options
+    });
+  }
+  createForwarding(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/forwarding`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  deleteForwarding(id, forwardingId, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/mailboxes/${encodeURIComponent(id)}/forwarding/${encodeURIComponent(forwardingId)}`,
+      methodOptions: options
+    });
+  }
   updateAutoReply(id, params, options) {
     return this.client.request({
       method: "PATCH",
@@ -731,6 +796,7 @@ var Messages = class extends ApiResource {
       path: "/messages",
       query: {
         mailbox_id: params.mailbox_id,
+        client_reference: params.client_reference,
         cursor: params.cursor,
         limit: params.limit
       },
@@ -740,6 +806,7 @@ var Messages = class extends ApiResource {
   listAutoPaginating(params) {
     return new Page(this.client, "/messages", {
       mailbox_id: params.mailbox_id,
+      client_reference: params.client_reference,
       limit: params.limit
     });
   }
@@ -911,6 +978,72 @@ var Newsletters = class extends ApiResource {
   }
 };
 
+// src/resources/partner.ts
+var Partner = class extends ApiResource {
+  listOrganizations(options) {
+    return this.client.request({
+      method: "GET",
+      path: "/partner/organizations",
+      methodOptions: options
+    });
+  }
+  createOrganization(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/partner/organizations",
+      body: params,
+      methodOptions: options
+    });
+  }
+  getOrganization(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/partner/organizations/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+  updateOrganization(id, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/partner/organizations/${encodeURIComponent(id)}`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  resendOwnershipInvitation(id, params = {}, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/partner/organizations/${encodeURIComponent(id)}/ownership-invitations`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  suspendOrganization(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/partner/organizations/${encodeURIComponent(id)}/suspend`,
+      methodOptions: options
+    });
+  }
+  resumeOrganization(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/partner/organizations/${encodeURIComponent(id)}/resume`,
+      methodOptions: options
+    });
+  }
+  offboardOrganization(id, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/partner/organizations/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+  usage(options) {
+    return this.client.request({ method: "GET", path: "/partner/usage", methodOptions: options });
+  }
+};
+
 // src/resources/status.ts
 var Status = class extends ApiResource {
   get(options) {
@@ -1076,10 +1209,24 @@ var Webhooks = class extends ApiResource {
       }
     );
   }
+  getDelivery(id, deliveryId, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/webhooks/${encodeURIComponent(id)}/deliveries/${encodeURIComponent(deliveryId)}`,
+      methodOptions: options
+    });
+  }
+  replayDelivery(id, deliveryId, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/webhooks/${encodeURIComponent(id)}/deliveries/${encodeURIComponent(deliveryId)}/replay`,
+      methodOptions: options
+    });
+  }
 };
 
 // src/version.ts
-var VERSION = "0.1.31";
+var VERSION = "0.1.33";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1122,6 +1269,7 @@ var ShipMailClient = class {
       this.timeout = DEFAULT_TIMEOUT;
       this.fetchFn = globalThis.fetch;
       this.defaultHeaders = {};
+      this.organizationId = void 0;
     } else {
       this.apiKey = config.apiKey;
       this.baseUrl = config.baseUrl ?? DEFAULT_BASE_URL;
@@ -1129,6 +1277,7 @@ var ShipMailClient = class {
       this.timeout = config.timeout ?? DEFAULT_TIMEOUT;
       this.fetchFn = config.fetch ?? globalThis.fetch;
       this.defaultHeaders = config.defaultHeaders ? { ...config.defaultHeaders } : {};
+      this.organizationId = config.organizationId;
     }
     this.audiences = new Audiences(this);
     this.bookingPages = new BookingPages(this);
@@ -1137,6 +1286,7 @@ var ShipMailClient = class {
     this.mailboxes = new Mailboxes(this);
     this.messages = new Messages(this);
     this.newsletters = new Newsletters(this);
+    this.partner = new Partner(this);
     this.suppressions = new Suppressions(this);
     this.threads = new Threads(this);
     this.webhooks = new Webhooks(this);
@@ -1177,6 +1327,10 @@ var ShipMailClient = class {
         if (methodOpts?.idempotencyKey) {
           headers["Idempotency-Key"] = methodOpts.idempotencyKey;
         }
+        const targetOrganizationId = methodOpts?.organizationId ?? this.organizationId;
+        if (targetOrganizationId) {
+          headers["X-ShipMail-Organization-Id"] = targetOrganizationId;
+        }
         let body = null;
         if (options.rawBody !== void 0) {
           headers["Content-Type"] = options.contentType ?? "application/octet-stream";
@@ -1233,6 +1387,9 @@ var ShipMailClient = class {
   }
 };
 
+// src/types/booking-page.ts
+var CONFERENCING_PROVIDER_IDS = ["zoom", "google_meet"];
+
 // src/types/common.ts
 var WEBHOOK_EVENT_TYPES = [
   "message.received",
@@ -1240,6 +1397,7 @@ var WEBHOOK_EVENT_TYPES = [
   "message.delivered",
   "message.bounced",
   "message.complained",
+  "mailbox.rule_matched",
   "domain.verified",
   "domain.verification_failed",
   "domain.degraded",
@@ -1248,6 +1406,7 @@ var WEBHOOK_EVENT_TYPES = [
   "org.sending_suspended",
   "org.reputation_recovered"
 ];
+var WEBHOOK_DELIVERY_EVENT_TYPES = ["webhook.test", ...WEBHOOK_EVENT_TYPES];
 var DOMAIN_STATUSES = ["pending", "verifying", "verified", "degraded", "failed"];
 var MESSAGE_STATUSES = [
   "scheduled",
@@ -1313,6 +1472,7 @@ async function verifyWebhook(body, headers, secret, options) {
 
 exports.AuthenticationError = AuthenticationError;
 exports.AuthorizationError = AuthorizationError;
+exports.CONFERENCING_PROVIDER_IDS = CONFERENCING_PROVIDER_IDS;
 exports.ConflictError = ConflictError;
 exports.ConnectionError = ConnectionError;
 exports.DOMAIN_STATUSES = DOMAIN_STATUSES;
@@ -1326,6 +1486,7 @@ exports.RateLimitError = RateLimitError;
 exports.ShipMailClient = ShipMailClient;
 exports.ShipMailError = ShipMailError;
 exports.ValidationError = ValidationError;
+exports.WEBHOOK_DELIVERY_EVENT_TYPES = WEBHOOK_DELIVERY_EVENT_TYPES;
 exports.WEBHOOK_DELIVERY_STATUSES = WEBHOOK_DELIVERY_STATUSES;
 exports.WEBHOOK_EVENT_TYPES = WEBHOOK_EVENT_TYPES;
 exports.WebhookVerificationError = WebhookVerificationError;