resend 6.1.0 → 6.2.0-canary.0

package/dist/index.d.mts

@@ -1,10 +1,87 @@
 import * as React$1 from 'react';
 
+interface ApiKey {
+    created_at: string;
+    id: string;
+    name: string;
+}
+
+interface DomainApiOptions {
+    name: string;
+    region?: string;
+    custom_return_path?: string;
+}
+
+declare const RESEND_ERROR_CODES_BY_KEY: {
+    readonly missing_required_field: 422;
+    readonly invalid_idempotency_key: 400;
+    readonly invalid_idempotent_request: 409;
+    readonly concurrent_idempotent_requests: 409;
+    readonly invalid_access: 422;
+    readonly invalid_parameter: 422;
+    readonly invalid_region: 422;
+    readonly rate_limit_exceeded: 429;
+    readonly missing_api_key: 401;
+    readonly invalid_api_key: 403;
+    readonly invalid_from_address: 403;
+    readonly validation_error: 403;
+    readonly not_found: 404;
+    readonly method_not_allowed: 405;
+    readonly application_error: 500;
+    readonly internal_server_error: 500;
+};
+type RESEND_ERROR_CODE_KEY = keyof typeof RESEND_ERROR_CODES_BY_KEY;
+interface ErrorResponse {
+    message: string;
+    name: RESEND_ERROR_CODE_KEY;
+}
+type Tag$1 = {
+    name: string;
+    value: string;
+};
+
+interface EmailApiAttachment {
+    content?: string | Buffer;
+    filename?: string | false | undefined;
+    path?: string;
+    content_type?: string;
+    content_id?: string;
+}
+interface EmailApiOptions {
+    from: string;
+    to: string | string[];
+    subject: string;
+    region?: string;
+    headers?: Record<string, string>;
+    html?: string;
+    text?: string;
+    bcc?: string | string[];
+    cc?: string | string[];
+    reply_to?: string | string[];
+    scheduled_at?: string;
+    tags?: Tag$1[];
+    attachments?: EmailApiAttachment[];
+}
+
 interface GetOptions {
     query?: Record<string, unknown>;
     headers?: HeadersInit;
 }
 
+interface IdempotentRequest {
+    /**
+     * Unique key that ensures the same operation is not processed multiple times.
+     * Allows for safe retries without duplicating operations.
+     * If provided, will be sent as the `Idempotency-Key` header.
+     */
+    idempotencyKey?: string;
+}
+
+interface List<T> {
+    readonly object: 'list';
+    data: T[];
+}
+
 type PaginationOptions = {
     /**
      * Maximum number of items to return (1-100, default: 20)
@@ -24,6 +101,13 @@ type PaginationOptions = {
     after?: never;
 });
 
+interface PatchOptions {
+    query?: {
+        [key: string]: unknown;
+    };
+    headers?: HeadersInit;
+}
+
 interface PostOptions {
     query?: {
         [key: string]: unknown;
@@ -38,29 +122,9 @@ interface PutOptions {
     headers?: HeadersInit;
 }
 
-declare const RESEND_ERROR_CODES_BY_KEY: {
-    readonly missing_required_field: 422;
-    readonly invalid_idempotency_key: 400;
-    readonly invalid_idempotent_request: 409;
-    readonly concurrent_idempotent_requests: 409;
-    readonly invalid_access: 422;
-    readonly invalid_parameter: 422;
-    readonly invalid_region: 422;
-    readonly rate_limit_exceeded: 429;
-    readonly missing_api_key: 401;
-    readonly invalid_api_key: 403;
-    readonly invalid_from_address: 403;
-    readonly validation_error: 403;
-    readonly not_found: 404;
-    readonly method_not_allowed: 405;
-    readonly application_error: 500;
-    readonly internal_server_error: 500;
-};
-type RESEND_ERROR_CODE_KEY = keyof typeof RESEND_ERROR_CODES_BY_KEY;
-interface ErrorResponse {
-    message: string;
-    name: RESEND_ERROR_CODE_KEY;
-}
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
 
 interface CreateApiKeyOptions {
     name: string;
@@ -81,12 +145,6 @@ type CreateApiKeyResponse = {
     error: ErrorResponse;
 };
 
-interface ApiKey {
-    created_at: string;
-    id: string;
-    name: string;
-}
-
 type ListApiKeysOptions = PaginationOptions;
 type ListApiKeysResponseSuccess = {
     object: 'list';
@@ -110,6 +168,42 @@ type RemoveApiKeyResponse = {
     error: ErrorResponse;
 };
 
+interface InboundAttachment {
+    id: string;
+    filename?: string;
+    contentType: string;
+    contentDisposition: 'inline' | 'attachment';
+    contentId?: string;
+    content: string;
+}
+
+interface GetAttachmentOptions {
+    inboundId: string;
+    id: string;
+}
+interface GetAttachmentResponseSuccess {
+    object: 'attachment';
+    data: InboundAttachment;
+}
+type GetAttachmentResponse = {
+    data: GetAttachmentResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
+interface ListAttachmentsOptions {
+    inboundId: string;
+}
+type ListAttachmentsResponse = {
+    data: InboundAttachment[];
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
 interface Audience {
     created_at: string;
     id: string;
@@ -169,19 +263,6 @@ type RemoveAudiencesResponse = {
     error: ErrorResponse;
 };
 
-interface IdempotentRequest {
-    /**
-     * Unique key that ensures the same operation is not processed multiple times.
-     * Allows for safe retries without duplicating operations.
-     * If provided, will be sent as the `Idempotency-Key` header.
-     */
-    idempotencyKey?: string;
-}
-
-type RequireAtLeastOne<T> = {
-    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
-}[keyof T];
-
 interface EmailRenderOptions$1 {
     /**
      * The React component used to write the message.
@@ -340,6 +421,20 @@ type CreateBatchResponse<Options extends CreateBatchRequestOptions> = {
     error: ErrorResponse;
 };
 
+interface Broadcast {
+    id: string;
+    name: string;
+    audience_id: string | null;
+    from: string | null;
+    subject: string | null;
+    reply_to: string[] | null;
+    preview_text: string | null;
+    status: 'draft' | 'sent' | 'queued';
+    created_at: string;
+    scheduled_at: string | null;
+    sent_at: string | null;
+}
+
 interface EmailRenderOptions {
     /**
      * The React component used to write the message.
@@ -413,6 +508,43 @@ type CreateBroadcastResponse = {
     error: ErrorResponse;
 };
 
+interface GetBroadcastResponseSuccess extends Broadcast {
+    object: 'broadcast';
+}
+type GetBroadcastResponse = {
+    data: GetBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
+type ListBroadcastsOptions = PaginationOptions;
+type ListBroadcastsResponseSuccess = {
+    object: 'list';
+    has_more: boolean;
+    data: Pick<Broadcast, 'id' | 'name' | 'audience_id' | 'status' | 'created_at' | 'scheduled_at' | 'sent_at'>[];
+};
+type ListBroadcastsResponse = {
+    data: ListBroadcastsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
+interface RemoveBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
+    object: 'broadcast';
+    deleted: boolean;
+}
+type RemoveBroadcastResponse = {
+    data: RemoveBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
 interface SendBroadcastBaseOptions {
     /**
      * Schedule email to be sent later.
@@ -438,6 +570,28 @@ type SendBroadcastResponse = {
     error: ErrorResponse;
 };
 
+interface UpdateBroadcastResponseSuccess {
+    id: string;
+}
+type UpdateBroadcastOptions = {
+    name?: string;
+    audienceId?: string;
+    from?: string;
+    html?: string;
+    react?: React.ReactNode;
+    text?: string;
+    subject?: string;
+    replyTo?: string[];
+    previewText?: string;
+};
+type UpdateBroadcastResponse = {
+    data: UpdateBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
 interface Contact {
     created_at: string;
     id: string;
@@ -558,6 +712,7 @@ type UpdateContactResponse = {
 };
 
 type DomainRegion = 'us-east-1' | 'eu-west-1' | 'sa-east-1' | 'ap-northeast-1';
+type DomainNameservers = 'Amazon Route 53' | 'Cloudflare' | 'Digital Ocean' | 'GoDaddy' | 'Google Domains' | 'Namecheap' | 'Unidentified' | 'Vercel';
 type DomainStatus = 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'not_started';
 type DomainRecords = DomainSpfRecord | DomainDkimRecord;
 interface DomainSpfRecord {
@@ -674,6 +829,18 @@ type VerifyDomainsResponse = {
     error: ErrorResponse;
 };
 
+interface CancelEmailResponseSuccess {
+    object: 'email';
+    id: string;
+}
+type CancelEmailResponse = {
+    data: CancelEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
 interface GetEmailResponseSuccess {
     bcc: string[] | null;
     cc: string[] | null;
@@ -701,6 +868,54 @@ type GetEmailResponse = {
     error: ErrorResponse;
 };
 
+interface UpdateEmailOptions {
+    id: string;
+    scheduledAt: string;
+}
+interface UpdateEmailResponseSuccess {
+    id: string;
+    object: 'email';
+}
+type UpdateEmailResponse = {
+    data: UpdateEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
+interface InboundEmail {
+    id: string;
+    to: string[];
+    from: string;
+    createdAt: string;
+    subject: string;
+    bcc: string[] | null;
+    cc: string[] | null;
+    replyTo: string[] | null;
+    html: string | null;
+    text: string | null;
+    attachments: InboundEmailAttachment[];
+}
+interface InboundEmailAttachment {
+    id: string;
+    filename: string;
+    contentType: string;
+    contentId: string;
+    contentDisposition: string;
+}
+
+interface GetInboundEmailResponseSuccess extends InboundEmail {
+    object: 'inbound';
+}
+type GetInboundEmailResponse = {
+    data: GetInboundEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
+
 declare class ApiKeys {
     private readonly resend;
     constructor(resend: Resend);
@@ -709,6 +924,13 @@ declare class ApiKeys {
     remove(id: string): Promise<RemoveApiKeyResponse>;
 }
 
+declare class Attachments {
+    private readonly resend;
+    constructor(resend: Resend);
+    get(options: GetAttachmentOptions): Promise<GetAttachmentResponse>;
+    list(options: ListAttachmentsOptions): Promise<ListAttachmentsResponse>;
+}
+
 declare class Audiences {
     private readonly resend;
     constructor(resend: Resend);
@@ -725,79 +947,6 @@ declare class Batch {
     create<Options extends CreateBatchRequestOptions>(payload: CreateBatchOptions, options?: Options): Promise<CreateBatchResponse<Options>>;
 }
 
-interface Broadcast {
-    id: string;
-    name: string;
-    audience_id: string | null;
-    from: string | null;
-    subject: string | null;
-    reply_to: string[] | null;
-    preview_text: string | null;
-    status: 'draft' | 'sent' | 'queued';
-    created_at: string;
-    scheduled_at: string | null;
-    sent_at: string | null;
-}
-
-interface GetBroadcastResponseSuccess extends Broadcast {
-    object: 'broadcast';
-}
-type GetBroadcastResponse = {
-    data: GetBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
-
-type ListBroadcastsOptions = PaginationOptions;
-type ListBroadcastsResponseSuccess = {
-    object: 'list';
-    has_more: boolean;
-    data: Pick<Broadcast, 'id' | 'name' | 'audience_id' | 'status' | 'created_at' | 'scheduled_at' | 'sent_at'>[];
-};
-type ListBroadcastsResponse = {
-    data: ListBroadcastsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
-
-interface RemoveBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
-    object: 'broadcast';
-    deleted: boolean;
-}
-type RemoveBroadcastResponse = {
-    data: RemoveBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
-
-interface UpdateBroadcastResponseSuccess {
-    id: string;
-}
-type UpdateBroadcastOptions = {
-    name?: string;
-    audienceId?: string;
-    from?: string;
-    html?: string;
-    react?: React.ReactNode;
-    text?: string;
-    subject?: string;
-    replyTo?: string[];
-    previewText?: string;
-};
-type UpdateBroadcastResponse = {
-    data: UpdateBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
-
 declare class Broadcasts {
     private readonly resend;
     constructor(resend: Resend);
@@ -809,13 +958,6 @@ declare class Broadcasts {
     update(id: string, payload: UpdateBroadcastOptions): Promise<UpdateBroadcastResponse>;
 }
 
-interface PatchOptions {
-    query?: {
-        [key: string]: unknown;
-    };
-    headers?: HeadersInit;
-}
-
 declare class Contacts {
     private readonly resend;
     constructor(resend: Resend);
@@ -837,18 +979,6 @@ declare class Domains {
     verify(id: string): Promise<VerifyDomainsResponse>;
 }
 
-interface CancelEmailResponseSuccess {
-    object: 'email';
-    id: string;
-}
-type CancelEmailResponse = {
-    data: CancelEmailResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
-
 type ListEmailsOptions = PaginationOptions;
 type ListEmail = Omit<GetEmailResponseSuccess, 'html' | 'text' | 'tags' | 'object'>;
 type ListEmailsResponseSuccess = {
@@ -864,22 +994,6 @@ type ListEmailsResponse = {
     error: ErrorResponse;
 };
 
-interface UpdateEmailOptions {
-    id: string;
-    scheduledAt: string;
-}
-interface UpdateEmailResponseSuccess {
-    id: string;
-    object: 'email';
-}
-type UpdateEmailResponse = {
-    data: UpdateEmailResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
-
 declare class Emails {
     private readonly resend;
     constructor(resend: Resend);
@@ -891,16 +1005,24 @@ declare class Emails {
     cancel(id: string): Promise<CancelEmailResponse>;
 }
 
+declare class Inbound {
+    private readonly resend;
+    constructor(resend: Resend);
+    get(id: string): Promise<GetInboundEmailResponse>;
+}
+
 declare class Resend {
     readonly key?: string | undefined;
     private readonly headers;
     readonly apiKeys: ApiKeys;
+    readonly attachments: Attachments;
     readonly audiences: Audiences;
     readonly batch: Batch;
     readonly broadcasts: Broadcasts;
     readonly contacts: Contacts;
     readonly domains: Domains;
     readonly emails: Emails;
+    readonly inbound: Inbound;
     constructor(key?: string | undefined);
     fetchRequest<T>(path: string, options?: {}): Promise<{
         data: T;
@@ -946,4 +1068,4 @@ declare class Resend {
     }>;
 }
 
-export { type Attachment, type CreateApiKeyOptions, type CreateApiKeyRequestOptions, type CreateApiKeyResponse, type CreateApiKeyResponseSuccess, type CreateAudienceOptions, type CreateAudienceRequestOptions, type CreateAudienceResponse, type CreateAudienceResponseSuccess, type CreateBatchOptions, type CreateBatchRequestOptions, type CreateBatchResponse, type CreateBatchSuccessResponse, type CreateBroadcastOptions, type CreateBroadcastRequestOptions, type CreateBroadcastResponse, type CreateBroadcastResponseSuccess, type CreateContactOptions, type CreateContactRequestOptions, type CreateContactResponse, type CreateContactResponseSuccess, type CreateDomainOptions, type CreateDomainRequestOptions, type CreateDomainResponse, type CreateDomainResponseSuccess, type CreateEmailOptions, type CreateEmailRequestOptions, type CreateEmailResponse, type CreateEmailResponseSuccess, type ErrorResponse, type GetAudienceResponse, type GetAudienceResponseSuccess, type GetContactOptions, type GetContactResponse, type GetContactResponseSuccess, type GetDomainResponse, type GetDomainResponseSuccess, type GetEmailResponse, type GetEmailResponseSuccess, type ListApiKeysOptions, type ListApiKeysResponse, type ListApiKeysResponseSuccess, type ListAudiencesOptions, type ListAudiencesResponse, type ListAudiencesResponseSuccess, type ListContactsOptions, type ListContactsResponse, type ListContactsResponseSuccess, type ListDomainsOptions, type ListDomainsResponse, type ListDomainsResponseSuccess, type PaginationOptions, type RemoveApiKeyResponse, type RemoveApiKeyResponseSuccess, type RemoveAudiencesResponse, type RemoveAudiencesResponseSuccess, type RemoveContactOptions, type RemoveContactsResponse, type RemoveContactsResponseSuccess, type RemoveDomainsResponse, type RemoveDomainsResponseSuccess, Resend, type SendBroadcastOptions, type SendBroadcastRequestOptions, type SendBroadcastResponse, type SendBroadcastResponseSuccess, type Tag, type UpdateContactOptions, type UpdateContactResponse, type UpdateContactResponseSuccess, type UpdateDomainsOptions, type UpdateDomainsResponse, type UpdateDomainsResponseSuccess, type VerifyDomainsResponse, type VerifyDomainsResponseSuccess };
+export { type ApiKey, type Attachment, type Audience, type Broadcast, type CancelEmailResponse, type CancelEmailResponseSuccess, type Contact, type CreateApiKeyOptions, type CreateApiKeyRequestOptions, type CreateApiKeyResponse, type CreateApiKeyResponseSuccess, type CreateAudienceOptions, type CreateAudienceRequestOptions, type CreateAudienceResponse, type CreateAudienceResponseSuccess, type CreateBatchOptions, type CreateBatchRequestOptions, type CreateBatchResponse, type CreateBatchSuccessResponse, type CreateBroadcastOptions, type CreateBroadcastRequestOptions, type CreateBroadcastResponse, type CreateBroadcastResponseSuccess, type CreateContactOptions, type CreateContactRequestOptions, type CreateContactResponse, type CreateContactResponseSuccess, type CreateDomainOptions, type CreateDomainRequestOptions, type CreateDomainResponse, type CreateDomainResponseSuccess, type CreateEmailOptions, type CreateEmailRequestOptions, type CreateEmailResponse, type CreateEmailResponseSuccess, type Domain, type DomainApiOptions, type DomainDkimRecord, type DomainNameservers, type DomainRecords, type DomainRegion, type DomainSpfRecord, type DomainStatus, type EmailApiAttachment, type EmailApiOptions, type ErrorResponse, type GetAttachmentOptions, type GetAttachmentResponse, type GetAttachmentResponseSuccess, type GetAudienceResponse, type GetAudienceResponseSuccess, type GetBroadcastResponse, type GetBroadcastResponseSuccess, type GetContactOptions, type GetContactResponse, type GetContactResponseSuccess, type GetDomainResponse, type GetDomainResponseSuccess, type GetEmailResponse, type GetEmailResponseSuccess, type GetInboundEmailResponse, type GetInboundEmailResponseSuccess, type GetOptions, type IdempotentRequest, type InboundAttachment, type InboundEmail, type InboundEmailAttachment, type List, type ListApiKeysOptions, type ListApiKeysResponse, type ListApiKeysResponseSuccess, type ListAttachmentsOptions, type ListAttachmentsResponse, type ListAudiencesOptions, type ListAudiencesResponse, type ListAudiencesResponseSuccess, type ListBroadcastsOptions, type ListBroadcastsResponse, type ListBroadcastsResponseSuccess, type ListContactsOptions, type ListContactsResponse, type ListContactsResponseSuccess, type ListDomainsOptions, type ListDomainsResponse, type ListDomainsResponseSuccess, type PaginationOptions, type PatchOptions, type PostOptions, type PutOptions, type RemoveApiKeyResponse, type RemoveApiKeyResponseSuccess, type RemoveAudiencesResponse, type RemoveAudiencesResponseSuccess, type RemoveBroadcastResponse, type RemoveBroadcastResponseSuccess, type RemoveContactOptions, type RemoveContactsResponse, type RemoveContactsResponseSuccess, type RemoveDomainsResponse, type RemoveDomainsResponseSuccess, type RequireAtLeastOne, Resend, type SelectingField, type SendBroadcastOptions, type SendBroadcastRequestOptions, type SendBroadcastResponse, type SendBroadcastResponseSuccess, type Tag, type UpdateBroadcastOptions, type UpdateBroadcastResponse, type UpdateBroadcastResponseSuccess, type UpdateContactOptions, type UpdateContactResponse, type UpdateContactResponseSuccess, type UpdateDomainsOptions, type UpdateDomainsResponse, type UpdateDomainsResponseSuccess, type UpdateEmailOptions, type UpdateEmailResponse, type UpdateEmailResponseSuccess, type VerifyDomainsResponse, type VerifyDomainsResponseSuccess };