shipmail 0.6.1 → 0.6.3

package/dist/index.js

@@ -78,6 +78,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);
@@ -86,6 +92,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 {
@@ -95,8 +103,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";
   }
 };
@@ -106,15 +120,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";
   }
 };
@@ -175,15 +197,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":
@@ -199,7 +229,8 @@ function mapErrorFromResponse(status, body, requestId) {
         status,
         type: error.type,
         requestId: rid,
-        retryable: status >= 500
+        retryable: status >= 500,
+        ...recovery
       });
   }
 }
@@ -1366,6 +1397,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) {
@@ -1614,7 +1661,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.6.1";
+var VERSION = "0.6.3";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1687,6 +1734,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);
@@ -1897,6 +1945,6 @@ async function verifyWebhook(body, headers, secret, options) {
   return parsed;
 }
 
-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, ReconciliationRequiredError, ShipmailClient, ShipmailError, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, WebhookVerificationError, apiKeyScopesGrant, ShipmailClient as default, isApiKeyScope, verifyWebhook };
+export { API_KEY_SCOPES, API_KEY_SCOPE_DESCRIPTIONS, AuthenticationError, AuthorizationError, CONFERENCING_PROVIDER_IDS, ConflictError, ConnectionError, DOMAIN_STATUSES, ERROR_RECOVERY_REASONS, InternalServerError, MESSAGE_SOURCES, MESSAGE_STATUSES, NotFoundError, Page, QuotaExceededError, RateLimitError, ReconciliationRequiredError, 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