shipmail 0.4.13 → 0.4.15

package/dist/index.d.cts

@@ -205,6 +205,121 @@ declare class Audiences extends ApiResource {
     delete(id: string, options?: MethodOptions): Promise<void>;
 }
 
+type AutomationTrigger = {
+    readonly type: "email_received";
+    readonly mailbox_ids: readonly string[];
+} | {
+    readonly type: "scheduled";
+    readonly cron: string;
+    readonly time_zone: string;
+} | {
+    readonly type: "manual";
+    readonly mailbox_ids: readonly string[];
+} | {
+    readonly type: "thread_state";
+    readonly mailbox_ids: readonly string[];
+    readonly state: "no_reply_after";
+    readonly duration_minutes: number;
+};
+type AutomationCondition = {
+    readonly type: "sender_address";
+    readonly addresses: readonly string[];
+} | {
+    readonly type: "sender_domain";
+    readonly domains: readonly string[];
+} | {
+    readonly type: "subject_contains";
+    readonly values: readonly string[];
+} | {
+    readonly type: "has_attachment";
+    readonly value: boolean;
+} | {
+    readonly type: "semantic_positive_match";
+    readonly instruction: string;
+    readonly minimum_confidence: number;
+};
+type AutomationAction = {
+    readonly type: "create_reply_draft";
+    readonly instruction: string;
+} | {
+    readonly type: "reply_to_trigger_sender";
+    readonly instruction: string;
+} | {
+    readonly type: "archive_trigger_message";
+} | {
+    readonly type: "move_trigger_message";
+    readonly mailbox_id: string;
+    readonly destination_folder_id: string;
+} | {
+    readonly type: "set_trigger_read_state";
+    readonly is_read: boolean;
+} | {
+    readonly type: "set_trigger_star_state";
+    readonly is_starred: boolean;
+} | {
+    readonly type: "generate_mail_report";
+    readonly metric: "received" | "sent" | "unread";
+    readonly lookback_minutes: number;
+};
+type AutomationDefinition = {
+    readonly trigger: AutomationTrigger;
+    readonly conditions: readonly AutomationCondition[];
+    readonly actions: readonly AutomationAction[];
+    readonly mode: "draft" | "send";
+    readonly scope: {
+        readonly mailbox_ids: readonly string[];
+        readonly calendar_addresses: readonly string[];
+    };
+};
+type AutomationStatus = "active" | "paused" | "disabled";
+type AutomationRunStatus = "queued" | "running" | "completed" | "failed" | "degraded" | "cancelled" | "skipped";
+type AutomationRunSummary = {
+    readonly object: "automation_run";
+    readonly id: string;
+    readonly status: AutomationRunStatus;
+    readonly error_code: string | null;
+    readonly created_at: string;
+};
+type AutomationRun = {
+    readonly object: "automation_run";
+    readonly id: string;
+    readonly automation_id: string;
+    readonly status: "queued";
+};
+type Automation = {
+    readonly object: "automation";
+    readonly id: string;
+    readonly name: string;
+    readonly status: AutomationStatus;
+    readonly version_id: string;
+    readonly version: number;
+    readonly definition: AutomationDefinition;
+    readonly last_run: AutomationRunSummary | null;
+    readonly next_run_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateAutomationParams = {
+    readonly name: string;
+    readonly definition: AutomationDefinition;
+};
+type UpdateAutomationParams = {
+    readonly name?: string | undefined;
+    readonly definition?: AutomationDefinition | undefined;
+    readonly status?: AutomationStatus | undefined;
+};
+type ListAutomationsResponse = {
+    readonly data: readonly Automation[];
+};
+
+declare class Automations extends ApiResource {
+    list(options?: MethodOptions): Promise<ListAutomationsResponse>;
+    create(params: CreateAutomationParams, options?: MethodOptions): Promise<Automation>;
+    get(id: string, options?: MethodOptions): Promise<Automation>;
+    update(id: string, params: UpdateAutomationParams, options?: MethodOptions): Promise<Automation>;
+    run(id: string, options?: MethodOptions): Promise<AutomationRun>;
+}
+
 declare const CONFERENCING_PROVIDER_IDS: readonly ["zoom", "google_meet"];
 type ConferencingProviderId = (typeof CONFERENCING_PROVIDER_IDS)[number];
 type BookingPage = {
@@ -274,6 +389,7 @@ declare class BookingPages extends ApiResource {
 type CalendarEventStatus = "confirmed" | "tentative" | "cancelled";
 type CalendarFreeBusyStatus = "free" | "busy";
 type CalendarEventPrivacy = "public" | "private" | "secret";
+type CalendarInvitationLanguage = "en" | "fr" | "es";
 type RecurrenceFrequency = "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly";
 type Weekday = "mo" | "tu" | "we" | "th" | "fr" | "sa" | "su";
 type RecurrenceNDay = {
@@ -308,6 +424,7 @@ type CalendarEvent = {
     readonly calendar_id: string | null;
     readonly uid: string | null;
     readonly title: string | null;
+    readonly invitation_language: CalendarInvitationLanguage;
     readonly description: string | null;
     readonly location: string | null;
     readonly video_url: string | null;
@@ -345,6 +462,7 @@ type CreateCalendarEventParams = {
     readonly mailbox: string;
     readonly calendar_id?: string | undefined;
     readonly title: string;
+    readonly invitation_language?: CalendarInvitationLanguage | undefined;
     readonly start: string;
     readonly description?: string | undefined;
     readonly timezone?: string | undefined;
@@ -363,6 +481,7 @@ type CreateCalendarEventParams = {
 type UpdateCalendarEventParams = {
     readonly mailbox: string;
     readonly title?: string | undefined;
+    readonly invitation_language?: CalendarInvitationLanguage | undefined;
     readonly description?: string | null | undefined;
     readonly start?: string | undefined;
     readonly timezone?: string | null | undefined;
@@ -1422,6 +1541,7 @@ type Newsletter = {
     readonly body_text: string | null;
     readonly status: NewsletterStatus;
     readonly archive_visibility: NewsletterArchiveVisibility;
+    readonly feed_entry_url: string | null;
     readonly styling_mode: NewsletterStylingMode;
     readonly preflight_status: NewsletterPreflightStatus;
     readonly preflight_results: Record<string, unknown>;
@@ -1509,6 +1629,7 @@ type CreateNewsletterParams = {
     readonly blocks?: readonly NewsletterBlock[] | undefined;
     readonly send_window_hours?: number | undefined;
     readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+    readonly feed_entry_url?: string | null | undefined;
     readonly styling_mode?: NewsletterStylingMode | undefined;
 };
 type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
@@ -1547,6 +1668,7 @@ type CreateNewsletterFromChangelogParams = {
     } | undefined;
     readonly send_window_hours?: number | undefined;
     readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+    readonly feed_entry_url?: string | null | undefined;
     readonly styling_mode?: NewsletterStylingMode | undefined;
 };
 type ListNewsletterDomainsParams = PaginationParams;
@@ -2030,6 +2152,7 @@ declare class ShipmailClient {
     private readonly defaultHeaders;
     private readonly organizationId;
     readonly audiences: Audiences;
+    readonly automations: Automations;
     readonly bookingPages: BookingPages;
     readonly capabilities: Capabilities;
     readonly calendar: Calendar;
@@ -2128,4 +2251,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
     readonly toleranceInSeconds?: number | undefined;
 }): Promise<WebhookEvent>;
 
-export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type 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 EmailAuthVerdict, type EmailAuthenticationResults, 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 ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type 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 MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, 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 UpdateAudienceFeedParams, 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 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 };
+export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateAutomationParams, 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 EmailAuthVerdict, type EmailAuthenticationResults, 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 ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type 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 MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, 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 UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, 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

@@ -205,6 +205,121 @@ declare class Audiences extends ApiResource {
     delete(id: string, options?: MethodOptions): Promise<void>;
 }
 
+type AutomationTrigger = {
+    readonly type: "email_received";
+    readonly mailbox_ids: readonly string[];
+} | {
+    readonly type: "scheduled";
+    readonly cron: string;
+    readonly time_zone: string;
+} | {
+    readonly type: "manual";
+    readonly mailbox_ids: readonly string[];
+} | {
+    readonly type: "thread_state";
+    readonly mailbox_ids: readonly string[];
+    readonly state: "no_reply_after";
+    readonly duration_minutes: number;
+};
+type AutomationCondition = {
+    readonly type: "sender_address";
+    readonly addresses: readonly string[];
+} | {
+    readonly type: "sender_domain";
+    readonly domains: readonly string[];
+} | {
+    readonly type: "subject_contains";
+    readonly values: readonly string[];
+} | {
+    readonly type: "has_attachment";
+    readonly value: boolean;
+} | {
+    readonly type: "semantic_positive_match";
+    readonly instruction: string;
+    readonly minimum_confidence: number;
+};
+type AutomationAction = {
+    readonly type: "create_reply_draft";
+    readonly instruction: string;
+} | {
+    readonly type: "reply_to_trigger_sender";
+    readonly instruction: string;
+} | {
+    readonly type: "archive_trigger_message";
+} | {
+    readonly type: "move_trigger_message";
+    readonly mailbox_id: string;
+    readonly destination_folder_id: string;
+} | {
+    readonly type: "set_trigger_read_state";
+    readonly is_read: boolean;
+} | {
+    readonly type: "set_trigger_star_state";
+    readonly is_starred: boolean;
+} | {
+    readonly type: "generate_mail_report";
+    readonly metric: "received" | "sent" | "unread";
+    readonly lookback_minutes: number;
+};
+type AutomationDefinition = {
+    readonly trigger: AutomationTrigger;
+    readonly conditions: readonly AutomationCondition[];
+    readonly actions: readonly AutomationAction[];
+    readonly mode: "draft" | "send";
+    readonly scope: {
+        readonly mailbox_ids: readonly string[];
+        readonly calendar_addresses: readonly string[];
+    };
+};
+type AutomationStatus = "active" | "paused" | "disabled";
+type AutomationRunStatus = "queued" | "running" | "completed" | "failed" | "degraded" | "cancelled" | "skipped";
+type AutomationRunSummary = {
+    readonly object: "automation_run";
+    readonly id: string;
+    readonly status: AutomationRunStatus;
+    readonly error_code: string | null;
+    readonly created_at: string;
+};
+type AutomationRun = {
+    readonly object: "automation_run";
+    readonly id: string;
+    readonly automation_id: string;
+    readonly status: "queued";
+};
+type Automation = {
+    readonly object: "automation";
+    readonly id: string;
+    readonly name: string;
+    readonly status: AutomationStatus;
+    readonly version_id: string;
+    readonly version: number;
+    readonly definition: AutomationDefinition;
+    readonly last_run: AutomationRunSummary | null;
+    readonly next_run_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateAutomationParams = {
+    readonly name: string;
+    readonly definition: AutomationDefinition;
+};
+type UpdateAutomationParams = {
+    readonly name?: string | undefined;
+    readonly definition?: AutomationDefinition | undefined;
+    readonly status?: AutomationStatus | undefined;
+};
+type ListAutomationsResponse = {
+    readonly data: readonly Automation[];
+};
+
+declare class Automations extends ApiResource {
+    list(options?: MethodOptions): Promise<ListAutomationsResponse>;
+    create(params: CreateAutomationParams, options?: MethodOptions): Promise<Automation>;
+    get(id: string, options?: MethodOptions): Promise<Automation>;
+    update(id: string, params: UpdateAutomationParams, options?: MethodOptions): Promise<Automation>;
+    run(id: string, options?: MethodOptions): Promise<AutomationRun>;
+}
+
 declare const CONFERENCING_PROVIDER_IDS: readonly ["zoom", "google_meet"];
 type ConferencingProviderId = (typeof CONFERENCING_PROVIDER_IDS)[number];
 type BookingPage = {
@@ -274,6 +389,7 @@ declare class BookingPages extends ApiResource {
 type CalendarEventStatus = "confirmed" | "tentative" | "cancelled";
 type CalendarFreeBusyStatus = "free" | "busy";
 type CalendarEventPrivacy = "public" | "private" | "secret";
+type CalendarInvitationLanguage = "en" | "fr" | "es";
 type RecurrenceFrequency = "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly";
 type Weekday = "mo" | "tu" | "we" | "th" | "fr" | "sa" | "su";
 type RecurrenceNDay = {
@@ -308,6 +424,7 @@ type CalendarEvent = {
     readonly calendar_id: string | null;
     readonly uid: string | null;
     readonly title: string | null;
+    readonly invitation_language: CalendarInvitationLanguage;
     readonly description: string | null;
     readonly location: string | null;
     readonly video_url: string | null;
@@ -345,6 +462,7 @@ type CreateCalendarEventParams = {
     readonly mailbox: string;
     readonly calendar_id?: string | undefined;
     readonly title: string;
+    readonly invitation_language?: CalendarInvitationLanguage | undefined;
     readonly start: string;
     readonly description?: string | undefined;
     readonly timezone?: string | undefined;
@@ -363,6 +481,7 @@ type CreateCalendarEventParams = {
 type UpdateCalendarEventParams = {
     readonly mailbox: string;
     readonly title?: string | undefined;
+    readonly invitation_language?: CalendarInvitationLanguage | undefined;
     readonly description?: string | null | undefined;
     readonly start?: string | undefined;
     readonly timezone?: string | null | undefined;
@@ -1422,6 +1541,7 @@ type Newsletter = {
     readonly body_text: string | null;
     readonly status: NewsletterStatus;
     readonly archive_visibility: NewsletterArchiveVisibility;
+    readonly feed_entry_url: string | null;
     readonly styling_mode: NewsletterStylingMode;
     readonly preflight_status: NewsletterPreflightStatus;
     readonly preflight_results: Record<string, unknown>;
@@ -1509,6 +1629,7 @@ type CreateNewsletterParams = {
     readonly blocks?: readonly NewsletterBlock[] | undefined;
     readonly send_window_hours?: number | undefined;
     readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+    readonly feed_entry_url?: string | null | undefined;
     readonly styling_mode?: NewsletterStylingMode | undefined;
 };
 type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
@@ -1547,6 +1668,7 @@ type CreateNewsletterFromChangelogParams = {
     } | undefined;
     readonly send_window_hours?: number | undefined;
     readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+    readonly feed_entry_url?: string | null | undefined;
     readonly styling_mode?: NewsletterStylingMode | undefined;
 };
 type ListNewsletterDomainsParams = PaginationParams;
@@ -2030,6 +2152,7 @@ declare class ShipmailClient {
     private readonly defaultHeaders;
     private readonly organizationId;
     readonly audiences: Audiences;
+    readonly automations: Automations;
     readonly bookingPages: BookingPages;
     readonly capabilities: Capabilities;
     readonly calendar: Calendar;
@@ -2128,4 +2251,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
     readonly toleranceInSeconds?: number | undefined;
 }): Promise<WebhookEvent>;
 
-export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type 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 EmailAuthVerdict, type EmailAuthenticationResults, 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 ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type 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 MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, 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 UpdateAudienceFeedParams, 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 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 };
+export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateAutomationParams, 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 EmailAuthVerdict, type EmailAuthenticationResults, 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 ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type 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 MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, 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 UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, 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.js

@@ -3,6 +3,8 @@ var API_KEY_SCOPES = [
   "*",
   "audiences:read",
   "audiences:write",
+  "automations:read",
+  "automations:write",
   "booking_pages:read",
   "booking_pages:write",
   "calendar:read",
@@ -39,6 +41,8 @@ var API_KEY_SCOPE_DESCRIPTIONS = {
   "*": "All non-partner API endpoints in this organization.",
   "audiences:read": "List and retrieve newsletter audiences and their subscribers.",
   "audiences:write": "Create audiences and add, update, or remove their subscribers.",
+  "automations:read": "List and retrieve assistant automations.",
+  "automations:write": "Create, update, and manually run assistant automations.",
   "booking_pages:read": "List and retrieve booking pages.",
   "booking_pages:write": "Create, update, and delete booking pages.",
   "calendar:read": "List and retrieve calendar events and open availability.",
@@ -393,6 +397,47 @@ var Audiences = class extends ApiResource {
   }
 };
 
+// src/resources/automations.ts
+var Automations = class extends ApiResource {
+  list(options) {
+    return this.client.request({
+      method: "GET",
+      path: "/automations",
+      methodOptions: options
+    });
+  }
+  create(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/automations",
+      body: params,
+      methodOptions: options
+    });
+  }
+  get(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/automations/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+  update(id, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/automations/${encodeURIComponent(id)}`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  run(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `/automations/${encodeURIComponent(id)}/run`,
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/booking-pages.ts
 var BookingPages = class extends ApiResource {
   create(params, options) {
@@ -1564,7 +1609,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.4.13";
+var VERSION = "0.4.15";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1618,6 +1663,7 @@ var ShipmailClient = class {
       this.organizationId = config.organizationId;
     }
     this.audiences = new Audiences(this);
+    this.automations = new Automations(this);
     this.bookingPages = new BookingPages(this);
     this.capabilities = new Capabilities(this);
     this.calendar = new Calendar(this);