resend 6.0.0 → 6.1.0-canary.0

package/dist/index.d.mts

@@ -16,6 +16,27 @@ interface PutOptions {
     };
 }
 
+type RateLimit = {
+    /**
+     * The maximum amount of requests that can be made in the time window of {@link shouldResetAfter}.
+     */
+    limit: number;
+    /**
+     * The amount of requests that can still be made before hitting {@link RateLimit.limit}.
+     *
+     * Resets after the seconds in {@link RateLimit.shouldResetAfter} go by.
+     */
+    remainingRequests: number;
+    /**
+     * The number of seconds after which the rate limiting will reset,
+     * and {@link RateLimit.remainingRequests} goes back to the value of
+     * {@link RateLimit.limit}.
+     *
+     * @see {@link import('./interfaces').Response.retryAfter}
+     */
+    shouldResetAfter: number;
+};
+
 declare const RESEND_ERROR_CODES_BY_KEY: {
     readonly missing_required_field: 422;
     readonly invalid_idempotency_key: 400;
@@ -35,10 +56,26 @@ declare const RESEND_ERROR_CODES_BY_KEY: {
     readonly internal_server_error: 500;
 };
 type RESEND_ERROR_CODE_KEY = keyof typeof RESEND_ERROR_CODES_BY_KEY;
-interface ErrorResponse {
+type ErrorResponse = {
     message: string;
-    name: RESEND_ERROR_CODE_KEY;
-}
+    name: Exclude<RESEND_ERROR_CODE_KEY, 'rate_limit_exceeded'>;
+} | {
+    message: string;
+    name: Extract<RESEND_ERROR_CODE_KEY, 'rate_limit_exceeded'>;
+    /**
+     * Time in seconds.
+     */
+    retryAfter: number;
+};
+type Response<Data> = {
+    data: Data;
+    rateLimiting: RateLimit;
+    error: null;
+} | {
+    data: null;
+    rateLimiting: RateLimit | null;
+    error: ErrorResponse;
+};
 
 interface CreateApiKeyOptions {
     name: string;
@@ -51,13 +88,7 @@ interface CreateApiKeyResponseSuccess {
     token: string;
     id: string;
 }
-type CreateApiKeyResponse = {
-    data: CreateApiKeyResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateApiKeyResponse = Response<CreateApiKeyResponseSuccess>;
 
 interface ApiKey {
     created_at: string;
@@ -66,22 +97,10 @@ interface ApiKey {
 }
 
 type ListApiKeysResponseSuccess = Pick<ApiKey, 'name' | 'id' | 'created_at'>[];
-type ListApiKeysResponse = {
-    data: ListApiKeysResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type ListApiKeysResponse = Response<ListApiKeysResponseSuccess>;
 
 type RemoveApiKeyResponseSuccess = {};
-type RemoveApiKeyResponse = {
-    data: RemoveApiKeyResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type RemoveApiKeyResponse = Response<RemoveApiKeyResponseSuccess>;
 
 declare class ApiKeys {
     private readonly resend;
@@ -105,48 +124,24 @@ interface CreateAudienceRequestOptions extends PostOptions {
 interface CreateAudienceResponseSuccess extends Pick<Audience, 'name' | 'id'> {
     object: 'audience';
 }
-type CreateAudienceResponse = {
-    data: CreateAudienceResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateAudienceResponse = Response<CreateAudienceResponseSuccess>;
 
 interface GetAudienceResponseSuccess extends Pick<Audience, 'id' | 'name' | 'created_at'> {
     object: 'audience';
 }
-type GetAudienceResponse = {
-    data: GetAudienceResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type GetAudienceResponse = Response<GetAudienceResponseSuccess>;
 
 type ListAudiencesResponseSuccess = {
     object: 'list';
     data: Audience[];
 };
-type ListAudiencesResponse = {
-    data: ListAudiencesResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type ListAudiencesResponse = Response<ListAudiencesResponseSuccess>;
 
 interface RemoveAudiencesResponseSuccess extends Pick<Audience, 'id'> {
     object: 'audience';
     deleted: boolean;
 }
-type RemoveAudiencesResponse = {
-    data: RemoveAudiencesResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type RemoveAudiencesResponse = Response<RemoveAudiencesResponseSuccess>;
 
 declare class Audiences {
     private readonly resend;
@@ -260,13 +255,7 @@ interface CreateEmailResponseSuccess {
     /** The ID of the newly created email. */
     id: string;
 }
-type CreateEmailResponse = {
-    data: CreateEmailResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateEmailResponse = Response<CreateEmailResponseSuccess>;
 interface Attachment {
     /** Content of an attached file. */
     content?: string | Buffer;
@@ -302,13 +291,7 @@ interface CreateBatchSuccessResponse {
         id: string;
     }[];
 }
-type CreateBatchResponse = {
-    data: CreateBatchSuccessResponse;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateBatchResponse = Response<CreateBatchSuccessResponse>;
 
 declare class Batch {
     private readonly resend;
@@ -383,13 +366,7 @@ interface CreateBroadcastResponseSuccess {
     /** The ID of the newly sent broadcasts. */
     id: string;
 }
-type CreateBroadcastResponse = {
-    data: CreateBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateBroadcastResponse = Response<CreateBroadcastResponseSuccess>;
 
 interface Broadcast {
     id: string;
@@ -408,37 +385,19 @@ interface Broadcast {
 interface GetBroadcastResponseSuccess extends Broadcast {
     object: 'broadcast';
 }
-type GetBroadcastResponse = {
-    data: GetBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type GetBroadcastResponse = Response<GetBroadcastResponseSuccess>;
 
 type ListBroadcastsResponseSuccess = {
     object: 'list';
     data: Pick<Broadcast, 'id' | 'name' | 'audience_id' | 'status' | 'created_at' | 'scheduled_at' | 'sent_at'>[];
 };
-type ListBroadcastsResponse = {
-    data: ListBroadcastsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type ListBroadcastsResponse = Response<ListBroadcastsResponseSuccess>;
 
 interface RemoveBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
     object: 'broadcast';
     deleted: boolean;
 }
-type RemoveBroadcastResponse = {
-    data: RemoveBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type RemoveBroadcastResponse = Response<RemoveBroadcastResponseSuccess>;
 
 interface SendBroadcastBaseOptions {
     /**
@@ -457,13 +416,7 @@ interface SendBroadcastResponseSuccess {
     /** The ID of the sent broadcast. */
     id: string;
 }
-type SendBroadcastResponse = {
-    data: SendBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type SendBroadcastResponse = Response<SendBroadcastResponseSuccess>;
 
 interface UpdateBroadcastResponseSuccess {
     id: string;
@@ -478,13 +431,7 @@ interface UpdateBroadcastOptions {
     replyTo?: string[];
     previewText?: string;
 }
-type UpdateBroadcastResponse = {
-    data: UpdateBroadcastResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type UpdateBroadcastResponse = Response<UpdateBroadcastResponseSuccess>;
 
 declare class Broadcasts {
     private readonly resend;
@@ -512,6 +459,33 @@ interface Contact {
     last_name?: string;
     unsubscribed: boolean;
 }
+type SelectingField = {
+    /**
+     * The contact id.
+     *
+     * @link https://resend.com/docs/api-reference/contacts/delete-contact#body-parameters
+     */
+    id: string;
+    /**
+     * The contact email.
+     *
+     * @link https://resend.com/docs/api-reference/contacts/delete-contact#body-parameters
+     */
+    email?: undefined | null;
+} | {
+    /**
+     * The contact id.
+     *
+     * @link https://resend.com/docs/api-reference/contacts/delete-contact#body-parameters
+     */
+    id?: undefined | null;
+    /**
+     * The contact email.
+     *
+     * @link https://resend.com/docs/api-reference/contacts/delete-contact#body-parameters
+     */
+    email: string;
+};
 
 interface CreateContactOptions {
     audienceId: string;
@@ -525,29 +499,15 @@ interface CreateContactRequestOptions extends PostOptions {
 interface CreateContactResponseSuccess extends Pick<Contact, 'id'> {
     object: 'contact';
 }
-type CreateContactResponse = {
-    data: CreateContactResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateContactResponse = Response<CreateContactResponseSuccess>;
 
-interface GetContactOptions {
+type GetContactOptions = {
     audienceId: string;
-    id?: string;
-    email?: string;
-}
+} & SelectingField;
 interface GetContactResponseSuccess extends Pick<Contact, 'id' | 'email' | 'created_at' | 'first_name' | 'last_name' | 'unsubscribed'> {
     object: 'contact';
 }
-type GetContactResponse = {
-    data: GetContactResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type GetContactResponse = Response<GetContactResponseSuccess>;
 
 interface ListContactsOptions {
     audienceId: string;
@@ -556,64 +516,28 @@ interface ListContactsResponseSuccess {
     object: 'list';
     data: Contact[];
 }
-type ListContactsResponse = {
-    data: ListContactsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type ListContactsResponse = Response<ListContactsResponseSuccess>;
 
 type RemoveContactsResponseSuccess = {
     object: 'contact';
     deleted: boolean;
     contact: string;
 };
-interface RemoveByOptions {
-    /**
-     * The contact id.
-     *
-     * @link https://resend.com/docs/api-reference/contacts/delete-contact#body-parameters
-     */
-    id?: string;
-    /**
-     * The contact email.
-     *
-     * @link https://resend.com/docs/api-reference/contacts/delete-contact#body-parameters
-     */
-    email?: string;
-}
-interface RemoveContactOptions extends RemoveByOptions {
+type RemoveContactOptions = SelectingField & {
     audienceId: string;
-}
-type RemoveContactsResponse = {
-    data: RemoveContactsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
 };
+type RemoveContactsResponse = Response<RemoveContactsResponseSuccess>;
 
-interface UpdateContactBaseOptions {
-    id?: string;
-    email?: string;
-}
-interface UpdateContactOptions extends UpdateContactBaseOptions {
+type UpdateContactOptions = {
     audienceId: string;
     unsubscribed?: boolean;
     firstName?: string;
     lastName?: string;
-}
+} & SelectingField;
 type UpdateContactResponseSuccess = Pick<Contact, 'id'> & {
     object: 'contact';
 };
-type UpdateContactResponse = {
-    data: UpdateContactResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type UpdateContactResponse = Response<UpdateContactResponseSuccess>;
 
 declare class Contacts {
     private readonly resend;
@@ -621,7 +545,7 @@ declare class Contacts {
     create(payload: CreateContactOptions, options?: CreateContactRequestOptions): Promise<CreateContactResponse>;
     list(options: ListContactsOptions): Promise<ListContactsResponse>;
     get(options: GetContactOptions): Promise<GetContactResponse>;
-    update(payload: UpdateContactOptions): Promise<UpdateContactResponse>;
+    update(options: UpdateContactOptions): Promise<UpdateContactResponse>;
     remove(payload: RemoveContactOptions): Promise<RemoveContactsResponse>;
 }
 
@@ -668,48 +592,24 @@ interface CreateDomainRequestOptions extends PostOptions {
 interface CreateDomainResponseSuccess extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region'> {
     records: DomainRecords[];
 }
-type CreateDomainResponse = {
-    data: CreateDomainResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CreateDomainResponse = Response<CreateDomainResponseSuccess>;
 
 interface GetDomainResponseSuccess extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status'> {
     object: 'domain';
     records: DomainRecords[];
 }
-type GetDomainResponse = {
-    data: GetDomainResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type GetDomainResponse = Response<GetDomainResponseSuccess>;
 
 type ListDomainsResponseSuccess = {
     data: Domain[];
 };
-type ListDomainsResponse = {
-    data: ListDomainsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type ListDomainsResponse = Response<ListDomainsResponseSuccess>;
 
 type RemoveDomainsResponseSuccess = Pick<Domain, 'id'> & {
     object: 'domain';
     deleted: boolean;
 };
-type RemoveDomainsResponse = {
-    data: RemoveDomainsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type RemoveDomainsResponse = Response<RemoveDomainsResponseSuccess>;
 
 interface UpdateDomainsOptions {
     id: string;
@@ -720,24 +620,12 @@ interface UpdateDomainsOptions {
 type UpdateDomainsResponseSuccess = Pick<Domain, 'id'> & {
     object: 'domain';
 };
-type UpdateDomainsResponse = {
-    data: UpdateDomainsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type UpdateDomainsResponse = Response<UpdateDomainsResponseSuccess>;
 
 type VerifyDomainsResponseSuccess = Pick<Domain, 'id'> & {
     object: 'domain';
 };
-type VerifyDomainsResponse = {
-    data: VerifyDomainsResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type VerifyDomainsResponse = Response<VerifyDomainsResponseSuccess>;
 
 declare class Domains {
     private readonly resend;
@@ -754,13 +642,7 @@ interface CancelEmailResponseSuccess {
     object: 'email';
     id: string;
 }
-type CancelEmailResponse = {
-    data: CancelEmailResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type CancelEmailResponse = Response<CancelEmailResponseSuccess>;
 
 interface GetEmailResponseSuccess {
     bcc: string[] | null;
@@ -773,17 +655,15 @@ interface GetEmailResponseSuccess {
     reply_to: string[] | null;
     subject: string;
     text: string | null;
+    tags?: {
+        name: string;
+        value: string;
+    }[];
     to: string[];
     scheduled_at: string | null;
     object: 'email';
 }
-type GetEmailResponse = {
-    data: GetEmailResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type GetEmailResponse = Response<GetEmailResponseSuccess>;
 
 interface UpdateEmailOptions {
     id: string;
@@ -793,13 +673,7 @@ interface UpdateEmailResponseSuccess {
     id: string;
     object: 'email';
 }
-type UpdateEmailResponse = {
-    data: UpdateEmailResponseSuccess;
-    error: null;
-} | {
-    data: null;
-    error: ErrorResponse;
-};
+type UpdateEmailResponse = Response<UpdateEmailResponseSuccess>;
 
 declare class Emails {
     private readonly resend;
@@ -823,48 +697,12 @@ declare class Resend {
     readonly domains: Domains;
     readonly emails: Emails;
     constructor(key?: string | undefined);
-    fetchRequest<T>(path: string, options?: {}): Promise<{
-        data: T;
-        error: null;
-    } | {
-        data: null;
-        error: ErrorResponse;
-    }>;
-    post<T>(path: string, entity?: unknown, options?: PostOptions & IdempotentRequest): Promise<{
-        data: null;
-        error: ErrorResponse;
-    } | {
-        data: T;
-        error: null;
-    }>;
-    get<T>(path: string, options?: GetOptions): Promise<{
-        data: null;
-        error: ErrorResponse;
-    } | {
-        data: T;
-        error: null;
-    }>;
-    put<T>(path: string, entity: unknown, options?: PutOptions): Promise<{
-        data: null;
-        error: ErrorResponse;
-    } | {
-        data: T;
-        error: null;
-    }>;
-    patch<T>(path: string, entity: unknown, options?: PatchOptions): Promise<{
-        data: null;
-        error: ErrorResponse;
-    } | {
-        data: T;
-        error: null;
-    }>;
-    delete<T>(path: string, query?: unknown): Promise<{
-        data: null;
-        error: ErrorResponse;
-    } | {
-        data: T;
-        error: null;
-    }>;
+    fetchRequest<T>(path: string, options?: {}): Promise<Response<T>>;
+    post<T>(path: string, entity?: unknown, options?: PostOptions & IdempotentRequest): Promise<Response<T>>;
+    get<T>(path: string, options?: GetOptions): Promise<Response<T>>;
+    put<T>(path: string, entity: unknown, options?: PutOptions): Promise<Response<T>>;
+    patch<T>(path: string, entity: unknown, options?: PatchOptions): Promise<Response<T>>;
+    delete<T>(path: string, query?: unknown): Promise<Response<T>>;
 }
 
 export { Attachment, CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAudienceOptions, CreateAudienceRequestOptions, CreateAudienceResponse, CreateAudienceResponseSuccess, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, CreateBroadcastOptions, CreateBroadcastRequestOptions, CreateBroadcastResponse, CreateBroadcastResponseSuccess, CreateContactOptions, CreateContactRequestOptions, CreateContactResponse, CreateContactResponseSuccess, CreateDomainOptions, CreateDomainRequestOptions, CreateDomainResponse, CreateDomainResponseSuccess, CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, CreateEmailResponseSuccess, ErrorResponse, GetAudienceResponse, GetAudienceResponseSuccess, GetContactOptions, GetContactResponse, GetContactResponseSuccess, GetDomainResponse, GetDomainResponseSuccess, GetEmailResponse, GetEmailResponseSuccess, ListApiKeysResponse, ListApiKeysResponseSuccess, ListAudiencesResponse, ListAudiencesResponseSuccess, ListContactsOptions, ListContactsResponse, ListContactsResponseSuccess, ListDomainsResponse, ListDomainsResponseSuccess, RemoveApiKeyResponse, RemoveApiKeyResponseSuccess, RemoveAudiencesResponse, RemoveAudiencesResponseSuccess, RemoveContactOptions, RemoveContactsResponse, RemoveContactsResponseSuccess, RemoveDomainsResponse, RemoveDomainsResponseSuccess, Resend, SendBroadcastOptions, SendBroadcastRequestOptions, SendBroadcastResponse, SendBroadcastResponseSuccess, Tag, UpdateContactOptions, UpdateContactResponse, UpdateContactResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess };