shipmail 0.1.24 → 0.1.26

package/dist/index.d.cts

@@ -40,6 +40,7 @@ type ApiErrorBody = {
         readonly details?: readonly {
             readonly field: string;
             readonly message: string;
+            readonly code?: string | undefined;
         }[] | undefined;
         readonly retry_after?: number | undefined;
     };
@@ -683,6 +684,310 @@ declare class Messages extends ApiResource {
     reply(id: string, params: ReplyToMessageParams, options?: MethodOptions): Promise<Message>;
 }
 
+type NewsletterStatus = "draft" | "pending_approval" | "approved" | "scheduled" | "sending" | "paused" | "sent" | "cancelled" | "failed";
+type NewsletterArchiveVisibility = "private" | "public";
+type NewsletterDomainStatus = "pending" | "verifying" | "verified" | "failed" | "disabled";
+type NewsletterDomainRecordStatus = "pending" | "verified" | "failed";
+type NewsletterPreflightStatus = "not_run" | "passed" | "warning" | "failed";
+type NewsletterPreflightItemStatus = "pass" | "warn" | "fail";
+type NewsletterTestSendStatus = "pending" | "sent" | "failed";
+type NewsletterAssetKind = "image" | "video";
+type NewsletterUrlSource = "href" | "image_src" | "video_href" | "text";
+type NewsletterChangelogTone = "concise" | "friendly" | "technical";
+type NewsletterCalloutVariant = "accent" | "info" | "warning" | "success";
+type NewsletterColumnRatio = "50-50" | "33-67" | "67-33";
+type NewsletterDomain = {
+    readonly object: "newsletter_domain";
+    readonly id: string;
+    readonly root_domain_id: string;
+    readonly domain_name: string;
+    readonly from_local_part: string;
+    readonly from_address: string;
+    readonly mail_from_domain: string;
+    readonly reply_to_mailbox_id: string | null;
+    readonly status: NewsletterDomainStatus;
+    readonly dkim_status: NewsletterDomainRecordStatus;
+    readonly mail_from_status: NewsletterDomainRecordStatus;
+    readonly spf_status: NewsletterDomainRecordStatus;
+    readonly dmarc_status: NewsletterDomainRecordStatus;
+    readonly verified_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type Newsletter = {
+    readonly object: "newsletter";
+    readonly id: string;
+    readonly audience_id: string | null;
+    readonly newsletter_domain_id: string;
+    readonly reply_to_mailbox_id: string | null;
+    readonly name: string;
+    readonly subject: string | null;
+    readonly preview_text: string | null;
+    readonly from_name: string | null;
+    readonly from_address: string;
+    readonly reply_to_address: string | null;
+    readonly blocks: readonly NewsletterBlock[] | null;
+    readonly body_html: string | null;
+    readonly body_text: string | null;
+    readonly status: NewsletterStatus;
+    readonly archive_visibility: NewsletterArchiveVisibility;
+    readonly preflight_status: NewsletterPreflightStatus;
+    readonly preflight_results: Record<string, unknown>;
+    readonly send_window_hours: number;
+    readonly send_rate_per_hour: number;
+    readonly recipient_count: number;
+    readonly sent_count: number;
+    readonly delivered_count: number;
+    readonly bounced_count: number;
+    readonly complained_count: number;
+    readonly failed_count: number;
+    readonly skipped_count: number;
+    readonly last_test_sent_at: string | null;
+    readonly last_test_recipient: string | null;
+    readonly content_changed_since_test_send: boolean;
+    readonly scheduled_at: string | null;
+    readonly approved_at: string | null;
+    readonly started_at: string | null;
+    readonly completed_at: string | null;
+    readonly cancelled_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type NewsletterPreflightItem = {
+    readonly key: string;
+    readonly label: string;
+    readonly status: NewsletterPreflightItemStatus;
+    readonly message: string;
+};
+type NewsletterPreflight = {
+    readonly object: "newsletter_preflight";
+    readonly newsletter_id: string;
+    readonly status: NewsletterPreflightStatus;
+    readonly items: readonly NewsletterPreflightItem[];
+    readonly url_breakdown: NewsletterUrlBreakdown;
+};
+type NewsletterCountedUrl = {
+    readonly url: string;
+    readonly source: NewsletterUrlSource;
+};
+type NewsletterUrlBreakdown = {
+    readonly href_count: number;
+    readonly image_src_count: number;
+    readonly video_href_count: number;
+    readonly text_url_count: number;
+    readonly unique_url_count: number;
+    readonly max_unique_urls: number;
+    readonly urls: readonly NewsletterCountedUrl[];
+    readonly offending_urls: readonly string[];
+};
+type NewsletterPreview = {
+    readonly object: "newsletter_preview";
+    readonly newsletter_id: string;
+    readonly html: string;
+    readonly archive_html: string;
+    readonly text: string;
+    readonly warnings: readonly {
+        readonly kind: string;
+        readonly severity: "fail" | "warn";
+        readonly message: string;
+    }[];
+    readonly url_breakdown: NewsletterUrlBreakdown;
+};
+type NewsletterTestSend = {
+    readonly object: "newsletter_test_send";
+    readonly id: string;
+    readonly newsletter_id: string;
+    readonly message_id: string | null;
+    readonly recipient_email: string;
+    readonly status: NewsletterTestSendStatus;
+    readonly last_error: string | null;
+    readonly sent_at: string | null;
+    readonly created_at: string;
+};
+type CreateNewsletterParams = {
+    readonly audience_id: string;
+    readonly newsletter_domain_id: string;
+    readonly name: string;
+    readonly subject: string;
+    readonly preview_text?: string | null | undefined;
+    readonly from_name?: string | null | undefined;
+    readonly body_html?: string | null | undefined;
+    readonly body_text?: string | null | undefined;
+    readonly blocks?: readonly NewsletterBlock[] | undefined;
+    readonly send_window_hours?: number | undefined;
+    readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+};
+type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
+type NewsletterChangelogMedia = {
+    readonly kind: "image";
+    readonly url: string;
+    readonly alt: string;
+    readonly caption?: string | null | undefined;
+    readonly link_url?: string | null | undefined;
+} | {
+    readonly kind: "video";
+    readonly video_url: string;
+    readonly thumbnail_url: string;
+    readonly label: string;
+};
+type NewsletterChangelogEntry = {
+    readonly title: string;
+    readonly body?: string | null | undefined;
+    readonly url?: string | null | undefined;
+    readonly media?: readonly NewsletterChangelogMedia[] | undefined;
+    readonly cta_label?: string | null | undefined;
+    readonly cta_url?: string | null | undefined;
+};
+type CreateNewsletterFromChangelogParams = {
+    readonly audience_id: string;
+    readonly newsletter_domain_id: string;
+    readonly name: string;
+    readonly subject: string;
+    readonly preview_text?: string | null | undefined;
+    readonly from_name?: string | null | undefined;
+    readonly tone?: NewsletterChangelogTone | undefined;
+    readonly entries: readonly NewsletterChangelogEntry[];
+    readonly final_cta?: {
+        readonly label: string;
+        readonly url: string;
+        readonly body?: string | null | undefined;
+    } | undefined;
+    readonly send_window_hours?: number | undefined;
+    readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+};
+type ListNewsletterDomainsParams = PaginationParams;
+type ListNewslettersParams = PaginationParams;
+type ListNewsletterAssetsParams = PaginationParams & {
+    readonly kind?: NewsletterAssetKind | undefined;
+    readonly q?: string | undefined;
+};
+type NewsletterAsset = {
+    readonly object: "newsletter_asset";
+    readonly id: string;
+    readonly kind: NewsletterAssetKind;
+    readonly filename: string;
+    readonly content_type: string;
+    readonly byte_size: number;
+    readonly checksum_sha256: string;
+    readonly url: string;
+    readonly image_url: string | null;
+    readonly video_url: string | null;
+    readonly thumbnail_url: string | null;
+    readonly thumbnail_content_type: string | null;
+    readonly thumbnail_byte_size: number | null;
+    readonly duration_seconds: number | null;
+    readonly width: number | null;
+    readonly height: number | null;
+    readonly created_at: string;
+};
+type UploadNewsletterAssetParams = {
+    readonly filename: string;
+    readonly data: ArrayBuffer | Uint8Array;
+    readonly content_type?: string | undefined;
+};
+type SendNewsletterTestParams = {
+    readonly recipient_email: string;
+};
+type ScheduleNewsletterParams = {
+    readonly scheduled_at: string;
+};
+type NewsletterColumnContent = {
+    readonly title?: string | null | undefined;
+    readonly body: string;
+    readonly image_url?: string | null | undefined;
+    readonly image_alt?: string | null | undefined;
+    readonly cta_label?: string | null | undefined;
+    readonly cta_url?: string | null | undefined;
+};
+type NewsletterBlock = {
+    readonly type: "heading";
+    readonly text: string;
+    readonly level?: 1 | 2 | 3 | undefined;
+} | {
+    readonly type: "paragraph";
+    readonly body: string;
+} | {
+    readonly type: "list";
+    readonly ordered?: boolean | undefined;
+    readonly items: readonly string[];
+} | {
+    readonly type: "callout";
+    readonly title?: string | null | undefined;
+    readonly body: string;
+    readonly variant?: NewsletterCalloutVariant | undefined;
+} | {
+    readonly type: "button";
+    readonly label: string;
+    readonly url: string;
+} | {
+    readonly type: "image";
+    readonly url: string;
+    readonly alt: string;
+    readonly link_url?: string | null | undefined;
+    readonly caption?: string | null | undefined;
+    readonly caption_url?: string | null | undefined;
+} | {
+    readonly type: "video";
+    readonly video_url: string;
+    readonly thumbnail_url: string;
+    readonly label: string;
+} | {
+    readonly type: "columns";
+    readonly ratio?: NewsletterColumnRatio | undefined;
+    readonly left: NewsletterColumnContent;
+    readonly right: NewsletterColumnContent;
+} | {
+    readonly type: "link_list";
+    readonly title?: string | null | undefined;
+    readonly items: readonly {
+        readonly label: string;
+        readonly url: string;
+        readonly description?: string | null | undefined;
+    }[];
+} | {
+    readonly type: "quote";
+    readonly body: string;
+    readonly cite?: string | null | undefined;
+} | {
+    readonly type: "divider";
+} | {
+    readonly type: "spacer";
+    readonly height?: number | undefined;
+} | {
+    readonly type: "code";
+    readonly code: string;
+} | {
+    readonly type: "custom_html";
+    readonly html: string;
+};
+
+declare class NewsletterDomains extends ApiResource {
+    list(params?: ListNewsletterDomainsParams, options?: MethodOptions): Promise<PaginatedResponse<NewsletterDomain>>;
+    listAutoPaginating(params?: Omit<ListNewsletterDomainsParams, "cursor">): Page<NewsletterDomain>;
+}
+declare class NewsletterAssets extends ApiResource {
+    list(params?: ListNewsletterAssetsParams, options?: MethodOptions): Promise<PaginatedResponse<NewsletterAsset>>;
+    listAutoPaginating(params?: Omit<ListNewsletterAssetsParams, "cursor">): Page<NewsletterAsset>;
+    upload(params: UploadNewsletterAssetParams, options?: MethodOptions): Promise<NewsletterAsset>;
+}
+declare class Newsletters extends ApiResource {
+    readonly domains: NewsletterDomains;
+    readonly assets: NewsletterAssets;
+    constructor(client: ShipMailClient);
+    create(params: CreateNewsletterParams, options?: MethodOptions): Promise<Newsletter>;
+    createFromChangelog(params: CreateNewsletterFromChangelogParams, options?: MethodOptions): Promise<Newsletter>;
+    list(params?: ListNewslettersParams, options?: MethodOptions): Promise<PaginatedResponse<Newsletter>>;
+    listAutoPaginating(params?: Omit<ListNewslettersParams, "cursor">): Page<Newsletter>;
+    get(id: string, options?: MethodOptions): Promise<Newsletter>;
+    update(id: string, params: UpdateNewsletterParams, options?: MethodOptions): Promise<Newsletter>;
+    preflight(id: string, options?: MethodOptions): Promise<NewsletterPreflight>;
+    preview(id: string, options?: MethodOptions): Promise<NewsletterPreview>;
+    sendTest(id: string, params: SendNewsletterTestParams, options?: MethodOptions): Promise<NewsletterTestSend>;
+    schedule(id: string, params: ScheduleNewsletterParams, options?: MethodOptions): Promise<Newsletter>;
+    cancel(id: string, options?: MethodOptions): Promise<Newsletter>;
+    resume(id: string, options?: MethodOptions): Promise<Newsletter>;
+}
+
 declare class Status extends ApiResource {
     get(options?: MethodOptions): Promise<StatusResponse>;
 }
@@ -806,7 +1111,7 @@ type RequestOptions = {
     readonly path: string;
     readonly body?: unknown | undefined;
     readonly query?: Record<string, string | number | boolean | undefined> | undefined;
-    readonly rawBody?: ArrayBuffer | undefined;
+    readonly rawBody?: ArrayBuffer | Uint8Array | undefined;
     readonly contentType?: string | undefined;
     readonly methodOptions?: MethodOptions | undefined;
 };
@@ -824,6 +1129,7 @@ declare class ShipMailClient {
     readonly domains: Domains;
     readonly mailboxes: Mailboxes;
     readonly messages: Messages;
+    readonly newsletters: Newsletters;
     readonly suppressions: Suppressions;
     readonly threads: Threads;
     readonly webhooks: Webhooks;
@@ -861,12 +1167,14 @@ declare class ValidationError extends ShipMailError {
     readonly details: readonly {
         readonly field: string;
         readonly message: string;
+        readonly code?: string | undefined;
     }[] | undefined;
     constructor(message: string, options?: {
         readonly requestId?: string | undefined;
         readonly details?: readonly {
             readonly field: string;
             readonly message: string;
+            readonly code?: string | undefined;
         }[] | undefined;
     });
 }
@@ -910,4 +1218,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, ConflictError, ConnectionError, type CreateAudienceParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateWebhookParams, DOMAIN_STATUSES, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type RegisterDomainParams, type RegistrationContact, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SearchDomainsParams, type SendMessageParams, 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 UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };
+export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, ConflictError, ConnectionError, type CreateAudienceParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, DOMAIN_STATUSES, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterBlock, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type RegisterDomainParams, type RegistrationContact, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };