shipmail 0.1.31 → 0.1.32

package/dist/index.d.ts

@@ -31,6 +31,8 @@ type PaginatedResponse<T> = {
         readonly limit: number;
     };
 };
+type DataMode = "live" | "test";
+type SandboxOutcome = "delivered" | "bounced" | "complained";
 type ErrorType = "validation_error" | "authentication_error" | "authorization_error" | "quota_exceeded" | "not_found" | "rate_limit_error" | "conflict" | "internal_error";
 type ApiErrorBody = {
     readonly error: {
@@ -50,8 +52,10 @@ type EmailRecipient = {
     readonly name?: string | null | undefined;
 };
 type EmailRecipientInput = EmailRecipient | string;
-declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
+declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
 type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
+declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
+type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
 type StatusResponse = {
     readonly status: string;
     readonly version: string;
@@ -414,6 +418,26 @@ type DomainVerificationResult = {
     readonly dmarc_record_value: string | null;
     readonly dmarc_managed_externally: boolean;
 };
+type DomainDnsRecordKey = "mx" | "spf" | "mail_from_mx" | "mail_from_spf" | "dkim" | "dmarc";
+type DomainDnsRecordStatus = "verified" | "not_found" | "mismatch" | "pending";
+type DomainDnsRecord = {
+    readonly key: DomainDnsRecordKey;
+    readonly type: "MX" | "TXT";
+    readonly host: string;
+    readonly value: string | null;
+    readonly priority: number | null;
+    readonly ttl: number;
+    readonly status: DomainDnsRecordStatus;
+    readonly found_values: readonly string[];
+};
+type DomainDnsRecordSet = {
+    readonly object: "dns_record_set";
+    readonly domain_id: string;
+    readonly domain_name: string;
+    readonly all_verified: boolean;
+    readonly checked_at: string;
+    readonly records: readonly DomainDnsRecord[];
+};
 type DomainSearchResult = {
     readonly domain_name: string;
     readonly available: boolean;
@@ -456,6 +480,7 @@ declare class Domains extends ApiResource {
     list(params?: ListDomainsParams, options?: MethodOptions): Promise<PaginatedResponse<Domain>>;
     listAutoPaginating(params?: Omit<ListDomainsParams, "cursor">): Page<Domain>;
     get(id: string, options?: MethodOptions): Promise<Domain>;
+    getDnsRecords(id: string, options?: MethodOptions): Promise<DomainDnsRecordSet>;
     update(id: string, params: UpdateDomainParams, options?: MethodOptions): Promise<Domain>;
     delete(id: string, options?: MethodOptions): Promise<void>;
     verify(id: string, options?: MethodOptions): Promise<DomainVerificationResult>;
@@ -566,6 +591,7 @@ type AutoReply = {
     readonly from_date: string | null;
     readonly to_date: string | null;
 };
+type MailboxSuspensionReason = "billing" | "manual" | "security";
 type Mailbox = {
     readonly object: "mailbox";
     readonly id: string;
@@ -573,11 +599,32 @@ type Mailbox = {
     readonly address: string;
     readonly display_name: string | null;
     readonly suspended_at: string | null;
+    readonly suspension_reasons: readonly MailboxSuspensionReason[];
     readonly spam_filter_threshold: number;
     readonly auto_reply: AutoReply;
     readonly created_at: string;
     readonly updated_at: string;
 };
+type MailboxExportStatus = "pending" | "processing" | "completed" | "failed" | "expired";
+type MailboxExportErrorCode = "source_unavailable" | "snapshot_changed" | "export_failed";
+type MailboxExport = {
+    readonly object: "mailbox_export";
+    readonly id: string;
+    readonly mailbox_id: string;
+    readonly status: MailboxExportStatus;
+    readonly format: "zip";
+    readonly format_version: number;
+    readonly file_size: number | null;
+    readonly message_count: number | null;
+    readonly folder_count: number | null;
+    readonly error_code: MailboxExportErrorCode | null;
+    readonly download_url: string | null;
+    readonly download_url_expires_at: string | null;
+    readonly expires_at: string | null;
+    readonly created_at: string;
+    readonly started_at: string | null;
+    readonly completed_at: string | null;
+};
 type MailboxFolder = {
     readonly object: "mailbox_folder";
     readonly id: string;
@@ -741,9 +788,29 @@ type MailboxRules = {
     readonly rules: readonly MailboxRule[];
     readonly folders: readonly MailboxRuleFolder[];
 };
+type MailboxForwarding = {
+    readonly object: "mailbox_forwarding";
+    readonly id: string;
+    readonly mailbox_id: string;
+    readonly destination: string;
+    readonly status: "pending" | "active";
+    readonly verification_sent_at: string | null;
+    readonly verified_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type MailboxForwardingList = {
+    readonly object: "mailbox_forwarding_list";
+    readonly mailbox_id: string;
+    readonly data: readonly MailboxForwarding[];
+};
+type CreateMailboxForwardingParams = {
+    readonly destination: string;
+};
 type CreateMailboxParams = {
     readonly domain_id: string;
     readonly address: string;
+    readonly password: string;
     readonly display_name?: string | undefined;
 };
 type UpdateMailboxParams = {
@@ -798,42 +865,16 @@ type UpdateMailboxRulesParams = {
     readonly rules: readonly MailboxRule[];
 };
 
-declare class Mailboxes extends ApiResource {
-    create(params: CreateMailboxParams, options?: MethodOptions): Promise<Mailbox>;
-    list(params?: ListMailboxesParams, options?: MethodOptions): Promise<PaginatedResponse<Mailbox>>;
-    listAutoPaginating(params?: Omit<ListMailboxesParams, "cursor">): Page<Mailbox>;
-    get(id: string, options?: MethodOptions): Promise<Mailbox>;
-    update(id: string, params: UpdateMailboxParams, options?: MethodOptions): Promise<Mailbox>;
-    delete(id: string, options?: MethodOptions): Promise<void>;
-    listFolders(id: string, options?: MethodOptions): Promise<MailboxFolders>;
-    createFolder(id: string, params: CreateMailboxFolderParams, options?: MethodOptions): Promise<MailboxFolder>;
-    updateFolder(id: string, folderId: string, params: UpdateMailboxFolderParams, options?: MethodOptions): Promise<MailboxFolder>;
-    deleteFolder(id: string, folderId: string, options?: MethodOptions): Promise<void>;
-    listIdentities(id: string, options?: MethodOptions): Promise<MailboxIdentities>;
-    listInboxMessages(id: string, params?: ListInboxMessagesParams, options?: MethodOptions): Promise<InboxMessages>;
-    getInboxThread(id: string, threadId: string, options?: MethodOptions): Promise<InboxThread>;
-    updateInboxMessage(id: string, messageId: string, params: UpdateInboxMessageParams, options?: MethodOptions): Promise<InboxMessageAction>;
-    moveInboxMessage(id: string, messageId: string, params: MoveInboxMessageParams, options?: MethodOptions): Promise<InboxMessageAction>;
-    deleteInboxMessage(id: string, messageId: string, options?: MethodOptions): Promise<void>;
-    downloadInboxAttachment(id: string, params: DownloadInboxAttachmentParams, options?: MethodOptions): Promise<Uint8Array>;
-    resetPassword(id: string, params: ResetMailboxPasswordParams, options?: MethodOptions): Promise<Mailbox>;
-    getRules(id: string, options?: MethodOptions): Promise<MailboxRules>;
-    updateRules(id: string, params: UpdateMailboxRulesParams, options?: MethodOptions): Promise<MailboxRules>;
-    updateAutoReply(id: string, params: UpdateAutoReplyParams, options?: MethodOptions): Promise<Mailbox>;
-    updateSpamFilter(id: string, params: UpdateSpamFilterParams, options?: MethodOptions): Promise<Mailbox>;
-    createImport(id: string, params: CreateMailboxImportParams, options?: MethodOptions): Promise<MailboxImport>;
-    listImports(id: string, options?: MethodOptions): Promise<MailboxImports>;
-    getImport(id: string, importId: string, options?: MethodOptions): Promise<MailboxImport>;
-    cancelImport(id: string, importId: string, options?: MethodOptions): Promise<MailboxImport>;
-    undoImport(id: string, importId: string, options?: MethodOptions): Promise<MailboxImport>;
-    createImportUpload(id: string, params: CreateImportUploadParams, options?: MethodOptions): Promise<ImportUpload>;
-}
-
 type Message = {
     readonly object: "message";
     readonly id: string;
     readonly mailbox_id: string;
     readonly thread_id: string | null;
+    readonly source_rfc_message_id: string | null;
+    readonly delivered_rfc_message_id: string | null;
+    readonly client_reference: string | null;
+    readonly metadata: Readonly<Record<string, string | number | boolean | null>>;
+    readonly headers: readonly OutboundHeader[];
     readonly subject: string | null;
     readonly from_address: string | null;
     readonly to_addresses: readonly {
@@ -854,6 +895,7 @@ type Message = {
         readonly content_type: string;
     }[] | null;
     readonly source: MessageSource;
+    readonly mode: DataMode;
     readonly status: MessageStatus;
     readonly scheduled_at: string | null;
     readonly created_at: string;
@@ -864,6 +906,11 @@ type Attachment = {
     readonly content: string;
     readonly content_type?: string | undefined;
 };
+type OutboundHeader = {
+    readonly name: string;
+    readonly value: string;
+};
+type MessageMetadata = Readonly<Record<string, string | number | boolean | null>>;
 type SendMessageParams = {
     readonly mailbox_id?: string | undefined;
     readonly from?: string | undefined;
@@ -877,19 +924,85 @@ type SendMessageParams = {
     readonly in_reply_to?: string | undefined;
     readonly references?: readonly string[] | undefined;
     readonly attachments?: readonly Attachment[] | undefined;
+    readonly client_reference?: string | undefined;
+    readonly metadata?: MessageMetadata | undefined;
+    readonly source_rfc_message_id?: string | undefined;
+    readonly headers?: readonly OutboundHeader[] | undefined;
     readonly scheduled_at?: string | undefined;
+    readonly sandbox_outcome?: SandboxOutcome | undefined;
 };
-type ListMessagesParams = PaginationParams & {
+type ListMessagesParams = PaginationParams & ({
     readonly mailbox_id: string;
-};
+    readonly client_reference?: string | undefined;
+} | {
+    readonly mailbox_id?: string | undefined;
+    readonly client_reference: string;
+});
 type ReplyToMessageParams = {
     readonly html?: string | undefined;
     readonly text?: string | undefined;
     readonly to: readonly EmailRecipientInput[];
     readonly cc?: readonly EmailRecipientInput[] | undefined;
+    readonly client_reference?: string | undefined;
+    readonly metadata?: MessageMetadata | undefined;
+    readonly source_rfc_message_id?: string | undefined;
+    readonly headers?: readonly OutboundHeader[] | undefined;
     readonly scheduled_at?: string | undefined;
+    readonly sandbox_outcome?: SandboxOutcome | undefined;
+};
+type InjectSandboxInboundParams = {
+    readonly from: EmailRecipientInput;
+    readonly to?: readonly EmailRecipientInput[] | undefined;
+    readonly cc?: readonly EmailRecipientInput[] | undefined;
+    readonly subject: string;
+    readonly text?: string | undefined;
+    readonly html?: string | undefined;
+    readonly message_id?: string | undefined;
+    readonly in_reply_to?: string | undefined;
+    readonly references?: readonly string[] | undefined;
+    readonly received_at?: string | undefined;
+    readonly headers?: readonly OutboundHeader[] | undefined;
 };
 
+declare class Mailboxes extends ApiResource {
+    injectSandboxInbound(id: string, params: InjectSandboxInboundParams, options?: MethodOptions): Promise<Message>;
+    create(params: CreateMailboxParams, options?: MethodOptions): Promise<Mailbox>;
+    list(params?: ListMailboxesParams, options?: MethodOptions): Promise<PaginatedResponse<Mailbox>>;
+    listAutoPaginating(params?: Omit<ListMailboxesParams, "cursor">): Page<Mailbox>;
+    get(id: string, options?: MethodOptions): Promise<Mailbox>;
+    update(id: string, params: UpdateMailboxParams, options?: MethodOptions): Promise<Mailbox>;
+    delete(id: string, options?: MethodOptions): Promise<void>;
+    suspend(id: string, options?: MethodOptions): Promise<Mailbox>;
+    resume(id: string, options?: MethodOptions): Promise<Mailbox>;
+    createExport(id: string, options?: MethodOptions): Promise<MailboxExport>;
+    getExport(id: string, exportId: string, options?: MethodOptions): Promise<MailboxExport>;
+    listFolders(id: string, options?: MethodOptions): Promise<MailboxFolders>;
+    createFolder(id: string, params: CreateMailboxFolderParams, options?: MethodOptions): Promise<MailboxFolder>;
+    updateFolder(id: string, folderId: string, params: UpdateMailboxFolderParams, options?: MethodOptions): Promise<MailboxFolder>;
+    deleteFolder(id: string, folderId: string, options?: MethodOptions): Promise<void>;
+    listIdentities(id: string, options?: MethodOptions): Promise<MailboxIdentities>;
+    listInboxMessages(id: string, params?: ListInboxMessagesParams, options?: MethodOptions): Promise<InboxMessages>;
+    getInboxThread(id: string, threadId: string, options?: MethodOptions): Promise<InboxThread>;
+    updateInboxMessage(id: string, messageId: string, params: UpdateInboxMessageParams, options?: MethodOptions): Promise<InboxMessageAction>;
+    moveInboxMessage(id: string, messageId: string, params: MoveInboxMessageParams, options?: MethodOptions): Promise<InboxMessageAction>;
+    deleteInboxMessage(id: string, messageId: string, options?: MethodOptions): Promise<void>;
+    downloadInboxAttachment(id: string, params: DownloadInboxAttachmentParams, options?: MethodOptions): Promise<Uint8Array>;
+    resetPassword(id: string, params: ResetMailboxPasswordParams, options?: MethodOptions): Promise<Mailbox>;
+    getRules(id: string, options?: MethodOptions): Promise<MailboxRules>;
+    updateRules(id: string, params: UpdateMailboxRulesParams, options?: MethodOptions): Promise<MailboxRules>;
+    listForwarding(id: string, options?: MethodOptions): Promise<MailboxForwardingList>;
+    createForwarding(id: string, params: CreateMailboxForwardingParams, options?: MethodOptions): Promise<MailboxForwarding>;
+    deleteForwarding(id: string, forwardingId: string, options?: MethodOptions): Promise<void>;
+    updateAutoReply(id: string, params: UpdateAutoReplyParams, options?: MethodOptions): Promise<Mailbox>;
+    updateSpamFilter(id: string, params: UpdateSpamFilterParams, options?: MethodOptions): Promise<Mailbox>;
+    createImport(id: string, params: CreateMailboxImportParams, options?: MethodOptions): Promise<MailboxImport>;
+    listImports(id: string, options?: MethodOptions): Promise<MailboxImports>;
+    getImport(id: string, importId: string, options?: MethodOptions): Promise<MailboxImport>;
+    cancelImport(id: string, importId: string, options?: MethodOptions): Promise<MailboxImport>;
+    undoImport(id: string, importId: string, options?: MethodOptions): Promise<MailboxImport>;
+    createImportUpload(id: string, params: CreateImportUploadParams, options?: MethodOptions): Promise<ImportUpload>;
+}
+
 declare class Messages extends ApiResource {
     send(params: SendMessageParams, options?: MethodOptions): Promise<Message>;
     list(params: ListMessagesParams, options?: MethodOptions): Promise<PaginatedResponse<Message>>;
@@ -1272,6 +1385,7 @@ type ReplyToThreadParams = {
     readonly to?: readonly EmailRecipientInput[] | undefined;
     readonly cc?: readonly EmailRecipientInput[] | undefined;
     readonly scheduled_at?: string | undefined;
+    readonly sandbox_outcome?: SandboxOutcome | undefined;
 };
 
 declare class Threads extends ApiResource {
@@ -1317,7 +1431,8 @@ type WebhookDelivery = {
     readonly object: "webhook_delivery";
     readonly id: string;
     readonly event_id: string;
-    readonly event_type: string;
+    readonly event_type: WebhookDeliveryEventType;
+    readonly mode: DataMode;
     readonly status: WebhookDeliveryStatus;
     readonly attempts: number;
     readonly last_status_code: number | null;
@@ -1325,14 +1440,21 @@ type WebhookDelivery = {
     readonly created_at: string;
     readonly delivered_at: string | null;
 };
+type WebhookDeliveryDetail = WebhookDelivery & {
+    readonly payload: unknown;
+    readonly next_attempt_at: string | null;
+    readonly replayed_from_delivery_id: string | null;
+};
 type ListDeliveriesParams = PaginationParams & {
     readonly status?: string | undefined;
     readonly event_type?: string | undefined;
 };
 type WebhookEvent<T = unknown> = {
+    readonly version: "2026-07-12";
     readonly event_id: string;
     readonly event_type: WebhookEventType;
     readonly created_at: string;
+    readonly test: boolean;
     readonly data: T;
 };
 
@@ -1347,6 +1469,8 @@ declare class Webhooks extends ApiResource {
     test(id: string, options?: MethodOptions): Promise<TestWebhookResponse>;
     listDeliveries(id: string, params?: ListDeliveriesParams, options?: MethodOptions): Promise<PaginatedResponse<WebhookDelivery>>;
     listDeliveriesAutoPaginating(id: string, params?: Omit<ListDeliveriesParams, "cursor">): Page<WebhookDelivery>;
+    getDelivery(id: string, deliveryId: string, options?: MethodOptions): Promise<WebhookDeliveryDetail>;
+    replayDelivery(id: string, deliveryId: string, options?: MethodOptions): Promise<WebhookDeliveryDetail>;
 }
 
 type RequestOptions = {
@@ -1463,4 +1587,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, AuthenticationError, AuthorizationError, type BookingPage, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, ConflictError, ConnectionError, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, DOMAIN_STATUSES, type DeleteCalendarEventParams, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, 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, AuthenticationError, AuthorizationError, type BookingPage, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, ConflictError, ConnectionError, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, 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 EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, 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 MergeFields, type Message, type MessageMetadata, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, 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

@@ -442,6 +442,13 @@ var Domains = class extends ApiResource {
       methodOptions: options
     });
   }
+  getDnsRecords(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/domains/${encodeURIComponent(id)}/dns-records`,
+      methodOptions: options
+    });
+  }
   update(id, params, options) {
     return this.client.request({
       method: "PATCH",
@@ -484,6 +491,14 @@ var Domains = class extends ApiResource {
 
 // src/resources/mailboxes.ts
 var Mailboxes = class extends ApiResource {
+  injectSandboxInbound(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/sandbox/inbound`,
+      body: params,
+      methodOptions: options
+    });
+  }
   create(params, options) {
     return this.client.request({
       method: "POST",
@@ -532,6 +547,34 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
+  suspend(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/suspend`,
+      methodOptions: options
+    });
+  }
+  resume(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/resume`,
+      methodOptions: options
+    });
+  }
+  createExport(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/exports`,
+      methodOptions: options
+    });
+  }
+  getExport(id, exportId, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/mailboxes/${encodeURIComponent(id)}/exports/${encodeURIComponent(exportId)}`,
+      methodOptions: options
+    });
+  }
   listFolders(id, options) {
     return this.client.request({
       method: "GET",
@@ -649,6 +692,28 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
+  listForwarding(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/mailboxes/${encodeURIComponent(id)}/forwarding`,
+      methodOptions: options
+    });
+  }
+  createForwarding(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/mailboxes/${encodeURIComponent(id)}/forwarding`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  deleteForwarding(id, forwardingId, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/mailboxes/${encodeURIComponent(id)}/forwarding/${encodeURIComponent(forwardingId)}`,
+      methodOptions: options
+    });
+  }
   updateAutoReply(id, params, options) {
     return this.client.request({
       method: "PATCH",
@@ -727,6 +792,7 @@ var Messages = class extends ApiResource {
       path: "/messages",
       query: {
         mailbox_id: params.mailbox_id,
+        client_reference: params.client_reference,
         cursor: params.cursor,
         limit: params.limit
       },
@@ -736,6 +802,7 @@ var Messages = class extends ApiResource {
   listAutoPaginating(params) {
     return new Page(this.client, "/messages", {
       mailbox_id: params.mailbox_id,
+      client_reference: params.client_reference,
       limit: params.limit
     });
   }
@@ -1072,10 +1139,24 @@ var Webhooks = class extends ApiResource {
       }
     );
   }
+  getDelivery(id, deliveryId, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/webhooks/${encodeURIComponent(id)}/deliveries/${encodeURIComponent(deliveryId)}`,
+      methodOptions: options
+    });
+  }
+  replayDelivery(id, deliveryId, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/webhooks/${encodeURIComponent(id)}/deliveries/${encodeURIComponent(deliveryId)}/replay`,
+      methodOptions: options
+    });
+  }
 };
 
 // src/version.ts
-var VERSION = "0.1.31";
+var VERSION = "0.1.32";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1236,6 +1317,7 @@ var WEBHOOK_EVENT_TYPES = [
   "message.delivered",
   "message.bounced",
   "message.complained",
+  "mailbox.rule_matched",
   "domain.verified",
   "domain.verification_failed",
   "domain.degraded",
@@ -1244,6 +1326,7 @@ var WEBHOOK_EVENT_TYPES = [
   "org.sending_suspended",
   "org.reputation_recovered"
 ];
+var WEBHOOK_DELIVERY_EVENT_TYPES = ["webhook.test", ...WEBHOOK_EVENT_TYPES];
 var DOMAIN_STATUSES = ["pending", "verifying", "verified", "degraded", "failed"];
 var MESSAGE_STATUSES = [
   "scheduled",
@@ -1307,6 +1390,6 @@ async function verifyWebhook(body, headers, secret, options) {
   return parsed;
 }
 
-export { AuthenticationError, AuthorizationError, ConflictError, ConnectionError, DOMAIN_STATUSES, InternalServerError, MESSAGE_SOURCES, MESSAGE_STATUSES, NotFoundError, Page, QuotaExceededError, RateLimitError, ShipMailClient, ShipMailError, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, WebhookVerificationError, ShipMailClient as default, verifyWebhook };
+export { AuthenticationError, AuthorizationError, 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 };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map