shipmail 0.6.2 → 0.6.4

package/README.md

@@ -141,6 +141,7 @@ await shipmail.mailboxes.resume("mbx_...");
 await shipmail.mailboxes.resetPassword("mbx_...", { password: "NewPassword1" });
 const forwarding = await shipmail.mailboxes.createForwarding("mbx_...", {
   destination: "owner@example.net",
+  recipient: "support@example.com",
 });
 const forwardingList = await shipmail.mailboxes.listForwarding("mbx_...");
 await shipmail.mailboxes.deleteForwarding("mbx_...", forwarding.id);
@@ -358,12 +359,21 @@ const webhook = await shipmail.webhooks.create({
   url: "https://example.com/webhook",
   events: ["message.received", "message.sent"],
   description: "Incoming email handler",
+  // Optional. Sent as the Authorization header of every delivery. Never returned.
+  authorization: "Bearer your-endpoint-key",
+  // Optional. A whsec_ secret from the receiving service, such as a Grok automation.
+  // Deliveries then carry webhook-id, webhook-timestamp and webhook-signature. Never returned.
+  standard_webhooks_secret: "whsec_...",
 });
 // webhook.secret is returned only on creation. Store it now.
+// webhook.has_authorization is true when an authorization value is set.
+// webhook.has_standard_webhooks_secret is true when a signing secret is set.
 
 await shipmail.webhooks.list();
 await shipmail.webhooks.get("whk_...");
 await shipmail.webhooks.update("whk_...", { active: false });
+await shipmail.webhooks.update("whk_...", { authorization: null }); // remove the header
+await shipmail.webhooks.update("whk_...", { standard_webhooks_secret: null }); // stop signing
 await shipmail.webhooks.delete("whk_...");
 
 await shipmail.webhooks.rotateSecret("whk_...");
@@ -380,6 +390,7 @@ Supported event types:
 ```
 message.received
 message.sent
+message.delayed
 message.delivered
 message.bounced
 message.complained

package/dist/index.cjs

@@ -82,6 +82,12 @@ function apiKeyScopesGrant(grantedScopes, requiredScope) {
 }
 
 // src/errors.ts
+var ERROR_RECOVERY_REASONS = [
+  "owner_confirmation_required",
+  "subscription_required",
+  "trial_capacity",
+  "purchased_capacity"
+];
 var ShipmailError = class extends Error {
   constructor(message, options) {
     super(message);
@@ -90,6 +96,8 @@ var ShipmailError = class extends Error {
     this.type = options?.type;
     this.requestId = options?.requestId;
     this.retryable = options?.retryable ?? false;
+    this.reason = options?.reason;
+    this.actionUrl = options?.actionUrl;
   }
 };
 var AuthenticationError = class extends ShipmailError {
@@ -99,8 +107,14 @@ var AuthenticationError = class extends ShipmailError {
   }
 };
 var AuthorizationError = class extends ShipmailError {
-  constructor(message, requestId) {
-    super(message, { status: 403, type: "authorization_error", requestId, retryable: false });
+  constructor(message, requestId, recovery) {
+    super(message, {
+      status: 403,
+      type: "authorization_error",
+      requestId,
+      retryable: false,
+      ...recovery
+    });
     this.name = "AuthorizationError";
   }
 };
@@ -110,15 +124,23 @@ var ValidationError = class extends ShipmailError {
       status: 422,
       type: "validation_error",
       requestId: options?.requestId,
-      retryable: false
+      retryable: false,
+      reason: options?.reason,
+      actionUrl: options?.actionUrl
     });
     this.name = "ValidationError";
     this.details = options?.details;
   }
 };
 var QuotaExceededError = class extends ShipmailError {
-  constructor(message, requestId) {
-    super(message, { status: 403, type: "quota_exceeded", requestId, retryable: false });
+  constructor(message, requestId, recovery) {
+    super(message, {
+      status: 403,
+      type: "quota_exceeded",
+      requestId,
+      retryable: false,
+      ...recovery
+    });
     this.name = "QuotaExceededError";
   }
 };
@@ -179,15 +201,23 @@ var WebhookVerificationError = class extends ShipmailError {
 function mapErrorFromResponse(status, body, requestId) {
   const error = body.error;
   const rid = error.request_id;
+  const recovery = {
+    reason: typeof error.reason === "string" ? error.reason : void 0,
+    actionUrl: typeof error.action_url === "string" ? error.action_url : void 0
+  };
   switch (error.type) {
     case "authentication_error":
       return new AuthenticationError(error.message, rid);
     case "authorization_error":
-      return new AuthorizationError(error.message, rid);
+      return new AuthorizationError(error.message, rid, recovery);
     case "quota_exceeded":
-      return new QuotaExceededError(error.message, rid);
+      return new QuotaExceededError(error.message, rid, recovery);
     case "validation_error":
-      return new ValidationError(error.message, { requestId: rid, details: error.details });
+      return new ValidationError(error.message, {
+        requestId: rid,
+        details: error.details,
+        ...recovery
+      });
     case "not_found":
       return new NotFoundError(error.message, rid);
     case "rate_limit_error":
@@ -203,7 +233,8 @@ function mapErrorFromResponse(status, body, requestId) {
         status,
         type: error.type,
         requestId: rid,
-        retryable: status >= 500
+        retryable: status >= 500,
+        ...recovery
       });
   }
 }
@@ -1370,6 +1401,22 @@ var Newsletters = class extends ApiResource {
   }
 };
 
+// src/resources/organization.ts
+var Organization = class extends ApiResource {
+  /**
+   * Whether the credential's organization can create mailboxes now, with its plan, trial and
+   * mailbox capacity. Poll it after the owner pays: access appears once Shipmail has recorded the
+   * payment.
+   */
+  access(options) {
+    return this.client.request({
+      method: "GET",
+      path: "/organization/access",
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/reply-scans.ts
 var ReplyScans = class extends ApiResource {
   create(params, options) {
@@ -1618,7 +1665,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.6.2";
+var VERSION = "0.6.4";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1691,6 +1738,7 @@ var ShipmailClient = class {
     this.members = new Members(this);
     this.messages = new Messages(this);
     this.newsletters = new Newsletters(this);
+    this.organization = new Organization(this);
     this.replyScans = new ReplyScans(this);
     this.scheduledMessages = new ScheduledMessages(this);
     this.suppressions = new Suppressions(this);
@@ -1810,6 +1858,7 @@ var CONFERENCING_PROVIDER_IDS = ["zoom", "google_meet"];
 var WEBHOOK_EVENT_TYPES = [
   "message.received",
   "message.sent",
+  "message.delayed",
   "message.delivered",
   "message.bounced",
   "message.complained",
@@ -1909,6 +1958,7 @@ exports.CONFERENCING_PROVIDER_IDS = CONFERENCING_PROVIDER_IDS;
 exports.ConflictError = ConflictError;
 exports.ConnectionError = ConnectionError;
 exports.DOMAIN_STATUSES = DOMAIN_STATUSES;
+exports.ERROR_RECOVERY_REASONS = ERROR_RECOVERY_REASONS;
 exports.InternalServerError = InternalServerError;
 exports.MESSAGE_SOURCES = MESSAGE_SOURCES;
 exports.MESSAGE_STATUSES = MESSAGE_STATUSES;