shipmail 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,346 @@
+declare class Page<T> implements AsyncIterable<T> {
+    private readonly client;
+    private readonly path;
+    private readonly query;
+    constructor(client: ShipMailClient, path: string, query: Record<string, string | number | boolean | undefined>);
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+}
+
+declare abstract class ApiResource {
+    protected readonly client: ShipMailClient;
+    constructor(client: ShipMailClient);
+}
+
+type ShipMailConfig = {
+    readonly apiKey: string;
+    readonly baseUrl?: string | undefined;
+    readonly maxRetries?: number | undefined;
+    readonly timeout?: number | undefined;
+    readonly fetch?: typeof fetch | undefined;
+};
+type PaginationParams = {
+    readonly cursor?: string | undefined;
+    readonly limit?: number | undefined;
+};
+type PaginatedResponse<T> = {
+    readonly data: readonly T[];
+    readonly pagination: {
+        readonly next_cursor: string | null;
+        readonly has_more: boolean;
+    };
+};
+type ErrorType = "validation_error" | "authentication_error" | "authorization_error" | "not_found" | "rate_limit_error" | "conflict" | "internal_error";
+type ApiErrorBody = {
+    readonly error: {
+        readonly type: ErrorType;
+        readonly message: string;
+        readonly request_id?: string | undefined;
+        readonly details?: readonly {
+            readonly field: string;
+            readonly message: string;
+        }[] | undefined;
+        readonly retry_after?: number | undefined;
+    };
+};
+type EmailRecipient = {
+    readonly address: string;
+    readonly name?: string | null | undefined;
+};
+declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.queued", "message.sent", "message.delivered", "message.bounced", "message.complained", "domain.verified", "domain.verification_failed", "domain.degraded"];
+type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
+type StatusResponse = {
+    readonly status: string;
+    readonly version: string;
+    readonly time: string;
+    readonly request_id: string;
+};
+
+type Domain = {
+    readonly id: string;
+    readonly name: string;
+    readonly status: string;
+    readonly dns_provider: string | null;
+    readonly ownership_verified: boolean;
+    readonly mx_verified: boolean;
+    readonly spf_verified: boolean;
+    readonly dkim_verified: boolean;
+    readonly dmarc_verified: boolean;
+    readonly ses_verified: boolean;
+    readonly catch_all_mailbox_id: string | null;
+    readonly verified_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateDomainParams = {
+    readonly name: string;
+};
+type UpdateDomainParams = {
+    readonly catch_all_mailbox_id?: string | null | undefined;
+};
+type ListDomainsParams = PaginationParams;
+type DomainVerificationResult = {
+    readonly all_verified: boolean;
+    readonly records: {
+        readonly ownership: boolean;
+        readonly mx: boolean;
+        readonly spf: boolean;
+        readonly dkim: boolean;
+        readonly dmarc: boolean;
+    };
+    readonly ses_verified: boolean;
+    readonly ses_error: boolean;
+    readonly existing_spf: string | null;
+    readonly suggested_spf: string | null;
+    readonly conflicting_mx: readonly string[];
+};
+
+declare class Domains extends ApiResource {
+    create(params: CreateDomainParams): Promise<Domain>;
+    list(params?: ListDomainsParams): Promise<PaginatedResponse<Domain>>;
+    listAutoPaginating(params?: Omit<ListDomainsParams, "cursor">): Page<Domain>;
+    get(id: string): Promise<Domain>;
+    update(id: string, params: UpdateDomainParams): Promise<Domain>;
+    delete(id: string): Promise<void>;
+    verify(id: string): Promise<DomainVerificationResult>;
+}
+
+type Mailbox = {
+    readonly id: string;
+    readonly domain_id: string;
+    readonly address: string;
+    readonly display_name: string | null;
+    readonly avatar_url: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateMailboxParams = {
+    readonly domain_id: string;
+    readonly address: string;
+    readonly display_name?: string | undefined;
+};
+type UpdateMailboxParams = {
+    readonly display_name?: string | null | undefined;
+};
+type ListMailboxesParams = PaginationParams & {
+    readonly domain_id?: string | undefined;
+};
+type UploadAvatarResponse = {
+    readonly avatar_url: string;
+};
+
+declare class Mailboxes extends ApiResource {
+    create(params: CreateMailboxParams): Promise<Mailbox>;
+    list(params?: ListMailboxesParams): Promise<PaginatedResponse<Mailbox>>;
+    listAutoPaginating(params?: Omit<ListMailboxesParams, "cursor">): Page<Mailbox>;
+    get(id: string): Promise<Mailbox>;
+    update(id: string, params: UpdateMailboxParams): Promise<Mailbox>;
+    delete(id: string): Promise<void>;
+    uploadAvatar(id: string, data: ArrayBuffer, contentType: string): Promise<UploadAvatarResponse>;
+    deleteAvatar(id: string): Promise<void>;
+}
+
+type Message = {
+    readonly id: string;
+    readonly mailbox_id: string;
+    readonly thread_id: string | null;
+    readonly source: string;
+    readonly status: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type SendMessageParams = {
+    readonly mailbox_id: string;
+    readonly to: readonly EmailRecipient[];
+    readonly cc?: readonly EmailRecipient[] | undefined;
+    readonly bcc?: readonly EmailRecipient[] | undefined;
+    readonly reply_to?: EmailRecipient | undefined;
+    readonly subject: string;
+    readonly body_html?: string | undefined;
+    readonly body_text?: string | undefined;
+    readonly in_reply_to?: string | undefined;
+    readonly references?: readonly string[] | undefined;
+};
+
+declare class Messages extends ApiResource {
+    send(params: SendMessageParams): Promise<Message>;
+    get(id: string): Promise<Message>;
+}
+
+declare class Status extends ApiResource {
+    get(): Promise<StatusResponse>;
+}
+
+type ListThreadsParams = PaginationParams & {
+    readonly mailbox_id: string;
+};
+type GetThreadParams = PaginationParams;
+type ReplyToThreadParams = {
+    readonly body_html?: string | undefined;
+    readonly body_text?: string | undefined;
+    readonly to?: readonly EmailRecipient[] | undefined;
+    readonly cc?: readonly EmailRecipient[] | undefined;
+};
+
+declare class Threads extends ApiResource {
+    list(params: ListThreadsParams): Promise<PaginatedResponse<Message>>;
+    listAutoPaginating(params: Omit<ListThreadsParams, "cursor">): Page<Message>;
+    get(id: string, params?: GetThreadParams): Promise<PaginatedResponse<Message>>;
+    reply(id: string, params: ReplyToThreadParams): Promise<Message>;
+}
+
+type Webhook = {
+    readonly id: string;
+    readonly url: string;
+    readonly events: readonly string[];
+    readonly active: boolean;
+    readonly description: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type WebhookWithSecret = Webhook & {
+    readonly secret: string;
+};
+type CreateWebhookParams = {
+    readonly url: string;
+    readonly events: readonly WebhookEventType[];
+    readonly description?: string | undefined;
+};
+type UpdateWebhookParams = {
+    readonly url?: string | undefined;
+    readonly events?: readonly WebhookEventType[] | undefined;
+    readonly description?: string | null | undefined;
+    readonly active?: boolean | undefined;
+};
+type ListWebhooksParams = PaginationParams;
+type RotateSecretResponse = {
+    readonly secret: string;
+    readonly previous_secret_expires_at: string;
+};
+type TestWebhookResponse = {
+    readonly event_id: string;
+};
+type WebhookDelivery = {
+    readonly id: string;
+    readonly event_id: string;
+    readonly event_type: string;
+    readonly status: string;
+    readonly attempts: number;
+    readonly last_status_code: number | null;
+    readonly last_error: string | null;
+    readonly created_at: string;
+    readonly delivered_at: string | null;
+};
+type ListDeliveriesParams = PaginationParams & {
+    readonly status?: string | undefined;
+    readonly event_type?: string | undefined;
+};
+type WebhookEvent<T = unknown> = {
+    readonly event_id: string;
+    readonly event_type: WebhookEventType;
+    readonly created_at: string;
+    readonly data: T;
+};
+
+declare class Webhooks extends ApiResource {
+    create(params: CreateWebhookParams): Promise<WebhookWithSecret>;
+    list(params?: ListWebhooksParams): Promise<PaginatedResponse<Webhook>>;
+    listAutoPaginating(params?: Omit<ListWebhooksParams, "cursor">): Page<Webhook>;
+    get(id: string): Promise<Webhook>;
+    update(id: string, params: UpdateWebhookParams): Promise<Webhook>;
+    delete(id: string): Promise<void>;
+    rotateSecret(id: string): Promise<RotateSecretResponse>;
+    test(id: string): Promise<TestWebhookResponse>;
+    listDeliveries(id: string, params?: ListDeliveriesParams): Promise<PaginatedResponse<WebhookDelivery>>;
+    listDeliveriesAutoPaginating(id: string, params?: Omit<ListDeliveriesParams, "cursor">): Page<WebhookDelivery>;
+}
+
+type RequestOptions = {
+    readonly method: string;
+    readonly path: string;
+    readonly body?: unknown | undefined;
+    readonly query?: Record<string, string | number | boolean | undefined> | undefined;
+    readonly rawBody?: ArrayBuffer | undefined;
+    readonly contentType?: string | undefined;
+};
+declare class ShipMailClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly maxRetries;
+    private readonly timeout;
+    private readonly fetchFn;
+    readonly domains: Domains;
+    readonly mailboxes: Mailboxes;
+    readonly messages: Messages;
+    readonly threads: Threads;
+    readonly webhooks: Webhooks;
+    readonly status: Status;
+    constructor(config: string | ShipMailConfig);
+    request<T>(options: RequestOptions): Promise<T>;
+    private buildUrl;
+}
+
+declare class ShipMailError extends Error {
+    readonly status: number | undefined;
+    readonly type: ErrorType | undefined;
+    readonly requestId: string | undefined;
+    readonly retryable: boolean;
+    constructor(message: string, options?: {
+        readonly status?: number | undefined;
+        readonly type?: ErrorType | undefined;
+        readonly requestId?: string | undefined;
+        readonly retryable?: boolean | undefined;
+    });
+}
+declare class AuthenticationError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class AuthorizationError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class ValidationError extends ShipMailError {
+    readonly details: readonly {
+        readonly field: string;
+        readonly message: string;
+    }[] | undefined;
+    constructor(message: string, options?: {
+        readonly requestId?: string | undefined;
+        readonly details?: readonly {
+            readonly field: string;
+            readonly message: string;
+        }[] | undefined;
+    });
+}
+declare class NotFoundError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class RateLimitError extends ShipMailError {
+    readonly retryAfter: number | undefined;
+    constructor(message: string, options?: {
+        readonly requestId?: string | undefined;
+        readonly retryAfter?: number | undefined;
+    });
+}
+declare class ConflictError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class InternalServerError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class ConnectionError extends ShipMailError {
+    constructor(message: string);
+}
+declare class WebhookVerificationError extends ShipMailError {
+    constructor(message: string);
+}
+
+type WebhookHeaders = {
+    readonly "x-shipmail-signature"?: string;
+    readonly "x-shipmail-timestamp"?: string;
+    readonly "x-shipmail-event-id"?: string;
+    readonly [key: string]: string | undefined;
+};
+declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers, secret: string, options?: {
+    readonly toleranceInSeconds?: number | undefined;
+}): WebhookEvent;
+
+export { type ApiErrorBody, AuthenticationError, AuthorizationError, ConflictError, ConnectionError, type CreateDomainParams, type CreateMailboxParams, type CreateWebhookParams, type Domain, type DomainVerificationResult, type EmailRecipient, type ErrorType, type GetThreadParams, InternalServerError, type ListDeliveriesParams, type ListDomainsParams, type ListMailboxesParams, type ListThreadsParams, type ListWebhooksParams, type Message, NotFoundError, Page, type PaginatedResponse, type PaginationParams, RateLimitError, type ReplyToThreadParams, type RotateSecretResponse, type SendMessageParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type TestWebhookResponse, type UpdateDomainParams, type UpdateMailboxParams, type UpdateWebhookParams, type UploadAvatarResponse, ValidationError, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };

package/dist/index.d.ts

@@ -0,0 +1,346 @@
+declare class Page<T> implements AsyncIterable<T> {
+    private readonly client;
+    private readonly path;
+    private readonly query;
+    constructor(client: ShipMailClient, path: string, query: Record<string, string | number | boolean | undefined>);
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+}
+
+declare abstract class ApiResource {
+    protected readonly client: ShipMailClient;
+    constructor(client: ShipMailClient);
+}
+
+type ShipMailConfig = {
+    readonly apiKey: string;
+    readonly baseUrl?: string | undefined;
+    readonly maxRetries?: number | undefined;
+    readonly timeout?: number | undefined;
+    readonly fetch?: typeof fetch | undefined;
+};
+type PaginationParams = {
+    readonly cursor?: string | undefined;
+    readonly limit?: number | undefined;
+};
+type PaginatedResponse<T> = {
+    readonly data: readonly T[];
+    readonly pagination: {
+        readonly next_cursor: string | null;
+        readonly has_more: boolean;
+    };
+};
+type ErrorType = "validation_error" | "authentication_error" | "authorization_error" | "not_found" | "rate_limit_error" | "conflict" | "internal_error";
+type ApiErrorBody = {
+    readonly error: {
+        readonly type: ErrorType;
+        readonly message: string;
+        readonly request_id?: string | undefined;
+        readonly details?: readonly {
+            readonly field: string;
+            readonly message: string;
+        }[] | undefined;
+        readonly retry_after?: number | undefined;
+    };
+};
+type EmailRecipient = {
+    readonly address: string;
+    readonly name?: string | null | undefined;
+};
+declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.queued", "message.sent", "message.delivered", "message.bounced", "message.complained", "domain.verified", "domain.verification_failed", "domain.degraded"];
+type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
+type StatusResponse = {
+    readonly status: string;
+    readonly version: string;
+    readonly time: string;
+    readonly request_id: string;
+};
+
+type Domain = {
+    readonly id: string;
+    readonly name: string;
+    readonly status: string;
+    readonly dns_provider: string | null;
+    readonly ownership_verified: boolean;
+    readonly mx_verified: boolean;
+    readonly spf_verified: boolean;
+    readonly dkim_verified: boolean;
+    readonly dmarc_verified: boolean;
+    readonly ses_verified: boolean;
+    readonly catch_all_mailbox_id: string | null;
+    readonly verified_at: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateDomainParams = {
+    readonly name: string;
+};
+type UpdateDomainParams = {
+    readonly catch_all_mailbox_id?: string | null | undefined;
+};
+type ListDomainsParams = PaginationParams;
+type DomainVerificationResult = {
+    readonly all_verified: boolean;
+    readonly records: {
+        readonly ownership: boolean;
+        readonly mx: boolean;
+        readonly spf: boolean;
+        readonly dkim: boolean;
+        readonly dmarc: boolean;
+    };
+    readonly ses_verified: boolean;
+    readonly ses_error: boolean;
+    readonly existing_spf: string | null;
+    readonly suggested_spf: string | null;
+    readonly conflicting_mx: readonly string[];
+};
+
+declare class Domains extends ApiResource {
+    create(params: CreateDomainParams): Promise<Domain>;
+    list(params?: ListDomainsParams): Promise<PaginatedResponse<Domain>>;
+    listAutoPaginating(params?: Omit<ListDomainsParams, "cursor">): Page<Domain>;
+    get(id: string): Promise<Domain>;
+    update(id: string, params: UpdateDomainParams): Promise<Domain>;
+    delete(id: string): Promise<void>;
+    verify(id: string): Promise<DomainVerificationResult>;
+}
+
+type Mailbox = {
+    readonly id: string;
+    readonly domain_id: string;
+    readonly address: string;
+    readonly display_name: string | null;
+    readonly avatar_url: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type CreateMailboxParams = {
+    readonly domain_id: string;
+    readonly address: string;
+    readonly display_name?: string | undefined;
+};
+type UpdateMailboxParams = {
+    readonly display_name?: string | null | undefined;
+};
+type ListMailboxesParams = PaginationParams & {
+    readonly domain_id?: string | undefined;
+};
+type UploadAvatarResponse = {
+    readonly avatar_url: string;
+};
+
+declare class Mailboxes extends ApiResource {
+    create(params: CreateMailboxParams): Promise<Mailbox>;
+    list(params?: ListMailboxesParams): Promise<PaginatedResponse<Mailbox>>;
+    listAutoPaginating(params?: Omit<ListMailboxesParams, "cursor">): Page<Mailbox>;
+    get(id: string): Promise<Mailbox>;
+    update(id: string, params: UpdateMailboxParams): Promise<Mailbox>;
+    delete(id: string): Promise<void>;
+    uploadAvatar(id: string, data: ArrayBuffer, contentType: string): Promise<UploadAvatarResponse>;
+    deleteAvatar(id: string): Promise<void>;
+}
+
+type Message = {
+    readonly id: string;
+    readonly mailbox_id: string;
+    readonly thread_id: string | null;
+    readonly source: string;
+    readonly status: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type SendMessageParams = {
+    readonly mailbox_id: string;
+    readonly to: readonly EmailRecipient[];
+    readonly cc?: readonly EmailRecipient[] | undefined;
+    readonly bcc?: readonly EmailRecipient[] | undefined;
+    readonly reply_to?: EmailRecipient | undefined;
+    readonly subject: string;
+    readonly body_html?: string | undefined;
+    readonly body_text?: string | undefined;
+    readonly in_reply_to?: string | undefined;
+    readonly references?: readonly string[] | undefined;
+};
+
+declare class Messages extends ApiResource {
+    send(params: SendMessageParams): Promise<Message>;
+    get(id: string): Promise<Message>;
+}
+
+declare class Status extends ApiResource {
+    get(): Promise<StatusResponse>;
+}
+
+type ListThreadsParams = PaginationParams & {
+    readonly mailbox_id: string;
+};
+type GetThreadParams = PaginationParams;
+type ReplyToThreadParams = {
+    readonly body_html?: string | undefined;
+    readonly body_text?: string | undefined;
+    readonly to?: readonly EmailRecipient[] | undefined;
+    readonly cc?: readonly EmailRecipient[] | undefined;
+};
+
+declare class Threads extends ApiResource {
+    list(params: ListThreadsParams): Promise<PaginatedResponse<Message>>;
+    listAutoPaginating(params: Omit<ListThreadsParams, "cursor">): Page<Message>;
+    get(id: string, params?: GetThreadParams): Promise<PaginatedResponse<Message>>;
+    reply(id: string, params: ReplyToThreadParams): Promise<Message>;
+}
+
+type Webhook = {
+    readonly id: string;
+    readonly url: string;
+    readonly events: readonly string[];
+    readonly active: boolean;
+    readonly description: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+type WebhookWithSecret = Webhook & {
+    readonly secret: string;
+};
+type CreateWebhookParams = {
+    readonly url: string;
+    readonly events: readonly WebhookEventType[];
+    readonly description?: string | undefined;
+};
+type UpdateWebhookParams = {
+    readonly url?: string | undefined;
+    readonly events?: readonly WebhookEventType[] | undefined;
+    readonly description?: string | null | undefined;
+    readonly active?: boolean | undefined;
+};
+type ListWebhooksParams = PaginationParams;
+type RotateSecretResponse = {
+    readonly secret: string;
+    readonly previous_secret_expires_at: string;
+};
+type TestWebhookResponse = {
+    readonly event_id: string;
+};
+type WebhookDelivery = {
+    readonly id: string;
+    readonly event_id: string;
+    readonly event_type: string;
+    readonly status: string;
+    readonly attempts: number;
+    readonly last_status_code: number | null;
+    readonly last_error: string | null;
+    readonly created_at: string;
+    readonly delivered_at: string | null;
+};
+type ListDeliveriesParams = PaginationParams & {
+    readonly status?: string | undefined;
+    readonly event_type?: string | undefined;
+};
+type WebhookEvent<T = unknown> = {
+    readonly event_id: string;
+    readonly event_type: WebhookEventType;
+    readonly created_at: string;
+    readonly data: T;
+};
+
+declare class Webhooks extends ApiResource {
+    create(params: CreateWebhookParams): Promise<WebhookWithSecret>;
+    list(params?: ListWebhooksParams): Promise<PaginatedResponse<Webhook>>;
+    listAutoPaginating(params?: Omit<ListWebhooksParams, "cursor">): Page<Webhook>;
+    get(id: string): Promise<Webhook>;
+    update(id: string, params: UpdateWebhookParams): Promise<Webhook>;
+    delete(id: string): Promise<void>;
+    rotateSecret(id: string): Promise<RotateSecretResponse>;
+    test(id: string): Promise<TestWebhookResponse>;
+    listDeliveries(id: string, params?: ListDeliveriesParams): Promise<PaginatedResponse<WebhookDelivery>>;
+    listDeliveriesAutoPaginating(id: string, params?: Omit<ListDeliveriesParams, "cursor">): Page<WebhookDelivery>;
+}
+
+type RequestOptions = {
+    readonly method: string;
+    readonly path: string;
+    readonly body?: unknown | undefined;
+    readonly query?: Record<string, string | number | boolean | undefined> | undefined;
+    readonly rawBody?: ArrayBuffer | undefined;
+    readonly contentType?: string | undefined;
+};
+declare class ShipMailClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly maxRetries;
+    private readonly timeout;
+    private readonly fetchFn;
+    readonly domains: Domains;
+    readonly mailboxes: Mailboxes;
+    readonly messages: Messages;
+    readonly threads: Threads;
+    readonly webhooks: Webhooks;
+    readonly status: Status;
+    constructor(config: string | ShipMailConfig);
+    request<T>(options: RequestOptions): Promise<T>;
+    private buildUrl;
+}
+
+declare class ShipMailError extends Error {
+    readonly status: number | undefined;
+    readonly type: ErrorType | undefined;
+    readonly requestId: string | undefined;
+    readonly retryable: boolean;
+    constructor(message: string, options?: {
+        readonly status?: number | undefined;
+        readonly type?: ErrorType | undefined;
+        readonly requestId?: string | undefined;
+        readonly retryable?: boolean | undefined;
+    });
+}
+declare class AuthenticationError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class AuthorizationError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class ValidationError extends ShipMailError {
+    readonly details: readonly {
+        readonly field: string;
+        readonly message: string;
+    }[] | undefined;
+    constructor(message: string, options?: {
+        readonly requestId?: string | undefined;
+        readonly details?: readonly {
+            readonly field: string;
+            readonly message: string;
+        }[] | undefined;
+    });
+}
+declare class NotFoundError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class RateLimitError extends ShipMailError {
+    readonly retryAfter: number | undefined;
+    constructor(message: string, options?: {
+        readonly requestId?: string | undefined;
+        readonly retryAfter?: number | undefined;
+    });
+}
+declare class ConflictError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class InternalServerError extends ShipMailError {
+    constructor(message: string, requestId?: string);
+}
+declare class ConnectionError extends ShipMailError {
+    constructor(message: string);
+}
+declare class WebhookVerificationError extends ShipMailError {
+    constructor(message: string);
+}
+
+type WebhookHeaders = {
+    readonly "x-shipmail-signature"?: string;
+    readonly "x-shipmail-timestamp"?: string;
+    readonly "x-shipmail-event-id"?: string;
+    readonly [key: string]: string | undefined;
+};
+declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers, secret: string, options?: {
+    readonly toleranceInSeconds?: number | undefined;
+}): WebhookEvent;
+
+export { type ApiErrorBody, AuthenticationError, AuthorizationError, ConflictError, ConnectionError, type CreateDomainParams, type CreateMailboxParams, type CreateWebhookParams, type Domain, type DomainVerificationResult, type EmailRecipient, type ErrorType, type GetThreadParams, InternalServerError, type ListDeliveriesParams, type ListDomainsParams, type ListMailboxesParams, type ListThreadsParams, type ListWebhooksParams, type Message, NotFoundError, Page, type PaginatedResponse, type PaginationParams, RateLimitError, type ReplyToThreadParams, type RotateSecretResponse, type SendMessageParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type TestWebhookResponse, type UpdateDomainParams, type UpdateMailboxParams, type UpdateWebhookParams, type UploadAvatarResponse, ValidationError, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };