shipmail 0.6.2 → 0.6.3

package/dist/index.d.cts

@@ -52,6 +52,14 @@ type ApiErrorBody = {
          * the interrupted send attempt left behind.
          */
         readonly message_id?: string | undefined;
+        /**
+         * Present only on a refusal an organization owner can lift in Shipmail. One of
+         * `owner_confirmation_required`, `subscription_required`, `trial_capacity` or
+         * `purchased_capacity`; later servers may add values.
+         */
+        readonly reason?: string | undefined;
+        /** Present with `reason`: the Shipmail page where the owner reviews and confirms. */
+        readonly action_url?: string | undefined;
     };
 };
 type EmailRecipient = {
@@ -1406,6 +1414,7 @@ type MailboxForwarding = {
     readonly mailbox_id: string;
     readonly destination: string;
     readonly sender: string | null;
+    readonly recipient: string | null;
     readonly status: "pending" | "active";
     readonly verification_sent_at: string | null;
     readonly verified_at: string | null;
@@ -1420,6 +1429,7 @@ type MailboxForwardingList = {
 type CreateMailboxForwardingParams = {
     readonly destination: string;
     readonly sender?: string | null | undefined;
+    readonly recipient?: string | null | undefined;
 };
 type CreateMailboxBaseParams = {
     readonly domain_id: string;
@@ -2051,6 +2061,38 @@ declare class Newsletters extends ApiResource {
     resume(id: string, options?: MethodOptions): Promise<Newsletter>;
 }
 
+type OrganizationAccess = {
+    readonly object: "organization_access";
+    readonly organization: {
+        readonly id: string;
+        readonly name: string;
+    };
+    readonly plan: "free" | "solo" | "pro" | "team" | "scale";
+    /** Mailboxes can be created now, by the same rule mailbox creation applies. */
+    readonly has_access: boolean;
+    readonly trial: {
+        readonly active: boolean;
+        readonly ends_at: string | null;
+        /** No subscription yet and the owner never had a trial. Checkout still confirms it. */
+        readonly eligible: boolean;
+    };
+    readonly mailboxes: {
+        readonly limit: number;
+        readonly used: number;
+    };
+    /** Newsletter sending is available. It is not during a trial. */
+    readonly newsletters_allowed: boolean;
+};
+
+declare class Organization 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?: MethodOptions): Promise<OrganizationAccess>;
+}
+
 type ReplyScanStatus = "completed";
 type ReplyScan = {
     readonly object: "reply_scan";
@@ -2285,6 +2327,7 @@ declare class ShipmailClient {
     readonly members: Members;
     readonly messages: Messages;
     readonly newsletters: Newsletters;
+    readonly organization: Organization;
     readonly replyScans: ReplyScans;
     readonly scheduledMessages: ScheduledMessages;
     readonly suppressions: Suppressions;
@@ -2302,23 +2345,39 @@ declare class ShipmailClient {
     private buildUrl;
 }
 
+/** The `reason` values this SDK knows. A newer server may send others; they pass through. */
+declare const ERROR_RECOVERY_REASONS: readonly ["owner_confirmation_required", "subscription_required", "trial_capacity", "purchased_capacity"];
+/** What an organization owner can do in Shipmail to lift a refusal. */
+type ErrorRecovery = {
+    readonly reason?: string | undefined;
+    readonly actionUrl?: string | undefined;
+};
 declare class ShipmailError extends Error {
     readonly status: number | undefined;
     readonly type: ErrorType | undefined;
     readonly requestId: string | undefined;
     readonly retryable: boolean;
+    /**
+     * Why an organization owner must act, when they can lift this refusal in Shipmail. The error's
+     * type and status stay what they were. See ERROR_RECOVERY_REASONS.
+     */
+    readonly reason: string | undefined;
+    /** The Shipmail page to send the owner to. Retry with a new idempotency key afterwards. */
+    readonly actionUrl: string | undefined;
     constructor(message: string, options?: {
         readonly status?: number | undefined;
         readonly type?: ErrorType | undefined;
         readonly requestId?: string | undefined;
         readonly retryable?: boolean | undefined;
+        readonly reason?: string | undefined;
+        readonly actionUrl?: string | undefined;
     });
 }
 declare class AuthenticationError extends ShipmailError {
     constructor(message: string, requestId?: string);
 }
 declare class AuthorizationError extends ShipmailError {
-    constructor(message: string, requestId?: string);
+    constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
 }
 declare class ValidationError extends ShipmailError {
     readonly details: readonly {
@@ -2333,10 +2392,12 @@ declare class ValidationError extends ShipmailError {
             readonly message: string;
             readonly code?: string | undefined;
         }[] | undefined;
+        readonly reason?: string | undefined;
+        readonly actionUrl?: string | undefined;
     });
 }
 declare class QuotaExceededError extends ShipmailError {
-    constructor(message: string, requestId?: string);
+    constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
 }
 declare class NotFoundError extends ShipmailError {
     constructor(message: string, requestId?: string);
@@ -2386,4 +2447,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
     readonly toleranceInSeconds?: number | undefined;
 }): Promise<WebhookEvent>;
 
-export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventMutationResult, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CalendarInvitationOutcome, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberMailboxAccess, type MemberMailboxAccessScope, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };
+export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventMutationResult, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CalendarInvitationOutcome, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxForwardingParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, ERROR_RECOVERY_REASONS, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorRecovery, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxForwarding, type MailboxForwardingList, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberMailboxAccess, type MemberMailboxAccessScope, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OrganizationAccess, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };

package/dist/index.d.ts

@@ -52,6 +52,14 @@ type ApiErrorBody = {
          * the interrupted send attempt left behind.
          */
         readonly message_id?: string | undefined;
+        /**
+         * Present only on a refusal an organization owner can lift in Shipmail. One of
+         * `owner_confirmation_required`, `subscription_required`, `trial_capacity` or
+         * `purchased_capacity`; later servers may add values.
+         */
+        readonly reason?: string | undefined;
+        /** Present with `reason`: the Shipmail page where the owner reviews and confirms. */
+        readonly action_url?: string | undefined;
     };
 };
 type EmailRecipient = {
@@ -1406,6 +1414,7 @@ type MailboxForwarding = {
     readonly mailbox_id: string;
     readonly destination: string;
     readonly sender: string | null;
+    readonly recipient: string | null;
     readonly status: "pending" | "active";
     readonly verification_sent_at: string | null;
     readonly verified_at: string | null;
@@ -1420,6 +1429,7 @@ type MailboxForwardingList = {
 type CreateMailboxForwardingParams = {
     readonly destination: string;
     readonly sender?: string | null | undefined;
+    readonly recipient?: string | null | undefined;
 };
 type CreateMailboxBaseParams = {
     readonly domain_id: string;
@@ -2051,6 +2061,38 @@ declare class Newsletters extends ApiResource {
     resume(id: string, options?: MethodOptions): Promise<Newsletter>;
 }
 
+type OrganizationAccess = {
+    readonly object: "organization_access";
+    readonly organization: {
+        readonly id: string;
+        readonly name: string;
+    };
+    readonly plan: "free" | "solo" | "pro" | "team" | "scale";
+    /** Mailboxes can be created now, by the same rule mailbox creation applies. */
+    readonly has_access: boolean;
+    readonly trial: {
+        readonly active: boolean;
+        readonly ends_at: string | null;
+        /** No subscription yet and the owner never had a trial. Checkout still confirms it. */
+        readonly eligible: boolean;
+    };
+    readonly mailboxes: {
+        readonly limit: number;
+        readonly used: number;
+    };
+    /** Newsletter sending is available. It is not during a trial. */
+    readonly newsletters_allowed: boolean;
+};
+
+declare class Organization 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?: MethodOptions): Promise<OrganizationAccess>;
+}
+
 type ReplyScanStatus = "completed";
 type ReplyScan = {
     readonly object: "reply_scan";
@@ -2285,6 +2327,7 @@ declare class ShipmailClient {
     readonly members: Members;
     readonly messages: Messages;
     readonly newsletters: Newsletters;
+    readonly organization: Organization;
     readonly replyScans: ReplyScans;
     readonly scheduledMessages: ScheduledMessages;
     readonly suppressions: Suppressions;
@@ -2302,23 +2345,39 @@ declare class ShipmailClient {
     private buildUrl;
 }
 
+/** The `reason` values this SDK knows. A newer server may send others; they pass through. */
+declare const ERROR_RECOVERY_REASONS: readonly ["owner_confirmation_required", "subscription_required", "trial_capacity", "purchased_capacity"];
+/** What an organization owner can do in Shipmail to lift a refusal. */
+type ErrorRecovery = {
+    readonly reason?: string | undefined;
+    readonly actionUrl?: string | undefined;
+};
 declare class ShipmailError extends Error {
     readonly status: number | undefined;
     readonly type: ErrorType | undefined;
     readonly requestId: string | undefined;
     readonly retryable: boolean;
+    /**
+     * Why an organization owner must act, when they can lift this refusal in Shipmail. The error's
+     * type and status stay what they were. See ERROR_RECOVERY_REASONS.
+     */
+    readonly reason: string | undefined;
+    /** The Shipmail page to send the owner to. Retry with a new idempotency key afterwards. */
+    readonly actionUrl: string | undefined;
     constructor(message: string, options?: {
         readonly status?: number | undefined;
         readonly type?: ErrorType | undefined;
         readonly requestId?: string | undefined;
         readonly retryable?: boolean | undefined;
+        readonly reason?: string | undefined;
+        readonly actionUrl?: string | undefined;
     });
 }
 declare class AuthenticationError extends ShipmailError {
     constructor(message: string, requestId?: string);
 }
 declare class AuthorizationError extends ShipmailError {
-    constructor(message: string, requestId?: string);
+    constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
 }
 declare class ValidationError extends ShipmailError {
     readonly details: readonly {
@@ -2333,10 +2392,12 @@ declare class ValidationError extends ShipmailError {
             readonly message: string;
             readonly code?: string | undefined;
         }[] | undefined;
+        readonly reason?: string | undefined;
+        readonly actionUrl?: string | undefined;
     });
 }
 declare class QuotaExceededError extends ShipmailError {
-    constructor(message: string, requestId?: string);
+    constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
 }
 declare class NotFoundError extends ShipmailError {
     constructor(message: string, requestId?: string);
@@ -2386,4 +2447,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
     readonly toleranceInSeconds?: number | undefined;
 }): Promise<WebhookEvent>;
 
-export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventMutationResult, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CalendarInvitationOutcome, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberMailboxAccess, type MemberMailboxAccessScope, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };
+export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventMutationResult, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CalendarInvitationOutcome, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxForwardingParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, ERROR_RECOVERY_REASONS, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorRecovery, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxForwarding, type MailboxForwardingList, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberMailboxAccess, type MemberMailboxAccessScope, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OrganizationAccess, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };

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.2";
+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