resend 4.0.1 → 4.1.0-alpha.0

package/dist/index.d.mts

@@ -137,7 +137,7 @@ type RequireAtLeastOne<T> = {
     [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];
 
-interface EmailRenderOptions {
+interface EmailRenderOptions$1 {
     /**
      * The React component used to write the message.
      *
@@ -220,7 +220,7 @@ interface CreateEmailBaseOptions {
      */
     scheduledAt?: string;
 }
-type CreateEmailOptions = RequireAtLeastOne<EmailRenderOptions> & CreateEmailBaseOptions;
+type CreateEmailOptions = RequireAtLeastOne<EmailRenderOptions$1> & CreateEmailBaseOptions;
 interface CreateEmailRequestOptions extends PostOptions {
 }
 interface CreateEmailResponseSuccess {
@@ -274,6 +274,106 @@ declare class Batch {
     create(payload: CreateBatchOptions, options?: CreateBatchRequestOptions): Promise<CreateBatchResponse>;
 }
 
+interface EmailRenderOptions {
+    /**
+     * The React component used to write the message.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    react: React.ReactNode;
+    /**
+     * The HTML version of the message.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    html: string;
+    /**
+     * The plain text version of the message.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    text: string;
+}
+interface CreateBroadcastBaseOptions {
+    /**
+     * The name of the broadcast
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    name?: string;
+    /**
+     * The id of the audience you want to send to
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    audienceId: string;
+    /**
+     * A short snippet of text displayed as a preview in recipients' inboxes, often shown below or beside the subject line.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    previewText?: string;
+    /**
+     * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    from: string;
+    /**
+     * Reply-to email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    replyTo?: string | string[];
+    /**
+     * Email subject.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    subject: string;
+}
+type CreateBroadcastOptions = RequireAtLeastOne<EmailRenderOptions> & CreateBroadcastBaseOptions;
+interface CreateBroadcastRequestOptions extends PostOptions {
+}
+interface CreateBroadcastResponseSuccess {
+    /** The ID of the newly sent broadcasts. */
+    id: string;
+}
+interface CreateBroadcastResponse {
+    data: CreateBroadcastResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+interface SendBroadcastBaseOptions {
+    /**
+     * Schedule email to be sent later.
+     * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
+     * or relative time (eg: in 2 days).
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/send#body-parameters
+     */
+    scheduledAt?: string;
+}
+type SendBroadcastOptions = SendBroadcastBaseOptions;
+interface SendBroadcastRequestOptions extends PostOptions {
+}
+interface SendBroadcastResponseSuccess {
+    /** The ID of the sent broadcast. */
+    id: string;
+}
+interface SendBroadcastResponse {
+    data: SendBroadcastResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class Broadcasts {
+    private readonly resend;
+    private renderAsync?;
+    constructor(resend: Resend);
+    create(payload: CreateBroadcastOptions, options?: CreateBroadcastRequestOptions): Promise<SendBroadcastResponse>;
+    send(id: string, payload: SendBroadcastOptions): Promise<SendBroadcastResponse>;
+}
+
 interface PatchOptions {
     query?: {
         [key: string]: unknown;
@@ -547,6 +647,7 @@ declare class Resend {
     readonly apiKeys: ApiKeys;
     readonly audiences: Audiences;
     readonly batch: Batch;
+    readonly broadcasts: Broadcasts;
     readonly contacts: Contacts;
     readonly domains: Domains;
     readonly emails: Emails;
@@ -577,4 +678,4 @@ declare class Resend {
     }>;
 }
 
-export { CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAudienceOptions, CreateAudienceRequestOptions, CreateAudienceResponse, CreateAudienceResponseSuccess, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, 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, Tag, UpdateContactOptions, UpdateContactResponse, UpdateContactResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess };
+export { 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 };

package/dist/index.d.ts

@@ -137,7 +137,7 @@ type RequireAtLeastOne<T> = {
     [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];
 
-interface EmailRenderOptions {
+interface EmailRenderOptions$1 {
     /**
      * The React component used to write the message.
      *
@@ -220,7 +220,7 @@ interface CreateEmailBaseOptions {
      */
     scheduledAt?: string;
 }
-type CreateEmailOptions = RequireAtLeastOne<EmailRenderOptions> & CreateEmailBaseOptions;
+type CreateEmailOptions = RequireAtLeastOne<EmailRenderOptions$1> & CreateEmailBaseOptions;
 interface CreateEmailRequestOptions extends PostOptions {
 }
 interface CreateEmailResponseSuccess {
@@ -274,6 +274,106 @@ declare class Batch {
     create(payload: CreateBatchOptions, options?: CreateBatchRequestOptions): Promise<CreateBatchResponse>;
 }
 
+interface EmailRenderOptions {
+    /**
+     * The React component used to write the message.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    react: React.ReactNode;
+    /**
+     * The HTML version of the message.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    html: string;
+    /**
+     * The plain text version of the message.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    text: string;
+}
+interface CreateBroadcastBaseOptions {
+    /**
+     * The name of the broadcast
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    name?: string;
+    /**
+     * The id of the audience you want to send to
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    audienceId: string;
+    /**
+     * A short snippet of text displayed as a preview in recipients' inboxes, often shown below or beside the subject line.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    previewText?: string;
+    /**
+     * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    from: string;
+    /**
+     * Reply-to email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    replyTo?: string | string[];
+    /**
+     * Email subject.
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+     */
+    subject: string;
+}
+type CreateBroadcastOptions = RequireAtLeastOne<EmailRenderOptions> & CreateBroadcastBaseOptions;
+interface CreateBroadcastRequestOptions extends PostOptions {
+}
+interface CreateBroadcastResponseSuccess {
+    /** The ID of the newly sent broadcasts. */
+    id: string;
+}
+interface CreateBroadcastResponse {
+    data: CreateBroadcastResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+interface SendBroadcastBaseOptions {
+    /**
+     * Schedule email to be sent later.
+     * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
+     * or relative time (eg: in 2 days).
+     *
+     * @link https://resend.com/docs/api-reference/broadcasts/send#body-parameters
+     */
+    scheduledAt?: string;
+}
+type SendBroadcastOptions = SendBroadcastBaseOptions;
+interface SendBroadcastRequestOptions extends PostOptions {
+}
+interface SendBroadcastResponseSuccess {
+    /** The ID of the sent broadcast. */
+    id: string;
+}
+interface SendBroadcastResponse {
+    data: SendBroadcastResponseSuccess | null;
+    error: ErrorResponse | null;
+}
+
+declare class Broadcasts {
+    private readonly resend;
+    private renderAsync?;
+    constructor(resend: Resend);
+    create(payload: CreateBroadcastOptions, options?: CreateBroadcastRequestOptions): Promise<SendBroadcastResponse>;
+    send(id: string, payload: SendBroadcastOptions): Promise<SendBroadcastResponse>;
+}
+
 interface PatchOptions {
     query?: {
         [key: string]: unknown;
@@ -547,6 +647,7 @@ declare class Resend {
     readonly apiKeys: ApiKeys;
     readonly audiences: Audiences;
     readonly batch: Batch;
+    readonly broadcasts: Broadcasts;
     readonly contacts: Contacts;
     readonly domains: Domains;
     readonly emails: Emails;
@@ -577,4 +678,4 @@ declare class Resend {
     }>;
 }
 
-export { CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAudienceOptions, CreateAudienceRequestOptions, CreateAudienceResponse, CreateAudienceResponseSuccess, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, 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, Tag, UpdateContactOptions, UpdateContactResponse, UpdateContactResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess };
+export { 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 };

package/dist/index.js

@@ -72,7 +72,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // package.json
-var version = "4.0.1";
+var version = "4.1.0-alpha.0";
 
 // src/api-keys/api-keys.ts
 var ApiKeys = class {
@@ -182,6 +182,56 @@ var Batch = class {
   }
 };
 
+// src/broadcasts/broadcasts.ts
+var Broadcasts = class {
+  constructor(resend) {
+    this.resend = resend;
+  }
+  create(_0) {
+    return __async(this, arguments, function* (payload, options = {}) {
+      if (payload.react) {
+        if (!this.renderAsync) {
+          try {
+            const { renderAsync } = yield import("@react-email/render");
+            this.renderAsync = renderAsync;
+          } catch (error) {
+            throw new Error(
+              "Failed to render React component. Make sure to install `@react-email/render`"
+            );
+          }
+        }
+        payload.html = yield this.renderAsync(
+          payload.react
+        );
+      }
+      const data = yield this.resend.post(
+        "/broadcasts",
+        {
+          name: payload.name,
+          audience_id: payload.audienceId,
+          preview_text: payload.previewText,
+          from: payload.from,
+          html: payload.html,
+          reply_to: payload.replyTo,
+          subject: payload.subject,
+          text: payload.text
+        },
+        options
+      );
+      return data;
+    });
+  }
+  send(id, payload) {
+    return __async(this, null, function* () {
+      const data = yield this.resend.post(
+        `/broadcasts/${id}/send`,
+        { scheduled_at: payload.scheduledAt }
+      );
+      return data;
+    });
+  }
+};
+
 // src/contacts/contacts.ts
 var Contacts = class {
   constructor(resend) {
@@ -389,6 +439,7 @@ var Resend = class {
     this.apiKeys = new ApiKeys(this);
     this.audiences = new Audiences(this);
     this.batch = new Batch(this);
+    this.broadcasts = new Broadcasts(this);
     this.contacts = new Contacts(this);
     this.domains = new Domains(this);
     this.emails = new Emails(this);

package/dist/index.mjs

@@ -39,7 +39,7 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // package.json
-var version = "4.0.1";
+var version = "4.1.0-alpha.0";
 
 // src/api-keys/api-keys.ts
 var ApiKeys = class {
@@ -149,6 +149,56 @@ var Batch = class {
   }
 };
 
+// src/broadcasts/broadcasts.ts
+var Broadcasts = class {
+  constructor(resend) {
+    this.resend = resend;
+  }
+  create(_0) {
+    return __async(this, arguments, function* (payload, options = {}) {
+      if (payload.react) {
+        if (!this.renderAsync) {
+          try {
+            const { renderAsync } = yield import("@react-email/render");
+            this.renderAsync = renderAsync;
+          } catch (error) {
+            throw new Error(
+              "Failed to render React component. Make sure to install `@react-email/render`"
+            );
+          }
+        }
+        payload.html = yield this.renderAsync(
+          payload.react
+        );
+      }
+      const data = yield this.resend.post(
+        "/broadcasts",
+        {
+          name: payload.name,
+          audience_id: payload.audienceId,
+          preview_text: payload.previewText,
+          from: payload.from,
+          html: payload.html,
+          reply_to: payload.replyTo,
+          subject: payload.subject,
+          text: payload.text
+        },
+        options
+      );
+      return data;
+    });
+  }
+  send(id, payload) {
+    return __async(this, null, function* () {
+      const data = yield this.resend.post(
+        `/broadcasts/${id}/send`,
+        { scheduled_at: payload.scheduledAt }
+      );
+      return data;
+    });
+  }
+};
+
 // src/contacts/contacts.ts
 var Contacts = class {
   constructor(resend) {
@@ -356,6 +406,7 @@ var Resend = class {
     this.apiKeys = new ApiKeys(this);
     this.audiences = new Audiences(this);
     this.batch = new Batch(this);
+    this.broadcasts = new Broadcasts(this);
     this.contacts = new Contacts(this);
     this.domains = new Domains(this);
     this.emails = new Emails(this);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resend",
-  "version": "4.0.1",
+  "version": "4.1.0-alpha.0",
   "description": "Node.js library for the Resend API",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",