shipmail 0.1.32 → 0.2.0

package/dist/index.d.cts

@@ -18,6 +18,7 @@ type ShipMailConfig = {
     readonly timeout?: number | undefined;
     readonly fetch?: typeof fetch | undefined;
     readonly defaultHeaders?: Record<string, string> | undefined;
+    readonly organizationId?: string | undefined;
 };
 type PaginationParams = {
     readonly cursor?: string | undefined;
@@ -75,7 +76,9 @@ type MethodOptions = {
     readonly signal?: AbortSignal | undefined;
     readonly headers?: Record<string, string> | undefined;
     readonly idempotencyKey?: string | undefined;
+    readonly organizationId?: string | undefined;
 };
+type OneTimeSecretMethodOptions = Omit<MethodOptions, "idempotencyKey">;
 
 type MergeFields = Record<string, string | number | boolean | null>;
 type SubscriberStatus = "subscribed" | "pending" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
@@ -165,6 +168,8 @@ declare class Audiences extends ApiResource {
     delete(id: string, options?: MethodOptions): Promise<void>;
 }
 
+declare const CONFERENCING_PROVIDER_IDS: readonly ["zoom", "google_meet"];
+type ConferencingProviderId = (typeof CONFERENCING_PROVIDER_IDS)[number];
 type BookingPage = {
     readonly object: "booking_page";
     readonly id: string;
@@ -181,6 +186,7 @@ type BookingPage = {
     readonly buffer_minutes: number;
     readonly minimum_notice_minutes: number;
     readonly max_advance_days: number;
+    readonly conferencing_provider: ConferencingProviderId | null;
     readonly active: boolean;
     readonly created_at: string;
     readonly updated_at: string;
@@ -199,6 +205,7 @@ type CreateBookingPageParams = {
     readonly buffer_minutes?: number | undefined;
     readonly minimum_notice_minutes?: number | undefined;
     readonly max_advance_days?: number | undefined;
+    readonly conferencing_provider?: ConferencingProviderId | null | undefined;
     readonly active?: boolean | undefined;
 };
 type UpdateBookingPageParams = {
@@ -214,6 +221,7 @@ type UpdateBookingPageParams = {
     readonly buffer_minutes?: number | undefined;
     readonly minimum_notice_minutes?: number | undefined;
     readonly max_advance_days?: number | undefined;
+    readonly conferencing_provider?: ConferencingProviderId | null | undefined;
     readonly active?: boolean | undefined;
 };
 
@@ -625,6 +633,33 @@ type MailboxExport = {
     readonly started_at: string | null;
     readonly completed_at: string | null;
 };
+type MailboxAppPasswordState = "pending_create" | "active" | "pending_revoke" | "revoked" | "failed";
+type MailboxAppPasswordPurpose = "operator_client" | "partner_embedded_webmail";
+type MailboxAppPassword = {
+    readonly object: "mailbox_app_password";
+    readonly id: string;
+    readonly mailbox_id: string;
+    readonly name: string;
+    readonly state: MailboxAppPasswordState;
+    readonly purpose: MailboxAppPasswordPurpose;
+    readonly expires_at: string | null;
+    readonly allowed_cidrs: readonly string[];
+    readonly last_used_at: string | null;
+    readonly created_at: string;
+    readonly revoked_at: string | null;
+};
+type CreatedMailboxAppPassword = MailboxAppPassword & {
+    readonly secret: string;
+};
+type MailboxAppPasswordList = {
+    readonly object: "list";
+    readonly data: readonly MailboxAppPassword[];
+};
+type CreateMailboxAppPasswordParams = {
+    readonly name: string;
+    readonly expires_at?: string | undefined;
+    readonly allowed_cidrs?: readonly string[] | undefined;
+};
 type MailboxFolder = {
     readonly object: "mailbox_folder";
     readonly id: string;
@@ -807,12 +842,18 @@ type MailboxForwardingList = {
 type CreateMailboxForwardingParams = {
     readonly destination: string;
 };
-type CreateMailboxParams = {
+type CreateMailboxBaseParams = {
     readonly domain_id: string;
     readonly address: string;
-    readonly password: string;
     readonly display_name?: string | undefined;
 };
+type CreateMailboxParams = CreateMailboxBaseParams & ({
+    readonly password: string;
+    readonly generate_password?: never;
+} | {
+    readonly password?: never;
+    readonly generate_password: true;
+});
 type UpdateMailboxParams = {
     readonly display_name?: string | null | undefined;
 };
@@ -988,6 +1029,9 @@ declare class Mailboxes extends ApiResource {
     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>;
+    listAppPasswords(id: string, options?: MethodOptions): Promise<MailboxAppPasswordList>;
+    createAppPassword(id: string, params: CreateMailboxAppPasswordParams, options?: OneTimeSecretMethodOptions): Promise<CreatedMailboxAppPassword>;
+    revokeAppPassword(id: string, appPasswordId: string, options?: MethodOptions): Promise<void>;
     getRules(id: string, options?: MethodOptions): Promise<MailboxRules>;
     updateRules(id: string, params: UpdateMailboxRulesParams, options?: MethodOptions): Promise<MailboxRules>;
     listForwarding(id: string, options?: MethodOptions): Promise<MailboxForwardingList>;
@@ -1344,6 +1388,107 @@ declare class Newsletters extends ApiResource {
     resume(id: string, options?: MethodOptions): Promise<Newsletter>;
 }
 
+type PartnerOrganizationStatus = "pending_owner" | "active" | "suspended" | "offboarding" | "disconnected";
+type PartnerDataClassification = "internal_test" | "customer";
+type PartnerOrganization = {
+    readonly object: "partner_organization";
+    readonly id: string;
+    readonly organization_id: string;
+    readonly name: string;
+    readonly external_reference: string;
+    readonly owner_email: string;
+    readonly owner_user_id: string | null;
+    readonly status: PartnerOrganizationStatus;
+    readonly data_classification: PartnerDataClassification;
+    readonly mailbox_limit: number;
+    readonly delegated_permissions: readonly string[];
+    readonly owner_accepted_at: string | null;
+    readonly activated_at: string | null;
+    readonly suspended_at: string | null;
+    readonly disconnected_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreatePartnerOrganizationParams = {
+    readonly name: string;
+    readonly external_reference: string;
+    readonly owner_email: string;
+    readonly mailbox_limit: number;
+    readonly data_classification: PartnerDataClassification;
+};
+type UpdatePartnerOrganizationParams = {
+    readonly name?: string | undefined;
+    readonly mailbox_limit?: number | undefined;
+};
+type PartnerOrganizationList = {
+    readonly data: readonly PartnerOrganization[];
+};
+type PartnerOwnershipInvitation = {
+    readonly object: "partner_ownership_invitation";
+    readonly owner_email: string;
+    readonly email_sent: boolean;
+    readonly expires_at: string;
+};
+type CreatedPartnerOrganization = PartnerOrganization & {
+    readonly ownership_invitation: PartnerOwnershipInvitation | null;
+};
+type PartnerUsage = {
+    readonly object: "partner_usage";
+    readonly period_start: string;
+    readonly period_end: string;
+    readonly closed_through: string | null;
+    readonly active_children: number;
+    readonly active_mailboxes: number;
+    readonly child_active_seconds: number;
+    readonly mailbox_active_seconds: number;
+    readonly child_subtotal: number;
+    readonly mailbox_subtotal: number;
+    readonly minimum_shortfall: number;
+    readonly projected_total: number;
+    readonly currency: string;
+};
+type ConsumePartnerMailboxCredentialGrantParams = {
+    readonly name?: string | undefined;
+    readonly expires_at?: string | undefined;
+    readonly allowed_cidrs?: readonly string[] | undefined;
+};
+type PartnerMailboxCredentialGrant = {
+    readonly object: "partner_mailbox_credential_grant";
+    readonly id: string;
+    readonly partner_organization_id: string;
+    readonly organization_id: string;
+    readonly organization_name: string;
+    readonly external_reference: string;
+    readonly operator_email: string;
+    readonly mailbox_id: string;
+    readonly mailbox_address: string;
+    readonly disclosure_version: string;
+    readonly expires_at: string;
+    readonly consented_at: string;
+};
+type PartnerMailboxCredentialGrantList = {
+    readonly data: readonly PartnerMailboxCredentialGrant[];
+};
+type PartnerMailboxCredential = CreatedMailboxAppPassword & {
+    readonly operator_notified: boolean;
+};
+
+declare class Partner extends ApiResource {
+    listOrganizations(options?: MethodOptions): Promise<PartnerOrganizationList>;
+    createOrganization(params: CreatePartnerOrganizationParams, options?: MethodOptions): Promise<CreatedPartnerOrganization>;
+    getOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    updateOrganization(id: string, params: UpdatePartnerOrganizationParams, options?: MethodOptions): Promise<PartnerOrganization>;
+    resendOwnershipInvitation(id: string, params?: {
+        readonly owner_email?: string | undefined;
+    }, options?: MethodOptions): Promise<PartnerOwnershipInvitation>;
+    suspendOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    resumeOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    offboardOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    listMailboxCredentialGrants(options?: MethodOptions): Promise<PartnerMailboxCredentialGrantList>;
+    consumeMailboxCredentialGrant(grantId: string, params?: ConsumePartnerMailboxCredentialGrantParams, options?: OneTimeSecretMethodOptions): Promise<PartnerMailboxCredential>;
+    usage(options?: MethodOptions): Promise<PartnerUsage>;
+}
+
 declare class Status extends ApiResource {
     get(options?: MethodOptions): Promise<StatusResponse>;
 }
@@ -1492,6 +1637,7 @@ declare class ShipMailClient {
     private readonly timeout;
     private readonly fetchFn;
     private readonly defaultHeaders;
+    private readonly organizationId;
     readonly audiences: Audiences;
     readonly bookingPages: BookingPages;
     readonly calendar: Calendar;
@@ -1499,6 +1645,7 @@ declare class ShipMailClient {
     readonly mailboxes: Mailboxes;
     readonly messages: Messages;
     readonly newsletters: Newsletters;
+    readonly partner: Partner;
     readonly suppressions: Suppressions;
     readonly threads: Threads;
     readonly webhooks: Webhooks;
@@ -1587,4 +1734,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 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 };
+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 CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, 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 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 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 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 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 };

package/dist/index.d.ts

@@ -18,6 +18,7 @@ type ShipMailConfig = {
     readonly timeout?: number | undefined;
     readonly fetch?: typeof fetch | undefined;
     readonly defaultHeaders?: Record<string, string> | undefined;
+    readonly organizationId?: string | undefined;
 };
 type PaginationParams = {
     readonly cursor?: string | undefined;
@@ -75,7 +76,9 @@ type MethodOptions = {
     readonly signal?: AbortSignal | undefined;
     readonly headers?: Record<string, string> | undefined;
     readonly idempotencyKey?: string | undefined;
+    readonly organizationId?: string | undefined;
 };
+type OneTimeSecretMethodOptions = Omit<MethodOptions, "idempotencyKey">;
 
 type MergeFields = Record<string, string | number | boolean | null>;
 type SubscriberStatus = "subscribed" | "pending" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
@@ -165,6 +168,8 @@ declare class Audiences extends ApiResource {
     delete(id: string, options?: MethodOptions): Promise<void>;
 }
 
+declare const CONFERENCING_PROVIDER_IDS: readonly ["zoom", "google_meet"];
+type ConferencingProviderId = (typeof CONFERENCING_PROVIDER_IDS)[number];
 type BookingPage = {
     readonly object: "booking_page";
     readonly id: string;
@@ -181,6 +186,7 @@ type BookingPage = {
     readonly buffer_minutes: number;
     readonly minimum_notice_minutes: number;
     readonly max_advance_days: number;
+    readonly conferencing_provider: ConferencingProviderId | null;
     readonly active: boolean;
     readonly created_at: string;
     readonly updated_at: string;
@@ -199,6 +205,7 @@ type CreateBookingPageParams = {
     readonly buffer_minutes?: number | undefined;
     readonly minimum_notice_minutes?: number | undefined;
     readonly max_advance_days?: number | undefined;
+    readonly conferencing_provider?: ConferencingProviderId | null | undefined;
     readonly active?: boolean | undefined;
 };
 type UpdateBookingPageParams = {
@@ -214,6 +221,7 @@ type UpdateBookingPageParams = {
     readonly buffer_minutes?: number | undefined;
     readonly minimum_notice_minutes?: number | undefined;
     readonly max_advance_days?: number | undefined;
+    readonly conferencing_provider?: ConferencingProviderId | null | undefined;
     readonly active?: boolean | undefined;
 };
 
@@ -625,6 +633,33 @@ type MailboxExport = {
     readonly started_at: string | null;
     readonly completed_at: string | null;
 };
+type MailboxAppPasswordState = "pending_create" | "active" | "pending_revoke" | "revoked" | "failed";
+type MailboxAppPasswordPurpose = "operator_client" | "partner_embedded_webmail";
+type MailboxAppPassword = {
+    readonly object: "mailbox_app_password";
+    readonly id: string;
+    readonly mailbox_id: string;
+    readonly name: string;
+    readonly state: MailboxAppPasswordState;
+    readonly purpose: MailboxAppPasswordPurpose;
+    readonly expires_at: string | null;
+    readonly allowed_cidrs: readonly string[];
+    readonly last_used_at: string | null;
+    readonly created_at: string;
+    readonly revoked_at: string | null;
+};
+type CreatedMailboxAppPassword = MailboxAppPassword & {
+    readonly secret: string;
+};
+type MailboxAppPasswordList = {
+    readonly object: "list";
+    readonly data: readonly MailboxAppPassword[];
+};
+type CreateMailboxAppPasswordParams = {
+    readonly name: string;
+    readonly expires_at?: string | undefined;
+    readonly allowed_cidrs?: readonly string[] | undefined;
+};
 type MailboxFolder = {
     readonly object: "mailbox_folder";
     readonly id: string;
@@ -807,12 +842,18 @@ type MailboxForwardingList = {
 type CreateMailboxForwardingParams = {
     readonly destination: string;
 };
-type CreateMailboxParams = {
+type CreateMailboxBaseParams = {
     readonly domain_id: string;
     readonly address: string;
-    readonly password: string;
     readonly display_name?: string | undefined;
 };
+type CreateMailboxParams = CreateMailboxBaseParams & ({
+    readonly password: string;
+    readonly generate_password?: never;
+} | {
+    readonly password?: never;
+    readonly generate_password: true;
+});
 type UpdateMailboxParams = {
     readonly display_name?: string | null | undefined;
 };
@@ -988,6 +1029,9 @@ declare class Mailboxes extends ApiResource {
     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>;
+    listAppPasswords(id: string, options?: MethodOptions): Promise<MailboxAppPasswordList>;
+    createAppPassword(id: string, params: CreateMailboxAppPasswordParams, options?: OneTimeSecretMethodOptions): Promise<CreatedMailboxAppPassword>;
+    revokeAppPassword(id: string, appPasswordId: string, options?: MethodOptions): Promise<void>;
     getRules(id: string, options?: MethodOptions): Promise<MailboxRules>;
     updateRules(id: string, params: UpdateMailboxRulesParams, options?: MethodOptions): Promise<MailboxRules>;
     listForwarding(id: string, options?: MethodOptions): Promise<MailboxForwardingList>;
@@ -1344,6 +1388,107 @@ declare class Newsletters extends ApiResource {
     resume(id: string, options?: MethodOptions): Promise<Newsletter>;
 }
 
+type PartnerOrganizationStatus = "pending_owner" | "active" | "suspended" | "offboarding" | "disconnected";
+type PartnerDataClassification = "internal_test" | "customer";
+type PartnerOrganization = {
+    readonly object: "partner_organization";
+    readonly id: string;
+    readonly organization_id: string;
+    readonly name: string;
+    readonly external_reference: string;
+    readonly owner_email: string;
+    readonly owner_user_id: string | null;
+    readonly status: PartnerOrganizationStatus;
+    readonly data_classification: PartnerDataClassification;
+    readonly mailbox_limit: number;
+    readonly delegated_permissions: readonly string[];
+    readonly owner_accepted_at: string | null;
+    readonly activated_at: string | null;
+    readonly suspended_at: string | null;
+    readonly disconnected_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreatePartnerOrganizationParams = {
+    readonly name: string;
+    readonly external_reference: string;
+    readonly owner_email: string;
+    readonly mailbox_limit: number;
+    readonly data_classification: PartnerDataClassification;
+};
+type UpdatePartnerOrganizationParams = {
+    readonly name?: string | undefined;
+    readonly mailbox_limit?: number | undefined;
+};
+type PartnerOrganizationList = {
+    readonly data: readonly PartnerOrganization[];
+};
+type PartnerOwnershipInvitation = {
+    readonly object: "partner_ownership_invitation";
+    readonly owner_email: string;
+    readonly email_sent: boolean;
+    readonly expires_at: string;
+};
+type CreatedPartnerOrganization = PartnerOrganization & {
+    readonly ownership_invitation: PartnerOwnershipInvitation | null;
+};
+type PartnerUsage = {
+    readonly object: "partner_usage";
+    readonly period_start: string;
+    readonly period_end: string;
+    readonly closed_through: string | null;
+    readonly active_children: number;
+    readonly active_mailboxes: number;
+    readonly child_active_seconds: number;
+    readonly mailbox_active_seconds: number;
+    readonly child_subtotal: number;
+    readonly mailbox_subtotal: number;
+    readonly minimum_shortfall: number;
+    readonly projected_total: number;
+    readonly currency: string;
+};
+type ConsumePartnerMailboxCredentialGrantParams = {
+    readonly name?: string | undefined;
+    readonly expires_at?: string | undefined;
+    readonly allowed_cidrs?: readonly string[] | undefined;
+};
+type PartnerMailboxCredentialGrant = {
+    readonly object: "partner_mailbox_credential_grant";
+    readonly id: string;
+    readonly partner_organization_id: string;
+    readonly organization_id: string;
+    readonly organization_name: string;
+    readonly external_reference: string;
+    readonly operator_email: string;
+    readonly mailbox_id: string;
+    readonly mailbox_address: string;
+    readonly disclosure_version: string;
+    readonly expires_at: string;
+    readonly consented_at: string;
+};
+type PartnerMailboxCredentialGrantList = {
+    readonly data: readonly PartnerMailboxCredentialGrant[];
+};
+type PartnerMailboxCredential = CreatedMailboxAppPassword & {
+    readonly operator_notified: boolean;
+};
+
+declare class Partner extends ApiResource {
+    listOrganizations(options?: MethodOptions): Promise<PartnerOrganizationList>;
+    createOrganization(params: CreatePartnerOrganizationParams, options?: MethodOptions): Promise<CreatedPartnerOrganization>;
+    getOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    updateOrganization(id: string, params: UpdatePartnerOrganizationParams, options?: MethodOptions): Promise<PartnerOrganization>;
+    resendOwnershipInvitation(id: string, params?: {
+        readonly owner_email?: string | undefined;
+    }, options?: MethodOptions): Promise<PartnerOwnershipInvitation>;
+    suspendOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    resumeOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    offboardOrganization(id: string, options?: MethodOptions): Promise<PartnerOrganization>;
+    listMailboxCredentialGrants(options?: MethodOptions): Promise<PartnerMailboxCredentialGrantList>;
+    consumeMailboxCredentialGrant(grantId: string, params?: ConsumePartnerMailboxCredentialGrantParams, options?: OneTimeSecretMethodOptions): Promise<PartnerMailboxCredential>;
+    usage(options?: MethodOptions): Promise<PartnerUsage>;
+}
+
 declare class Status extends ApiResource {
     get(options?: MethodOptions): Promise<StatusResponse>;
 }
@@ -1492,6 +1637,7 @@ declare class ShipMailClient {
     private readonly timeout;
     private readonly fetchFn;
     private readonly defaultHeaders;
+    private readonly organizationId;
     readonly audiences: Audiences;
     readonly bookingPages: BookingPages;
     readonly calendar: Calendar;
@@ -1499,6 +1645,7 @@ declare class ShipMailClient {
     readonly mailboxes: Mailboxes;
     readonly messages: Messages;
     readonly newsletters: Newsletters;
+    readonly partner: Partner;
     readonly suppressions: Suppressions;
     readonly threads: Threads;
     readonly webhooks: Webhooks;
@@ -1587,4 +1734,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 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 };
+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 CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, 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 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 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 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 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 };