shipmail 0.2.3 → 0.4.1

package/dist/index.js

@@ -1,3 +1,81 @@
+// src/api-key-scopes.ts
+var API_KEY_SCOPES = [
+  "*",
+  "audiences:read",
+  "audiences:write",
+  "booking_pages:read",
+  "booking_pages:write",
+  "calendar:read",
+  "calendar:write",
+  "domains:read",
+  "domains:write",
+  "mailboxes:read",
+  "mailboxes:export",
+  "mailboxes:write",
+  "mailbox_credentials:read",
+  "mailbox_credentials:write",
+  "mailbox_forwarding:read",
+  "mailbox_forwarding:write",
+  "messages:read",
+  "messages:write",
+  "drafts:write",
+  "messages:send",
+  "newsletters:read",
+  "newsletters:write",
+  "threads:read",
+  "webhooks:read",
+  "webhooks:write",
+  "suppressions:read",
+  "suppressions:write",
+  "partner:organizations:read",
+  "partner:organizations:write",
+  "partner:organizations:access",
+  "partner:mailbox_credentials:issue",
+  "partner:usage:read"
+];
+var API_KEY_SCOPE_DESCRIPTIONS = {
+  "*": "All non-partner API endpoints in this organization.",
+  "audiences:read": "List and retrieve newsletter audiences and their subscribers.",
+  "audiences:write": "Create audiences and add, update, or remove their subscribers.",
+  "booking_pages:read": "List and retrieve booking pages.",
+  "booking_pages:write": "Create, update, and delete booking pages.",
+  "calendar:read": "List and retrieve calendar events and open availability.",
+  "calendar:write": "Create, update, and delete calendar events.",
+  "domains:read": "List, retrieve, and verify domains.",
+  "domains:write": "Create, update, and delete domains.",
+  "mailboxes:read": "List and retrieve mailboxes.",
+  "mailboxes:export": "Create and download mailbox content exports.",
+  "mailboxes:write": "Create, update, suspend, resume, and delete mailboxes.",
+  "mailbox_credentials:read": "List revocable app passwords for allowed mailboxes.",
+  "mailbox_credentials:write": "Create and revoke app passwords for allowed mailboxes.",
+  "mailbox_forwarding:read": "List forwarding destinations for allowed mailboxes.",
+  "mailbox_forwarding:write": "Create and remove forwarding destinations for allowed mailboxes.",
+  "messages:read": "List and retrieve messages.",
+  "messages:write": "Update, move, delete, and inject sandbox messages.",
+  "drafts:write": "Create agent-safe reply drafts with server-derived recipients.",
+  "messages:send": "Send messages, replies, and approved reply drafts.",
+  "newsletters:read": "List and retrieve newsletter drafts and campaigns.",
+  "newsletters:write": "Create, update, test, schedule, cancel, and resume newsletters.",
+  "threads:read": "List threads and retrieve thread messages.",
+  "webhooks:read": "List webhooks, retrieve webhooks, and list deliveries.",
+  "webhooks:write": "Create, update, delete, test, and rotate webhooks.",
+  "suppressions:read": "List suppressed recipient addresses.",
+  "suppressions:write": "Remove addresses from the suppression list.",
+  "partner:organizations:read": "List and retrieve this partner's child organizations.",
+  "partner:organizations:write": "Create and manage this partner's child organizations.",
+  "partner:organizations:access": "Act on an active child using the delegated organization header.",
+  "partner:mailbox_credentials:issue": "List and consume operator-approved grants for embedded-webmail credentials.",
+  "partner:usage:read": "Read consolidated child and mailbox usage for this partner."
+};
+function isApiKeyScope(value) {
+  return API_KEY_SCOPES.some((scope) => scope === value);
+}
+function apiKeyScopesGrant(grantedScopes, requiredScope) {
+  if (requiredScope === "public") return true;
+  if (requiredScope.startsWith("partner:")) return grantedScopes.includes(requiredScope);
+  return grantedScopes.includes("*") || grantedScopes.includes(requiredScope);
+}
+
 // src/errors.ts
 var ShipMailError = class extends Error {
   constructor(message, options) {
@@ -409,6 +487,17 @@ var Calendar = class extends ApiResource {
   }
 };
 
+// src/resources/capabilities.ts
+var Capabilities = class extends ApiResource {
+  get(options) {
+    return this.client.request({
+      method: "GET",
+      path: "/capabilities",
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/domains.ts
 var Domains = class extends ApiResource {
   create(params, options) {
@@ -491,6 +580,24 @@ var Domains = class extends ApiResource {
 
 // src/resources/mailboxes.ts
 var Mailboxes = class extends ApiResource {
+  prepareStagedAttachmentUpload(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/staged-attachment-upload-tokens`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  stageAttachment(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/staged-attachments`,
+      query: { filename: params.filename },
+      rawBody: params.data,
+      contentType: params.content_type,
+      methodOptions: options
+    });
+  }
   injectSandboxInbound(id, params, options) {
     return this.client.request({
       method: "POST",
@@ -763,21 +870,6 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
-  getRules(id, options) {
-    return this.client.request({
-      method: "GET",
-      path: `/mailboxes/${encodeURIComponent(id)}/rules`,
-      methodOptions: options
-    });
-  }
-  updateRules(id, params, options) {
-    return this.client.request({
-      method: "PUT",
-      path: `/mailboxes/${encodeURIComponent(id)}/rules`,
-      body: params,
-      methodOptions: options
-    });
-  }
   listForwarding(id, options) {
     return this.client.request({
       method: "GET",
@@ -1168,6 +1260,44 @@ var ReplyScans = class extends ApiResource {
   }
 };
 
+// src/resources/scheduled-messages.ts
+var ScheduledMessages = class extends ApiResource {
+  list(params, options) {
+    return this.client.request({
+      method: "GET",
+      path: "/scheduled-messages",
+      query: {
+        include_held: params?.include_held,
+        search: params?.search,
+        limit: params?.limit
+      },
+      methodOptions: options
+    });
+  }
+  get(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/scheduled-messages/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+  update(id, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/scheduled-messages/${encodeURIComponent(id)}`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  cancel(id, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/scheduled-messages/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/status.ts
 var Status = class extends ApiResource {
   get(options) {
@@ -1351,7 +1481,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.2.3";
+var VERSION = "0.4.1";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1406,6 +1536,7 @@ var ShipMailClient = class {
     }
     this.audiences = new Audiences(this);
     this.bookingPages = new BookingPages(this);
+    this.capabilities = new Capabilities(this);
     this.calendar = new Calendar(this);
     this.domains = new Domains(this);
     this.mailboxes = new Mailboxes(this);
@@ -1413,6 +1544,7 @@ var ShipMailClient = class {
     this.newsletters = new Newsletters(this);
     this.partner = new Partner(this);
     this.replyScans = new ReplyScans(this);
+    this.scheduledMessages = new ScheduledMessages(this);
     this.suppressions = new Suppressions(this);
     this.threads = new Threads(this);
     this.webhooks = new Webhooks(this);
@@ -1524,7 +1656,6 @@ var WEBHOOK_EVENT_TYPES = [
   "message.bounced",
   "message.complained",
   "thread.needs_reply",
-  "mailbox.rule_matched",
   "domain.verified",
   "domain.verification_failed",
   "domain.degraded",
@@ -1552,7 +1683,7 @@ var MESSAGE_SOURCES = [
   "dashboard",
   "inbound",
   "smtp",
-  "agent"
+  "assistant"
 ];
 var WEBHOOK_DELIVERY_STATUSES = ["pending", "delivered", "failed"];
 
@@ -1604,6 +1735,6 @@ async function verifyWebhook(body, headers, secret, options) {
   return parsed;
 }
 
-export { AuthenticationError, AuthorizationError, CONFERENCING_PROVIDER_IDS, ConflictError, ConnectionError, DOMAIN_STATUSES, InternalServerError, MESSAGE_SOURCES, MESSAGE_STATUSES, NotFoundError, Page, QuotaExceededError, RateLimitError, ShipMailClient, ShipMailError, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, WebhookVerificationError, ShipMailClient as default, verifyWebhook };
+export { API_KEY_SCOPES, API_KEY_SCOPE_DESCRIPTIONS, AuthenticationError, AuthorizationError, CONFERENCING_PROVIDER_IDS, ConflictError, ConnectionError, DOMAIN_STATUSES, InternalServerError, MESSAGE_SOURCES, MESSAGE_STATUSES, NotFoundError, Page, QuotaExceededError, RateLimitError, ShipMailClient, ShipMailError, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, WebhookVerificationError, apiKeyScopesGrant, ShipMailClient as default, isApiKeyScope, verifyWebhook };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map