shipmail 0.2.3 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/README.md +62 -3
  2. package/dist/api-key-scopes.cjs +86 -0
  3. package/dist/api-key-scopes.cjs.map +1 -0
  4. package/dist/api-key-scopes.d.cts +7 -0
  5. package/dist/api-key-scopes.d.ts +7 -0
  6. package/dist/api-key-scopes.js +81 -0
  7. package/dist/api-key-scopes.js.map +1 -0
  8. package/dist/index.cjs +153 -18
  9. package/dist/index.cjs.map +1 -1
  10. package/dist/index.d.cts +140 -66
  11. package/dist/index.d.ts +140 -66
  12. package/dist/index.js +150 -19
  13. package/dist/index.js.map +1 -1
  14. package/package.json +19 -1
package/dist/index.d.cts CHANGED
@@ -1,3 +1,5 @@
1
+ export { API_KEY_SCOPES, API_KEY_SCOPE_DESCRIPTIONS, ApiKeyScope, apiKeyScopesGrant, isApiKeyScope } from './api-key-scopes.cjs';
2
+
1
3
  declare class Page<T> implements AsyncIterable<T> {
2
4
  private readonly client;
3
5
  private readonly path;
@@ -53,9 +55,9 @@ type EmailRecipient = {
53
55
  readonly name?: string | null | undefined;
54
56
  };
55
57
  type EmailRecipientInput = EmailRecipient | string;
56
- declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
58
+ declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
57
59
  type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
58
- declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
60
+ declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
59
61
  type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
60
62
  type StatusResponse = {
61
63
  readonly status: string;
@@ -67,7 +69,7 @@ declare const DOMAIN_STATUSES: readonly ["pending", "verifying", "verified", "de
67
69
  type DomainStatus = (typeof DOMAIN_STATUSES)[number];
68
70
  declare const MESSAGE_STATUSES: readonly ["scheduled", "queued", "sent", "delivered", "bounced", "complained", "failed", "suppressed", "cancelled"];
69
71
  type MessageStatus = (typeof MESSAGE_STATUSES)[number];
70
- declare const MESSAGE_SOURCES: readonly ["api", "newsletter", "dashboard", "inbound", "smtp", "agent"];
72
+ declare const MESSAGE_SOURCES: readonly ["api", "newsletter", "dashboard", "inbound", "smtp", "assistant"];
71
73
  type MessageSource = (typeof MESSAGE_SOURCES)[number];
72
74
  declare const WEBHOOK_DELIVERY_STATUSES: readonly ["pending", "delivered", "failed"];
73
75
  type WebhookDeliveryStatus = (typeof WEBHOOK_DELIVERY_STATUSES)[number];
@@ -382,6 +384,33 @@ declare class Calendar extends ApiResource {
382
384
  availability(params: CalendarAvailabilityParams, options?: MethodOptions): Promise<CalendarAvailability>;
383
385
  }
384
386
 
387
+ type CapabilityResourceConstraints = {
388
+ readonly mailbox_ids: readonly string[] | null;
389
+ readonly domain_ids: readonly string[] | null;
390
+ readonly audience_ids: readonly string[] | null;
391
+ readonly allowed_recipient_addresses: readonly string[] | null;
392
+ readonly allowed_recipient_domains: readonly string[] | null;
393
+ };
394
+ type TransactionalRecipientBudget = {
395
+ readonly unlimited: boolean;
396
+ readonly limit: number | null;
397
+ readonly used: number;
398
+ readonly remaining: number | null;
399
+ readonly window_hours: 24;
400
+ };
401
+ type CapabilitiesResponse = {
402
+ readonly capability_version: string;
403
+ readonly scopes: readonly string[];
404
+ readonly constraints: CapabilityResourceConstraints;
405
+ readonly allowed_mcp_tools: readonly string[];
406
+ readonly transactional_recipient_budget: TransactionalRecipientBudget;
407
+ readonly undo_hold_seconds: number;
408
+ };
409
+
410
+ declare class Capabilities extends ApiResource {
411
+ get(options?: MethodOptions): Promise<CapabilitiesResponse>;
412
+ }
413
+
385
414
  type Domain = {
386
415
  readonly object: "domain";
387
416
  readonly id: string;
@@ -633,6 +662,37 @@ type Attachment = {
633
662
  readonly content: string;
634
663
  readonly content_type?: string | undefined;
635
664
  };
665
+ type StagedAttachment = {
666
+ readonly object: "staged_attachment";
667
+ readonly id: string;
668
+ readonly mailbox_id: string;
669
+ readonly filename: string;
670
+ readonly content_type: string;
671
+ readonly size: number;
672
+ readonly sha256: string;
673
+ readonly expires_at: string;
674
+ };
675
+ type StageAttachmentParams = {
676
+ readonly filename: string;
677
+ readonly data: ArrayBuffer | Uint8Array;
678
+ readonly content_type?: string | undefined;
679
+ };
680
+ type PrepareStagedAttachmentUploadParams = {
681
+ readonly filename: string;
682
+ readonly content_type: string;
683
+ readonly size: number;
684
+ readonly sha256: string;
685
+ };
686
+ type StagedAttachmentUpload = {
687
+ readonly object: "staged_attachment_upload";
688
+ readonly mailbox_id: string;
689
+ readonly filename: string;
690
+ readonly content_type: string;
691
+ readonly size: number;
692
+ readonly sha256: string;
693
+ readonly upload_url: string;
694
+ readonly expires_at: string;
695
+ };
636
696
  type OutboundHeader = {
637
697
  readonly name: string;
638
698
  readonly value: string;
@@ -651,6 +711,7 @@ type SendMessageParams = {
651
711
  readonly in_reply_to?: string | undefined;
652
712
  readonly references?: readonly string[] | undefined;
653
713
  readonly attachments?: readonly Attachment[] | undefined;
714
+ readonly staged_attachment_ids?: readonly string[] | undefined;
654
715
  readonly client_reference?: string | undefined;
655
716
  readonly metadata?: MessageMetadata | undefined;
656
717
  readonly source_rfc_message_id?: string | undefined;
@@ -658,6 +719,70 @@ type SendMessageParams = {
658
719
  readonly scheduled_at?: string | undefined;
659
720
  readonly sandbox_outcome?: SandboxOutcome | undefined;
660
721
  };
722
+ type ScheduledMessageRecipient = {
723
+ readonly address: string;
724
+ readonly name?: string | null;
725
+ };
726
+ type ScheduledMessageAttachment = {
727
+ readonly filename: string;
728
+ readonly size: number;
729
+ readonly content_type: string;
730
+ };
731
+ type ScheduledMessageUploadedAttachment = {
732
+ readonly blob_id: string;
733
+ readonly filename: string;
734
+ readonly content_type: string;
735
+ readonly size: number;
736
+ };
737
+ type ScheduledMessage = {
738
+ readonly object: "scheduled_message";
739
+ readonly id: string;
740
+ readonly scheduled_message_id: string;
741
+ readonly kind: "scheduled" | "undo";
742
+ readonly mailbox_id: string;
743
+ readonly mailbox_address: string;
744
+ readonly from_address: string;
745
+ readonly identity_id: string;
746
+ readonly mode: DataMode;
747
+ readonly subject: string;
748
+ readonly to: readonly ScheduledMessageRecipient[];
749
+ readonly cc: readonly ScheduledMessageRecipient[];
750
+ readonly bcc: readonly ScheduledMessageRecipient[];
751
+ readonly attachments: readonly ScheduledMessageAttachment[];
752
+ readonly scheduled_at: string;
753
+ readonly created_at: string;
754
+ readonly updated_at: string;
755
+ readonly last_error: string | null;
756
+ readonly draft_email_id?: string | undefined;
757
+ readonly from_name?: string | undefined;
758
+ readonly text?: string | undefined;
759
+ readonly html?: string | undefined;
760
+ readonly in_reply_to?: string | null | undefined;
761
+ readonly references?: readonly string[] | undefined;
762
+ readonly uploaded_attachments?: readonly ScheduledMessageUploadedAttachment[] | undefined;
763
+ };
764
+ type ScheduledMessageList = {
765
+ readonly object: "scheduled_message_list";
766
+ readonly data: readonly ScheduledMessage[];
767
+ readonly total: number;
768
+ };
769
+ type ListScheduledMessagesParams = {
770
+ readonly include_held?: boolean | undefined;
771
+ readonly search?: string | undefined;
772
+ readonly limit?: number | undefined;
773
+ };
774
+ type UpdateScheduledMessageParams = {
775
+ readonly to: readonly EmailRecipientInput[];
776
+ readonly cc?: readonly EmailRecipientInput[] | undefined;
777
+ readonly bcc?: readonly EmailRecipientInput[] | undefined;
778
+ readonly subject: string;
779
+ readonly html?: string | undefined;
780
+ readonly text?: string | undefined;
781
+ readonly in_reply_to?: string | undefined;
782
+ readonly references?: readonly string[] | undefined;
783
+ readonly staged_attachment_ids?: readonly string[] | undefined;
784
+ readonly scheduled_at: string;
785
+ };
661
786
  type ListMessagesParams = PaginationParams & ({
662
787
  readonly mailbox_id: string;
663
788
  readonly client_reference?: string | undefined;
@@ -931,63 +1056,6 @@ type InboxMessageAction = {
931
1056
  readonly message_id: string;
932
1057
  readonly ok: true;
933
1058
  };
934
- type MailboxRuleMatchMode = "all" | "any";
935
- type MailboxRuleCondition = {
936
- readonly type: "from_is" | "from_contains" | "recipient_is" | "plus_tag_is" | "subject_contains";
937
- readonly value: string;
938
- } | {
939
- readonly type: "has_attachment" | "list_unsubscribe_exists";
940
- } | {
941
- readonly type: "group";
942
- readonly match_mode: MailboxRuleMatchMode;
943
- readonly conditions: readonly MailboxRuleCondition[];
944
- };
945
- type MailboxRuleMoveTarget = {
946
- readonly kind: "system";
947
- readonly role: "inbox" | "archive" | "junk" | "trash";
948
- } | {
949
- readonly kind: "custom";
950
- readonly folder_id: string;
951
- };
952
- type MailboxRuleAction = {
953
- readonly type: "move";
954
- readonly target: MailboxRuleMoveTarget;
955
- } | {
956
- readonly type: "mark_read";
957
- } | {
958
- readonly type: "star";
959
- } | {
960
- readonly type: "send_webhook";
961
- } | {
962
- readonly type: "ai_draft_reply";
963
- readonly instructions: string;
964
- readonly reply_mode: "reply" | "reply_all";
965
- readonly agent_policy: "observe_only" | "draft_for_review";
966
- };
967
- type MailboxRule = {
968
- readonly id: string;
969
- readonly name: string;
970
- readonly enabled: boolean;
971
- readonly position: number;
972
- readonly match_mode: MailboxRuleMatchMode;
973
- readonly stop: boolean;
974
- readonly conditions: readonly MailboxRuleCondition[];
975
- readonly actions: readonly MailboxRuleAction[];
976
- };
977
- type MailboxRuleFolder = {
978
- readonly id: string;
979
- readonly name: string;
980
- readonly parent_id: string | null;
981
- readonly role: string | null;
982
- readonly kind: "custom" | "system";
983
- };
984
- type MailboxRules = {
985
- readonly object: "mailbox_rules";
986
- readonly mailbox_id: string;
987
- readonly address: string;
988
- readonly rules: readonly MailboxRule[];
989
- readonly folders: readonly MailboxRuleFolder[];
990
- };
991
1059
  type MailboxForwarding = {
992
1060
  readonly object: "mailbox_forwarding";
993
1061
  readonly id: string;
@@ -1088,11 +1156,10 @@ type UpdateAutoReplyParams = {
1088
1156
  type UpdateSpamFilterParams = {
1089
1157
  readonly threshold: number;
1090
1158
  };
1091
- type UpdateMailboxRulesParams = {
1092
- readonly rules: readonly MailboxRule[];
1093
- };
1094
1159
 
1095
1160
  declare class Mailboxes extends ApiResource {
1161
+ prepareStagedAttachmentUpload(id: string, params: PrepareStagedAttachmentUploadParams, options?: OneTimeSecretMethodOptions): Promise<StagedAttachmentUpload>;
1162
+ stageAttachment(id: string, params: StageAttachmentParams, options?: MethodOptions): Promise<StagedAttachment>;
1096
1163
  injectSandboxInbound(id: string, params: InjectSandboxInboundParams, options?: MethodOptions): Promise<Message>;
1097
1164
  create(params: CreateMailboxParams, options?: MethodOptions): Promise<Mailbox>;
1098
1165
  list(params?: ListMailboxesParams, options?: MethodOptions): Promise<PaginatedResponse<Mailbox>>;
@@ -1126,8 +1193,6 @@ declare class Mailboxes extends ApiResource {
1126
1193
  listAppPasswords(id: string, options?: MethodOptions): Promise<MailboxAppPasswordList>;
1127
1194
  createAppPassword(id: string, params: CreateMailboxAppPasswordParams, options?: OneTimeSecretMethodOptions): Promise<CreatedMailboxAppPassword>;
1128
1195
  revokeAppPassword(id: string, appPasswordId: string, options?: MethodOptions): Promise<void>;
1129
- getRules(id: string, options?: MethodOptions): Promise<MailboxRules>;
1130
- updateRules(id: string, params: UpdateMailboxRulesParams, options?: MethodOptions): Promise<MailboxRules>;
1131
1196
  listForwarding(id: string, options?: MethodOptions): Promise<MailboxForwardingList>;
1132
1197
  createForwarding(id: string, params: CreateMailboxForwardingParams, options?: MethodOptions): Promise<MailboxForwarding>;
1133
1198
  deleteForwarding(id: string, forwardingId: string, options?: MethodOptions): Promise<void>;
@@ -1636,6 +1701,13 @@ declare class ReplyScans extends ApiResource {
1636
1701
  listResults(id: string, params?: ListReplyScanResultsParams, options?: MethodOptions): Promise<ReplyScanResults>;
1637
1702
  }
1638
1703
 
1704
+ declare class ScheduledMessages extends ApiResource {
1705
+ list(params?: ListScheduledMessagesParams, options?: MethodOptions): Promise<ScheduledMessageList>;
1706
+ get(id: string, options?: MethodOptions): Promise<ScheduledMessage>;
1707
+ update(id: string, params: UpdateScheduledMessageParams, options?: MethodOptions): Promise<ScheduledMessage>;
1708
+ cancel(id: string, options?: MethodOptions): Promise<void>;
1709
+ }
1710
+
1639
1711
  declare class Status extends ApiResource {
1640
1712
  get(options?: MethodOptions): Promise<StatusResponse>;
1641
1713
  }
@@ -1790,6 +1862,7 @@ declare class ShipMailClient {
1790
1862
  private readonly organizationId;
1791
1863
  readonly audiences: Audiences;
1792
1864
  readonly bookingPages: BookingPages;
1865
+ readonly capabilities: Capabilities;
1793
1866
  readonly calendar: Calendar;
1794
1867
  readonly domains: Domains;
1795
1868
  readonly mailboxes: Mailboxes;
@@ -1797,6 +1870,7 @@ declare class ShipMailClient {
1797
1870
  readonly newsletters: Newsletters;
1798
1871
  readonly partner: Partner;
1799
1872
  readonly replyScans: ReplyScans;
1873
+ readonly scheduledMessages: ScheduledMessages;
1800
1874
  readonly suppressions: Suppressions;
1801
1875
  readonly threads: Threads;
1802
1876
  readonly webhooks: Webhooks;
@@ -1885,4 +1959,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
1885
1959
  readonly toleranceInSeconds?: number | undefined;
1886
1960
  }): Promise<WebhookEvent>;
1887
1961
 
1888
- export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, 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 OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, QuotaExceededError, RateLimitError, 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 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 UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, 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 };
1962
+ export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, 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 MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, 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 OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, 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 TransactionalRecipientBudget, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, type UpdateScheduledMessageParams, 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.d.ts CHANGED
@@ -1,3 +1,5 @@
1
+ export { API_KEY_SCOPES, API_KEY_SCOPE_DESCRIPTIONS, ApiKeyScope, apiKeyScopesGrant, isApiKeyScope } from './api-key-scopes.js';
2
+
1
3
  declare class Page<T> implements AsyncIterable<T> {
2
4
  private readonly client;
3
5
  private readonly path;
@@ -53,9 +55,9 @@ type EmailRecipient = {
53
55
  readonly name?: string | null | undefined;
54
56
  };
55
57
  type EmailRecipientInput = EmailRecipient | string;
56
- declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
58
+ declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
57
59
  type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
58
- declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
60
+ declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "thread.needs_reply", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
59
61
  type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
60
62
  type StatusResponse = {
61
63
  readonly status: string;
@@ -67,7 +69,7 @@ declare const DOMAIN_STATUSES: readonly ["pending", "verifying", "verified", "de
67
69
  type DomainStatus = (typeof DOMAIN_STATUSES)[number];
68
70
  declare const MESSAGE_STATUSES: readonly ["scheduled", "queued", "sent", "delivered", "bounced", "complained", "failed", "suppressed", "cancelled"];
69
71
  type MessageStatus = (typeof MESSAGE_STATUSES)[number];
70
- declare const MESSAGE_SOURCES: readonly ["api", "newsletter", "dashboard", "inbound", "smtp", "agent"];
72
+ declare const MESSAGE_SOURCES: readonly ["api", "newsletter", "dashboard", "inbound", "smtp", "assistant"];
71
73
  type MessageSource = (typeof MESSAGE_SOURCES)[number];
72
74
  declare const WEBHOOK_DELIVERY_STATUSES: readonly ["pending", "delivered", "failed"];
73
75
  type WebhookDeliveryStatus = (typeof WEBHOOK_DELIVERY_STATUSES)[number];
@@ -382,6 +384,33 @@ declare class Calendar extends ApiResource {
382
384
  availability(params: CalendarAvailabilityParams, options?: MethodOptions): Promise<CalendarAvailability>;
383
385
  }
384
386
 
387
+ type CapabilityResourceConstraints = {
388
+ readonly mailbox_ids: readonly string[] | null;
389
+ readonly domain_ids: readonly string[] | null;
390
+ readonly audience_ids: readonly string[] | null;
391
+ readonly allowed_recipient_addresses: readonly string[] | null;
392
+ readonly allowed_recipient_domains: readonly string[] | null;
393
+ };
394
+ type TransactionalRecipientBudget = {
395
+ readonly unlimited: boolean;
396
+ readonly limit: number | null;
397
+ readonly used: number;
398
+ readonly remaining: number | null;
399
+ readonly window_hours: 24;
400
+ };
401
+ type CapabilitiesResponse = {
402
+ readonly capability_version: string;
403
+ readonly scopes: readonly string[];
404
+ readonly constraints: CapabilityResourceConstraints;
405
+ readonly allowed_mcp_tools: readonly string[];
406
+ readonly transactional_recipient_budget: TransactionalRecipientBudget;
407
+ readonly undo_hold_seconds: number;
408
+ };
409
+
410
+ declare class Capabilities extends ApiResource {
411
+ get(options?: MethodOptions): Promise<CapabilitiesResponse>;
412
+ }
413
+
385
414
  type Domain = {
386
415
  readonly object: "domain";
387
416
  readonly id: string;
@@ -633,6 +662,37 @@ type Attachment = {
633
662
  readonly content: string;
634
663
  readonly content_type?: string | undefined;
635
664
  };
665
+ type StagedAttachment = {
666
+ readonly object: "staged_attachment";
667
+ readonly id: string;
668
+ readonly mailbox_id: string;
669
+ readonly filename: string;
670
+ readonly content_type: string;
671
+ readonly size: number;
672
+ readonly sha256: string;
673
+ readonly expires_at: string;
674
+ };
675
+ type StageAttachmentParams = {
676
+ readonly filename: string;
677
+ readonly data: ArrayBuffer | Uint8Array;
678
+ readonly content_type?: string | undefined;
679
+ };
680
+ type PrepareStagedAttachmentUploadParams = {
681
+ readonly filename: string;
682
+ readonly content_type: string;
683
+ readonly size: number;
684
+ readonly sha256: string;
685
+ };
686
+ type StagedAttachmentUpload = {
687
+ readonly object: "staged_attachment_upload";
688
+ readonly mailbox_id: string;
689
+ readonly filename: string;
690
+ readonly content_type: string;
691
+ readonly size: number;
692
+ readonly sha256: string;
693
+ readonly upload_url: string;
694
+ readonly expires_at: string;
695
+ };
636
696
  type OutboundHeader = {
637
697
  readonly name: string;
638
698
  readonly value: string;
@@ -651,6 +711,7 @@ type SendMessageParams = {
651
711
  readonly in_reply_to?: string | undefined;
652
712
  readonly references?: readonly string[] | undefined;
653
713
  readonly attachments?: readonly Attachment[] | undefined;
714
+ readonly staged_attachment_ids?: readonly string[] | undefined;
654
715
  readonly client_reference?: string | undefined;
655
716
  readonly metadata?: MessageMetadata | undefined;
656
717
  readonly source_rfc_message_id?: string | undefined;
@@ -658,6 +719,70 @@ type SendMessageParams = {
658
719
  readonly scheduled_at?: string | undefined;
659
720
  readonly sandbox_outcome?: SandboxOutcome | undefined;
660
721
  };
722
+ type ScheduledMessageRecipient = {
723
+ readonly address: string;
724
+ readonly name?: string | null;
725
+ };
726
+ type ScheduledMessageAttachment = {
727
+ readonly filename: string;
728
+ readonly size: number;
729
+ readonly content_type: string;
730
+ };
731
+ type ScheduledMessageUploadedAttachment = {
732
+ readonly blob_id: string;
733
+ readonly filename: string;
734
+ readonly content_type: string;
735
+ readonly size: number;
736
+ };
737
+ type ScheduledMessage = {
738
+ readonly object: "scheduled_message";
739
+ readonly id: string;
740
+ readonly scheduled_message_id: string;
741
+ readonly kind: "scheduled" | "undo";
742
+ readonly mailbox_id: string;
743
+ readonly mailbox_address: string;
744
+ readonly from_address: string;
745
+ readonly identity_id: string;
746
+ readonly mode: DataMode;
747
+ readonly subject: string;
748
+ readonly to: readonly ScheduledMessageRecipient[];
749
+ readonly cc: readonly ScheduledMessageRecipient[];
750
+ readonly bcc: readonly ScheduledMessageRecipient[];
751
+ readonly attachments: readonly ScheduledMessageAttachment[];
752
+ readonly scheduled_at: string;
753
+ readonly created_at: string;
754
+ readonly updated_at: string;
755
+ readonly last_error: string | null;
756
+ readonly draft_email_id?: string | undefined;
757
+ readonly from_name?: string | undefined;
758
+ readonly text?: string | undefined;
759
+ readonly html?: string | undefined;
760
+ readonly in_reply_to?: string | null | undefined;
761
+ readonly references?: readonly string[] | undefined;
762
+ readonly uploaded_attachments?: readonly ScheduledMessageUploadedAttachment[] | undefined;
763
+ };
764
+ type ScheduledMessageList = {
765
+ readonly object: "scheduled_message_list";
766
+ readonly data: readonly ScheduledMessage[];
767
+ readonly total: number;
768
+ };
769
+ type ListScheduledMessagesParams = {
770
+ readonly include_held?: boolean | undefined;
771
+ readonly search?: string | undefined;
772
+ readonly limit?: number | undefined;
773
+ };
774
+ type UpdateScheduledMessageParams = {
775
+ readonly to: readonly EmailRecipientInput[];
776
+ readonly cc?: readonly EmailRecipientInput[] | undefined;
777
+ readonly bcc?: readonly EmailRecipientInput[] | undefined;
778
+ readonly subject: string;
779
+ readonly html?: string | undefined;
780
+ readonly text?: string | undefined;
781
+ readonly in_reply_to?: string | undefined;
782
+ readonly references?: readonly string[] | undefined;
783
+ readonly staged_attachment_ids?: readonly string[] | undefined;
784
+ readonly scheduled_at: string;
785
+ };
661
786
  type ListMessagesParams = PaginationParams & ({
662
787
  readonly mailbox_id: string;
663
788
  readonly client_reference?: string | undefined;
@@ -931,63 +1056,6 @@ type InboxMessageAction = {
931
1056
  readonly message_id: string;
932
1057
  readonly ok: true;
933
1058
  };
934
- type MailboxRuleMatchMode = "all" | "any";
935
- type MailboxRuleCondition = {
936
- readonly type: "from_is" | "from_contains" | "recipient_is" | "plus_tag_is" | "subject_contains";
937
- readonly value: string;
938
- } | {
939
- readonly type: "has_attachment" | "list_unsubscribe_exists";
940
- } | {
941
- readonly type: "group";
942
- readonly match_mode: MailboxRuleMatchMode;
943
- readonly conditions: readonly MailboxRuleCondition[];
944
- };
945
- type MailboxRuleMoveTarget = {
946
- readonly kind: "system";
947
- readonly role: "inbox" | "archive" | "junk" | "trash";
948
- } | {
949
- readonly kind: "custom";
950
- readonly folder_id: string;
951
- };
952
- type MailboxRuleAction = {
953
- readonly type: "move";
954
- readonly target: MailboxRuleMoveTarget;
955
- } | {
956
- readonly type: "mark_read";
957
- } | {
958
- readonly type: "star";
959
- } | {
960
- readonly type: "send_webhook";
961
- } | {
962
- readonly type: "ai_draft_reply";
963
- readonly instructions: string;
964
- readonly reply_mode: "reply" | "reply_all";
965
- readonly agent_policy: "observe_only" | "draft_for_review";
966
- };
967
- type MailboxRule = {
968
- readonly id: string;
969
- readonly name: string;
970
- readonly enabled: boolean;
971
- readonly position: number;
972
- readonly match_mode: MailboxRuleMatchMode;
973
- readonly stop: boolean;
974
- readonly conditions: readonly MailboxRuleCondition[];
975
- readonly actions: readonly MailboxRuleAction[];
976
- };
977
- type MailboxRuleFolder = {
978
- readonly id: string;
979
- readonly name: string;
980
- readonly parent_id: string | null;
981
- readonly role: string | null;
982
- readonly kind: "custom" | "system";
983
- };
984
- type MailboxRules = {
985
- readonly object: "mailbox_rules";
986
- readonly mailbox_id: string;
987
- readonly address: string;
988
- readonly rules: readonly MailboxRule[];
989
- readonly folders: readonly MailboxRuleFolder[];
990
- };
991
1059
  type MailboxForwarding = {
992
1060
  readonly object: "mailbox_forwarding";
993
1061
  readonly id: string;
@@ -1088,11 +1156,10 @@ type UpdateAutoReplyParams = {
1088
1156
  type UpdateSpamFilterParams = {
1089
1157
  readonly threshold: number;
1090
1158
  };
1091
- type UpdateMailboxRulesParams = {
1092
- readonly rules: readonly MailboxRule[];
1093
- };
1094
1159
 
1095
1160
  declare class Mailboxes extends ApiResource {
1161
+ prepareStagedAttachmentUpload(id: string, params: PrepareStagedAttachmentUploadParams, options?: OneTimeSecretMethodOptions): Promise<StagedAttachmentUpload>;
1162
+ stageAttachment(id: string, params: StageAttachmentParams, options?: MethodOptions): Promise<StagedAttachment>;
1096
1163
  injectSandboxInbound(id: string, params: InjectSandboxInboundParams, options?: MethodOptions): Promise<Message>;
1097
1164
  create(params: CreateMailboxParams, options?: MethodOptions): Promise<Mailbox>;
1098
1165
  list(params?: ListMailboxesParams, options?: MethodOptions): Promise<PaginatedResponse<Mailbox>>;
@@ -1126,8 +1193,6 @@ declare class Mailboxes extends ApiResource {
1126
1193
  listAppPasswords(id: string, options?: MethodOptions): Promise<MailboxAppPasswordList>;
1127
1194
  createAppPassword(id: string, params: CreateMailboxAppPasswordParams, options?: OneTimeSecretMethodOptions): Promise<CreatedMailboxAppPassword>;
1128
1195
  revokeAppPassword(id: string, appPasswordId: string, options?: MethodOptions): Promise<void>;
1129
- getRules(id: string, options?: MethodOptions): Promise<MailboxRules>;
1130
- updateRules(id: string, params: UpdateMailboxRulesParams, options?: MethodOptions): Promise<MailboxRules>;
1131
1196
  listForwarding(id: string, options?: MethodOptions): Promise<MailboxForwardingList>;
1132
1197
  createForwarding(id: string, params: CreateMailboxForwardingParams, options?: MethodOptions): Promise<MailboxForwarding>;
1133
1198
  deleteForwarding(id: string, forwardingId: string, options?: MethodOptions): Promise<void>;
@@ -1636,6 +1701,13 @@ declare class ReplyScans extends ApiResource {
1636
1701
  listResults(id: string, params?: ListReplyScanResultsParams, options?: MethodOptions): Promise<ReplyScanResults>;
1637
1702
  }
1638
1703
 
1704
+ declare class ScheduledMessages extends ApiResource {
1705
+ list(params?: ListScheduledMessagesParams, options?: MethodOptions): Promise<ScheduledMessageList>;
1706
+ get(id: string, options?: MethodOptions): Promise<ScheduledMessage>;
1707
+ update(id: string, params: UpdateScheduledMessageParams, options?: MethodOptions): Promise<ScheduledMessage>;
1708
+ cancel(id: string, options?: MethodOptions): Promise<void>;
1709
+ }
1710
+
1639
1711
  declare class Status extends ApiResource {
1640
1712
  get(options?: MethodOptions): Promise<StatusResponse>;
1641
1713
  }
@@ -1790,6 +1862,7 @@ declare class ShipMailClient {
1790
1862
  private readonly organizationId;
1791
1863
  readonly audiences: Audiences;
1792
1864
  readonly bookingPages: BookingPages;
1865
+ readonly capabilities: Capabilities;
1793
1866
  readonly calendar: Calendar;
1794
1867
  readonly domains: Domains;
1795
1868
  readonly mailboxes: Mailboxes;
@@ -1797,6 +1870,7 @@ declare class ShipMailClient {
1797
1870
  readonly newsletters: Newsletters;
1798
1871
  readonly partner: Partner;
1799
1872
  readonly replyScans: ReplyScans;
1873
+ readonly scheduledMessages: ScheduledMessages;
1800
1874
  readonly suppressions: Suppressions;
1801
1875
  readonly threads: Threads;
1802
1876
  readonly webhooks: Webhooks;
@@ -1885,4 +1959,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
1885
1959
  readonly toleranceInSeconds?: number | undefined;
1886
1960
  }): Promise<WebhookEvent>;
1887
1961
 
1888
- export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, 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 OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, QuotaExceededError, RateLimitError, 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 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 UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, 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 };
1962
+ export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, 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 MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, 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 OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, 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 TransactionalRecipientBudget, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, type UpdateScheduledMessageParams, 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 };