shipmail 0.1.32 → 0.2.0

package/README.md

@@ -87,6 +87,7 @@ const shipmail = new ShipMailClient({
   timeout: 30_000,
   fetch: customFetch,
   defaultHeaders: { "x-app-name": "my-app" },
+  organizationId: "00000000-0000-4000-8000-000000000123",
 });
 ```
 
@@ -98,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
 
@@ -142,6 +144,12 @@ const forwarding = await shipmail.mailboxes.createForwarding("mbx_...", {
 });
 const forwardingList = await shipmail.mailboxes.listForwarding("mbx_...");
 await shipmail.mailboxes.deleteForwarding("mbx_...", forwarding.id);
+const appPassword = await shipmail.mailboxes.createAppPassword("mbx_...", {
+  name: "Desktop mail",
+  expires_at: "2026-10-01T00:00:00Z",
+});
+const appPasswords = await shipmail.mailboxes.listAppPasswords("mbx_...");
+await shipmail.mailboxes.revokeAppPassword("mbx_...", appPassword.id);
 const folders = await shipmail.mailboxes.listFolders("mbx_...");
 const folder = await shipmail.mailboxes.createFolder("mbx_...", {
   name: "VIP",
@@ -349,6 +357,50 @@ 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,
+});
+const grants = await shipmail.partner.listMailboxCredentialGrants();
+const credential = await shipmail.partner.consumeMailboxCredentialGrant(grants.data[0]!.id, {
+  name: "Embedded webmail",
+});
+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.
+The operator creates a one-time credential grant. Consuming it requires the exact
+`partner:mailbox_credentials:issue` scope and returns the app-password secret once. App-password
+creation and grant consumption do not accept idempotency keys because their plaintext response must
+never be cached.
+
 ## Status
 
 ```ts
@@ -435,6 +487,7 @@ type MethodOptions = {
   signal?: AbortSignal;
   headers?: Record<string, string>;
   idempotencyKey?: string;
+  organizationId?: string;
 };
 ```
 

package/dist/index.cjs

@@ -681,6 +681,28 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
+  listAppPasswords(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/mailboxes/${encodeURIComponent(id)}/app-passwords`,
+      methodOptions: options
+    });
+  }
+  createAppPassword(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/app-passwords`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  revokeAppPassword(id, appPasswordId, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/mailboxes/${encodeURIComponent(id)}/app-passwords/${encodeURIComponent(appPasswordId)}`,
+      methodOptions: options
+    });
+  }
   getRules(id, options) {
     return this.client.request({
       method: "GET",
@@ -978,6 +1000,87 @@ 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
+    });
+  }
+  listMailboxCredentialGrants(options) {
+    return this.client.request({
+      method: "GET",
+      path: "/partner/mailbox-credential-grants",
+      methodOptions: options
+    });
+  }
+  consumeMailboxCredentialGrant(grantId, params = {}, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/partner/mailbox-credential-grants/${encodeURIComponent(grantId)}/consume`,
+      body: params,
+      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) {
@@ -1160,7 +1263,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.1.32";
+var VERSION = "0.2.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1203,6 +1306,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;
@@ -1210,6 +1314,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);
@@ -1218,6 +1323,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);
@@ -1258,6 +1364,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";
@@ -1314,6 +1424,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",
@@ -1396,6 +1509,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;