shipmail 0.1.23 → 0.1.25

package/dist/index.d.ts

@@ -72,6 +72,90 @@ type MethodOptions = {
     readonly idempotencyKey?: string | undefined;
 };
 
+type MergeFields = Record<string, string | number | boolean | null>;
+type SubscriberStatus = "subscribed" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
+type SubscriberOutcome = "created" | "updated" | "skipped_not_mailable" | "skipped_invalid" | "skipped_cap" | "skipped_quota";
+type Audience = {
+    readonly object: "audience";
+    readonly id: string;
+    readonly name: string;
+    readonly description: string | null;
+    readonly member_count: number;
+    readonly subscribed_count: number;
+    readonly consent_source: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type Subscriber = {
+    readonly object: "subscriber";
+    readonly id: string;
+    readonly audience_id: string;
+    readonly email_address: string;
+    readonly display_name: string | null;
+    readonly status: SubscriberStatus;
+    readonly merge_fields: MergeFields;
+    readonly consent_source: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateAudienceParams = {
+    readonly name: string;
+    readonly description?: string | null | undefined;
+    readonly consent_source: string;
+};
+type UpdateAudienceParams = {
+    readonly name?: string | undefined;
+    readonly description?: string | null | undefined;
+};
+type ListAudiencesParams = PaginationParams;
+type AddSubscriberParams = {
+    readonly email_address: string;
+    readonly display_name?: string | null | undefined;
+    readonly merge_fields?: MergeFields | undefined;
+    readonly consent_source?: string | null | undefined;
+    readonly consent_ip?: string | null | undefined;
+};
+type AddSubscribersBatchParams = {
+    readonly subscribers: readonly AddSubscriberParams[];
+};
+type UpdateSubscriberParams = {
+    readonly display_name?: string | null | undefined;
+    readonly merge_fields?: MergeFields | undefined;
+};
+type SubscriberResult = {
+    readonly email_address: string;
+    readonly outcome: SubscriberOutcome;
+};
+type AddSubscribersBatchResult = {
+    readonly results: readonly SubscriberResult[];
+};
+type ListSubscribersParams = PaginationParams & {
+    readonly status?: SubscriberStatus | undefined;
+    readonly email?: string | undefined;
+};
+
+declare class Subscribers extends ApiResource {
+    add(audienceId: string, params: AddSubscriberParams, options?: MethodOptions): Promise<SubscriberResult>;
+    addBatch(audienceId: string, params: AddSubscribersBatchParams, options?: MethodOptions): Promise<AddSubscribersBatchResult>;
+    list(audienceId: string, params?: ListSubscribersParams, options?: MethodOptions): Promise<PaginatedResponse<Subscriber>>;
+    listAutoPaginating(audienceId: string, params?: Omit<ListSubscribersParams, "cursor">): Page<Subscriber>;
+    get(audienceId: string, subscriberId: string, options?: MethodOptions): Promise<Subscriber>;
+    getByEmail(audienceId: string, email: string, options?: MethodOptions): Promise<Subscriber>;
+    update(audienceId: string, subscriberId: string, params: UpdateSubscriberParams, options?: MethodOptions): Promise<Subscriber>;
+    unsubscribe(audienceId: string, subscriberId: string, options?: MethodOptions): Promise<Subscriber>;
+    remove(audienceId: string, subscriberId: string, options?: MethodOptions): Promise<void>;
+}
+declare class Audiences extends ApiResource {
+    readonly subscribers: Subscribers;
+    constructor(client: ShipMailClient);
+    create(params: CreateAudienceParams, options?: MethodOptions): Promise<Audience>;
+    list(params?: ListAudiencesParams, options?: MethodOptions): Promise<PaginatedResponse<Audience>>;
+    listAutoPaginating(params?: Omit<ListAudiencesParams, "cursor">): Page<Audience>;
+    get(id: string, options?: MethodOptions): Promise<Audience>;
+    update(id: string, params: UpdateAudienceParams, options?: MethodOptions): Promise<Audience>;
+    delete(id: string, options?: MethodOptions): Promise<void>;
+}
+
 type Domain = {
     readonly object: "domain";
     readonly id: string;
@@ -599,6 +683,103 @@ 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 NewsletterPreflightStatus = "not_run" | "passed" | "warning" | "failed";
+type NewsletterPreflightItemStatus = "pass" | "warn" | "fail";
+type NewsletterTestSendStatus = "pending" | "sent" | "failed";
+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 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 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[];
+};
+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 send_window_hours?: number | undefined;
+    readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
+};
+type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
+type ListNewslettersParams = PaginationParams;
+type SendNewsletterTestParams = {
+    readonly recipient_email: string;
+};
+type ScheduleNewsletterParams = {
+    readonly scheduled_at: string;
+};
+
+declare class Newsletters extends ApiResource {
+    create(params: CreateNewsletterParams, 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>;
+    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>;
 }
@@ -736,9 +917,11 @@ declare class ShipMailClient {
     private readonly timeout;
     private readonly fetchFn;
     private readonly defaultHeaders;
+    readonly audiences: Audiences;
     readonly domains: Domains;
     readonly mailboxes: Mailboxes;
     readonly messages: Messages;
+    readonly newsletters: Newsletters;
     readonly suppressions: Suppressions;
     readonly threads: Threads;
     readonly webhooks: Webhooks;
@@ -825,4 +1008,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
     readonly toleranceInSeconds?: number | undefined;
 }): Promise<WebhookEvent>;
 
-export { type ApiErrorBody, AuthenticationError, AuthorizationError, ConflictError, ConnectionError, 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 ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, 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 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 Suppression, type TestWebhookResponse, type Thread, type UpdateAutoReplyParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateSpamFilterParams, 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 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 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 NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, 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, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };

package/dist/index.js

@@ -113,9 +113,9 @@ function mapErrorFromResponse(status, body, requestId) {
 
 // src/pagination.ts
 var Page = class {
-  constructor(client, path, query) {
+  constructor(client, path2, query) {
     this.client = client;
-    this.path = path;
+    this.path = path2;
     this.query = query;
   }
   async *[Symbol.asyncIterator]() {
@@ -142,6 +142,132 @@ var ApiResource = class {
   }
 };
 
+// src/resources/audiences.ts
+function base(audienceId) {
+  return `/audiences/${encodeURIComponent(audienceId)}/subscribers`;
+}
+var Subscribers = class extends ApiResource {
+  add(audienceId, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: base(audienceId),
+      body: params,
+      methodOptions: options
+    });
+  }
+  addBatch(audienceId, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${base(audienceId)}/batch`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  list(audienceId, params, options) {
+    return this.client.request({
+      method: "GET",
+      path: base(audienceId),
+      query: {
+        cursor: params?.cursor,
+        limit: params?.limit,
+        status: params?.status,
+        email: params?.email
+      },
+      methodOptions: options
+    });
+  }
+  listAutoPaginating(audienceId, params) {
+    return new Page(this.client, base(audienceId), {
+      limit: params?.limit,
+      status: params?.status,
+      email: params?.email
+    });
+  }
+  get(audienceId, subscriberId, options) {
+    return this.client.request({
+      method: "GET",
+      path: `${base(audienceId)}/${encodeURIComponent(subscriberId)}`,
+      methodOptions: options
+    });
+  }
+  getByEmail(audienceId, email, options) {
+    return this.client.request({
+      method: "GET",
+      path: `${base(audienceId)}/by-email/${encodeURIComponent(email)}`,
+      methodOptions: options
+    });
+  }
+  update(audienceId, subscriberId, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: `${base(audienceId)}/${encodeURIComponent(subscriberId)}`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  unsubscribe(audienceId, subscriberId, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${base(audienceId)}/${encodeURIComponent(subscriberId)}/unsubscribe`,
+      methodOptions: options
+    });
+  }
+  remove(audienceId, subscriberId, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `${base(audienceId)}/${encodeURIComponent(subscriberId)}`,
+      methodOptions: options
+    });
+  }
+};
+var Audiences = class extends ApiResource {
+  constructor(client) {
+    super(client);
+    this.subscribers = new Subscribers(client);
+  }
+  create(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/audiences",
+      body: params,
+      methodOptions: options
+    });
+  }
+  list(params, options) {
+    return this.client.request({
+      method: "GET",
+      path: "/audiences",
+      query: { cursor: params?.cursor, limit: params?.limit },
+      methodOptions: options
+    });
+  }
+  listAutoPaginating(params) {
+    return new Page(this.client, "/audiences", { limit: params?.limit });
+  }
+  get(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/audiences/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+  update(id, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/audiences/${encodeURIComponent(id)}`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  delete(id, options) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/audiences/${encodeURIComponent(id)}`,
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/domains.ts
 var Domains = class extends ApiResource {
   create(params, options) {
@@ -489,6 +615,84 @@ var Messages = class extends ApiResource {
   }
 };
 
+// src/resources/newsletters.ts
+function path(id) {
+  return `/newsletters/${encodeURIComponent(id)}`;
+}
+var Newsletters = class extends ApiResource {
+  create(params, options) {
+    return this.client.request({
+      method: "POST",
+      path: "/newsletters",
+      body: params,
+      methodOptions: options
+    });
+  }
+  list(params, options) {
+    return this.client.request({
+      method: "GET",
+      path: "/newsletters",
+      query: { cursor: params?.cursor, limit: params?.limit },
+      methodOptions: options
+    });
+  }
+  listAutoPaginating(params) {
+    return new Page(this.client, "/newsletters", { limit: params?.limit });
+  }
+  get(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: path(id),
+      methodOptions: options
+    });
+  }
+  update(id, params, options) {
+    return this.client.request({
+      method: "PATCH",
+      path: path(id),
+      body: params,
+      methodOptions: options
+    });
+  }
+  preflight(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/preflight`,
+      methodOptions: options
+    });
+  }
+  sendTest(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/test-send`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  schedule(id, params, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/schedule`,
+      body: params,
+      methodOptions: options
+    });
+  }
+  cancel(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/cancel`,
+      methodOptions: options
+    });
+  }
+  resume(id, options) {
+    return this.client.request({
+      method: "POST",
+      path: `${path(id)}/resume`,
+      methodOptions: options
+    });
+  }
+};
+
 // src/resources/status.ts
 var Status = class extends ApiResource {
   get(options) {
@@ -657,7 +861,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.1.23";
+var VERSION = "0.1.25";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -670,9 +874,9 @@ function calculateBackoff(attempt, retryAfterMs) {
   if (retryAfterMs !== void 0 && retryAfterMs > 0) {
     return retryAfterMs;
   }
-  const base = Math.min(2 ** attempt * 500, 8e3);
-  const jitter = Math.random() * base * 0.5;
-  return base + jitter;
+  const base2 = Math.min(2 ** attempt * 500, 8e3);
+  const jitter = Math.random() * base2 * 0.5;
+  return base2 + jitter;
 }
 function isApiErrorBody(value) {
   if (typeof value !== "object" || value === null) return false;
@@ -702,9 +906,11 @@ var ShipMailClient = class {
       this.fetchFn = config.fetch ?? globalThis.fetch;
       this.defaultHeaders = config.defaultHeaders ? { ...config.defaultHeaders } : {};
     }
+    this.audiences = new Audiences(this);
     this.domains = new Domains(this);
     this.mailboxes = new Mailboxes(this);
     this.messages = new Messages(this);
+    this.newsletters = new Newsletters(this);
     this.suppressions = new Suppressions(this);
     this.threads = new Threads(this);
     this.webhooks = new Webhooks(this);
@@ -788,8 +994,8 @@ var ShipMailClient = class {
     }
     throw lastError ?? new ShipMailError("Request failed after retries");
   }
-  buildUrl(path, query) {
-    const url = new URL(`${this.baseUrl}${path}`);
+  buildUrl(path2, query) {
+    const url = new URL(`${this.baseUrl}${path2}`);
     if (query) {
       for (const [key, value] of Object.entries(query)) {
         if (value !== void 0) {