resend 2.0.0 → 2.0.1-canary.0

package/dist/index.d.mts

@@ -0,0 +1,353 @@
+import * as React from 'react';
+
+interface GetOptions {
+    query?: Record<string, any>;
+}
+
+interface PostOptions {
+    query?: {
+        [key: string]: any;
+    };
+}
+
+interface PutOptions {
+    query?: {
+        [key: string]: any;
+    };
+}
+
+declare const RESEND_ERROR_CODES_BY_KEY: {
+    readonly missing_required_field: 422;
+    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;
+}
+
+interface CreateApiKeyOptions {
+    name: string;
+    permission?: 'full_access' | 'sending_access';
+    domain_id?: string;
+}
+interface CreateApiKeyRequestOptions extends PostOptions {
+}
+interface CreateApiKeyResponseSuccess {
+    token: string;
+    id: string;
+}
+interface CreateApiKeyResponse {
+    data: CreateApiKeyResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+interface ListApiKeysResponseSuccess {
+    name: string;
+    id: string;
+    created_at: string;
+}
+interface ListApiKeysResponse {
+    data: ListApiKeysResponseSuccess[] | null;
+    error: ErrorResponse | null;
+}
+
+interface RemoveApiKeyResponseSuccess {
+    id: string;
+}
+interface RemoveApiKeyResponse {
+    data: RemoveApiKeyResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class ApiKeys {
+    private readonly resend;
+    constructor(resend: Resend);
+    create(payload: CreateApiKeyOptions, options?: CreateApiKeyRequestOptions): Promise<CreateApiKeyResponse>;
+    list(): Promise<ListApiKeysResponse>;
+    remove(id: string): Promise<RemoveApiKeyResponse>;
+}
+
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
+interface EmailRenderOptions {
+    /**
+     * The React component used to write the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
+    react?: React.ReactElement | React.ReactNode | null;
+    /**
+     * The HTML version of the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
+    html?: string;
+    /**
+     * The plain text version of the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
+    text?: string;
+}
+interface CreateEmailBaseOptions extends EmailRenderOptions {
+    /**
+     * Filename and content of attachments (max 40mb per email)
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    attachments?: Attachment[];
+    /**
+     * Blind carbon copy recipient email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    bcc?: string | string[];
+    /**
+     * Carbon copy recipient email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    cc?: string | string[];
+    /**
+     * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    from: string;
+    /**
+     * Custom headers to add to the email.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    headers?: Record<string, string>;
+    /**
+     * Reply-to email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    reply_to?: string | string[];
+    /**
+     * Email subject.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    subject: string;
+    /**
+     * Email tags
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    tags?: Tag[];
+    /**
+     * Recipient email address. For multiple addresses, send as an array of strings. Max 50.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    to: string | string[];
+}
+type CreateEmailOptions = RequireAtLeastOne<EmailRenderOptions> & CreateEmailBaseOptions;
+interface CreateEmailRequestOptions extends PostOptions {
+}
+interface CreateEmailResponseSuccess {
+    /** The ID of the newly created email. */
+    id: string;
+}
+interface CreateEmailResponse {
+    data: CreateEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+interface Attachment {
+    /** Content of an attached file. */
+    content?: string | Buffer;
+    /** Name of attached file. */
+    filename?: string | false | undefined;
+    /** Path where the attachment file is hosted */
+    path?: string;
+}
+type Tag = {
+    /**
+     * The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
+     */
+    name: string;
+    /**
+     * The value of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
+     */
+    value: string;
+};
+
+type CreateBatchOptions = CreateEmailOptions[];
+interface CreateBatchRequestOptions extends PostOptions {
+}
+interface CreateBatchSuccessResponse {
+    data: {
+        /** The ID of the newly created email. */
+        id: string;
+    }[];
+}
+interface CreateBatchResponse {
+    data: CreateBatchSuccessResponse | null;
+    error: ErrorResponse | null;
+}
+
+declare class Batch {
+    private readonly resend;
+    constructor(resend: Resend);
+    send(payload: CreateBatchOptions, options?: CreateBatchRequestOptions): Promise<CreateBatchResponse>;
+    create(payload: CreateBatchOptions, options?: CreateBatchRequestOptions): Promise<CreateBatchResponse>;
+}
+
+type DomainRegion = 'us-east-1' | 'eu-west-1' | 'sa-east-1';
+type DomainStatus = 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'not_started';
+type DomainRecords = DomainSpfRecord | DomainDkimRecord;
+interface DomainSpfRecord {
+    record: 'SPF';
+    name: string;
+    value: string;
+    type: 'MX' | 'TXT';
+    ttl: string;
+    status: DomainStatus;
+    routing_policy?: string;
+    priority?: number;
+    proxy_status?: 'enable' | 'disable';
+}
+interface DomainDkimRecord {
+    record: 'DKIM';
+    name: string;
+    value: string;
+    type: 'CNAME' | 'TXT';
+    ttl: string;
+    status: DomainStatus;
+    routing_policy?: string;
+    priority?: number;
+    proxy_status?: 'enable' | 'disable';
+}
+interface Domain {
+    id: string;
+    name: string;
+    status: DomainStatus;
+    created_at: string;
+    region: DomainRegion;
+}
+
+interface CreateDomainOptions {
+    name: string;
+    region?: DomainRegion;
+}
+interface CreateDomainRequestOptions extends PostOptions {
+}
+interface CreateDomainResponseSuccess extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region'> {
+    records: DomainRecords[];
+}
+interface CreateDomainResponse {
+    data: CreateDomainResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+type ListDomainsResponseSuccess = Domain[];
+interface ListDomainsResponse {
+    data: ListDomainsResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+interface GetDomainResponseSuccess extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status'> {
+    object: 'domain';
+    records: DomainRecords[];
+}
+interface GetDomainResponse {
+    data: GetDomainResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+type RemoveDomainsResponseSuccess = Pick<Domain, 'id'>;
+interface RemoveDomainsResponse {
+    data: RemoveDomainsResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+type VerifyDomainsResponseSuccess = Domain[];
+interface VerifyDomainsResponse {
+    data: VerifyDomainsResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class Domains {
+    private readonly resend;
+    constructor(resend: Resend);
+    create(payload: CreateDomainOptions, options?: CreateDomainRequestOptions): Promise<CreateDomainResponse>;
+    list(): Promise<ListDomainsResponse>;
+    get(id: string): Promise<GetDomainResponse>;
+    remove(id: string): Promise<RemoveDomainsResponse>;
+    verify(id: string): Promise<VerifyDomainsResponse>;
+}
+
+interface GetEmailResponseSuccess {
+    bcc: string[] | null;
+    cc: string[] | null;
+    created_at: string;
+    from: string;
+    html: string | null;
+    id: string;
+    last_event: string;
+    reply_to: string[] | null;
+    subject: string;
+    text: string | null;
+    to: string[];
+    object: 'email';
+}
+interface GetEmailResponse {
+    data: GetEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class Emails {
+    private readonly resend;
+    constructor(resend: Resend);
+    send(payload: CreateEmailOptions, options?: CreateEmailRequestOptions): Promise<CreateEmailResponse>;
+    create(payload: CreateEmailOptions, options?: CreateEmailRequestOptions): Promise<CreateEmailResponse>;
+    get(id: string): Promise<GetEmailResponse>;
+}
+
+declare class Resend {
+    readonly key?: string | undefined;
+    private readonly headers;
+    readonly apiKeys: ApiKeys;
+    readonly domains: Domains;
+    readonly emails: Emails;
+    readonly batch: Batch;
+    constructor(key?: string | undefined);
+    fetchRequest<T>(path: string, options?: {}): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    post<T>(path: string, entity?: unknown, options?: PostOptions): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    get<T>(path: string, options?: GetOptions): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    put<T>(path: string, entity: any, options?: PutOptions): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    delete<T>(path: string, query?: unknown): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+}
+
+export { ErrorResponse, Resend };

package/dist/index.d.ts

@@ -0,0 +1,353 @@
+import * as React from 'react';
+
+interface GetOptions {
+    query?: Record<string, any>;
+}
+
+interface PostOptions {
+    query?: {
+        [key: string]: any;
+    };
+}
+
+interface PutOptions {
+    query?: {
+        [key: string]: any;
+    };
+}
+
+declare const RESEND_ERROR_CODES_BY_KEY: {
+    readonly missing_required_field: 422;
+    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;
+}
+
+interface CreateApiKeyOptions {
+    name: string;
+    permission?: 'full_access' | 'sending_access';
+    domain_id?: string;
+}
+interface CreateApiKeyRequestOptions extends PostOptions {
+}
+interface CreateApiKeyResponseSuccess {
+    token: string;
+    id: string;
+}
+interface CreateApiKeyResponse {
+    data: CreateApiKeyResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+interface ListApiKeysResponseSuccess {
+    name: string;
+    id: string;
+    created_at: string;
+}
+interface ListApiKeysResponse {
+    data: ListApiKeysResponseSuccess[] | null;
+    error: ErrorResponse | null;
+}
+
+interface RemoveApiKeyResponseSuccess {
+    id: string;
+}
+interface RemoveApiKeyResponse {
+    data: RemoveApiKeyResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class ApiKeys {
+    private readonly resend;
+    constructor(resend: Resend);
+    create(payload: CreateApiKeyOptions, options?: CreateApiKeyRequestOptions): Promise<CreateApiKeyResponse>;
+    list(): Promise<ListApiKeysResponse>;
+    remove(id: string): Promise<RemoveApiKeyResponse>;
+}
+
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
+interface EmailRenderOptions {
+    /**
+     * The React component used to write the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
+    react?: React.ReactElement | React.ReactNode | null;
+    /**
+     * The HTML version of the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
+    html?: string;
+    /**
+     * The plain text version of the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
+    text?: string;
+}
+interface CreateEmailBaseOptions extends EmailRenderOptions {
+    /**
+     * Filename and content of attachments (max 40mb per email)
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    attachments?: Attachment[];
+    /**
+     * Blind carbon copy recipient email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    bcc?: string | string[];
+    /**
+     * Carbon copy recipient email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    cc?: string | string[];
+    /**
+     * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    from: string;
+    /**
+     * Custom headers to add to the email.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    headers?: Record<string, string>;
+    /**
+     * Reply-to email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    reply_to?: string | string[];
+    /**
+     * Email subject.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    subject: string;
+    /**
+     * Email tags
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    tags?: Tag[];
+    /**
+     * Recipient email address. For multiple addresses, send as an array of strings. Max 50.
+     *
+     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
+     */
+    to: string | string[];
+}
+type CreateEmailOptions = RequireAtLeastOne<EmailRenderOptions> & CreateEmailBaseOptions;
+interface CreateEmailRequestOptions extends PostOptions {
+}
+interface CreateEmailResponseSuccess {
+    /** The ID of the newly created email. */
+    id: string;
+}
+interface CreateEmailResponse {
+    data: CreateEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+interface Attachment {
+    /** Content of an attached file. */
+    content?: string | Buffer;
+    /** Name of attached file. */
+    filename?: string | false | undefined;
+    /** Path where the attachment file is hosted */
+    path?: string;
+}
+type Tag = {
+    /**
+     * The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
+     */
+    name: string;
+    /**
+     * The value of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
+     */
+    value: string;
+};
+
+type CreateBatchOptions = CreateEmailOptions[];
+interface CreateBatchRequestOptions extends PostOptions {
+}
+interface CreateBatchSuccessResponse {
+    data: {
+        /** The ID of the newly created email. */
+        id: string;
+    }[];
+}
+interface CreateBatchResponse {
+    data: CreateBatchSuccessResponse | null;
+    error: ErrorResponse | null;
+}
+
+declare class Batch {
+    private readonly resend;
+    constructor(resend: Resend);
+    send(payload: CreateBatchOptions, options?: CreateBatchRequestOptions): Promise<CreateBatchResponse>;
+    create(payload: CreateBatchOptions, options?: CreateBatchRequestOptions): Promise<CreateBatchResponse>;
+}
+
+type DomainRegion = 'us-east-1' | 'eu-west-1' | 'sa-east-1';
+type DomainStatus = 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'not_started';
+type DomainRecords = DomainSpfRecord | DomainDkimRecord;
+interface DomainSpfRecord {
+    record: 'SPF';
+    name: string;
+    value: string;
+    type: 'MX' | 'TXT';
+    ttl: string;
+    status: DomainStatus;
+    routing_policy?: string;
+    priority?: number;
+    proxy_status?: 'enable' | 'disable';
+}
+interface DomainDkimRecord {
+    record: 'DKIM';
+    name: string;
+    value: string;
+    type: 'CNAME' | 'TXT';
+    ttl: string;
+    status: DomainStatus;
+    routing_policy?: string;
+    priority?: number;
+    proxy_status?: 'enable' | 'disable';
+}
+interface Domain {
+    id: string;
+    name: string;
+    status: DomainStatus;
+    created_at: string;
+    region: DomainRegion;
+}
+
+interface CreateDomainOptions {
+    name: string;
+    region?: DomainRegion;
+}
+interface CreateDomainRequestOptions extends PostOptions {
+}
+interface CreateDomainResponseSuccess extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region'> {
+    records: DomainRecords[];
+}
+interface CreateDomainResponse {
+    data: CreateDomainResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+type ListDomainsResponseSuccess = Domain[];
+interface ListDomainsResponse {
+    data: ListDomainsResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+interface GetDomainResponseSuccess extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status'> {
+    object: 'domain';
+    records: DomainRecords[];
+}
+interface GetDomainResponse {
+    data: GetDomainResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+type RemoveDomainsResponseSuccess = Pick<Domain, 'id'>;
+interface RemoveDomainsResponse {
+    data: RemoveDomainsResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+type VerifyDomainsResponseSuccess = Domain[];
+interface VerifyDomainsResponse {
+    data: VerifyDomainsResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class Domains {
+    private readonly resend;
+    constructor(resend: Resend);
+    create(payload: CreateDomainOptions, options?: CreateDomainRequestOptions): Promise<CreateDomainResponse>;
+    list(): Promise<ListDomainsResponse>;
+    get(id: string): Promise<GetDomainResponse>;
+    remove(id: string): Promise<RemoveDomainsResponse>;
+    verify(id: string): Promise<VerifyDomainsResponse>;
+}
+
+interface GetEmailResponseSuccess {
+    bcc: string[] | null;
+    cc: string[] | null;
+    created_at: string;
+    from: string;
+    html: string | null;
+    id: string;
+    last_event: string;
+    reply_to: string[] | null;
+    subject: string;
+    text: string | null;
+    to: string[];
+    object: 'email';
+}
+interface GetEmailResponse {
+    data: GetEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class Emails {
+    private readonly resend;
+    constructor(resend: Resend);
+    send(payload: CreateEmailOptions, options?: CreateEmailRequestOptions): Promise<CreateEmailResponse>;
+    create(payload: CreateEmailOptions, options?: CreateEmailRequestOptions): Promise<CreateEmailResponse>;
+    get(id: string): Promise<GetEmailResponse>;
+}
+
+declare class Resend {
+    readonly key?: string | undefined;
+    private readonly headers;
+    readonly apiKeys: ApiKeys;
+    readonly domains: Domains;
+    readonly emails: Emails;
+    readonly batch: Batch;
+    constructor(key?: string | undefined);
+    fetchRequest<T>(path: string, options?: {}): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    post<T>(path: string, entity?: unknown, options?: PostOptions): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    get<T>(path: string, options?: GetOptions): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    put<T>(path: string, entity: any, options?: PutOptions): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    delete<T>(path: string, query?: unknown): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+}
+
+export { ErrorResponse, Resend };