@trycourier/courier 7.3.0 → 7.8.0

package/resources/automations/automations.d.ts

@@ -1,14 +1,67 @@
 import { APIResource } from "../../core/resource.js";
 import * as InvokeAPI from "./invoke.js";
 import { Invoke, InvokeInvokeAdHocParams, InvokeInvokeByTemplateParams } from "./invoke.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class Automations extends APIResource {
     invoke: InvokeAPI.Invoke;
+    /**
+     * Get the list of automations.
+     *
+     * @example
+     * ```ts
+     * const automationTemplateListResponse =
+     *   await client.automations.list();
+     * ```
+     */
+    list(query?: AutomationListParams | null | undefined, options?: RequestOptions): APIPromise<AutomationTemplateListResponse>;
 }
 export interface AutomationInvokeResponse {
     runId: string;
 }
+export interface AutomationTemplate {
+    /**
+     * The unique identifier of the automation template.
+     */
+    id: string;
+    /**
+     * The name of the automation template.
+     */
+    name: string;
+    /**
+     * The version of the template published or drafted.
+     */
+    version: 'published' | 'draft';
+    /**
+     * ISO 8601 timestamp when the template was created.
+     */
+    createdAt?: string;
+    /**
+     * ISO 8601 timestamp when the template was last updated.
+     */
+    updatedAt?: string;
+}
+export interface AutomationTemplateListResponse {
+    /**
+     * A cursor token for pagination. Present when there are more results available.
+     */
+    cursor?: string;
+    templates?: Array<AutomationTemplate>;
+}
+export interface AutomationListParams {
+    /**
+     * A cursor token for pagination. Use the cursor from the previous response to
+     * fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * The version of templates to retrieve. Accepted values are published (for
+     * published templates) or draft (for draft templates). Defaults to published.
+     */
+    version?: 'published' | 'draft';
+}
 export declare namespace Automations {
-    export { type AutomationInvokeResponse as AutomationInvokeResponse };
+    export { type AutomationInvokeResponse as AutomationInvokeResponse, type AutomationTemplate as AutomationTemplate, type AutomationTemplateListResponse as AutomationTemplateListResponse, type AutomationListParams as AutomationListParams, };
     export { Invoke as Invoke, type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams, };
 }
 //# sourceMappingURL=automations.d.ts.map

package/resources/automations/automations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automations.d.ts","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,MAAM,EAAE,uBAAuB,EAAE,4BAA4B,EAAE;AAExE,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EAAE,KAAK,wBAAwB,IAAI,wBAAwB,EAAE,CAAC;IAErE,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"automations.d.ts","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,MAAM,EAAE,uBAAuB,EAAE,4BAA4B,EAAE;OACjE,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CACjC;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/automations/automations.js

@@ -11,6 +11,18 @@ class Automations extends resource_1.APIResource {
         super(...arguments);
         this.invoke = new InvokeAPI.Invoke(this._client);
     }
+    /**
+     * Get the list of automations.
+     *
+     * @example
+     * ```ts
+     * const automationTemplateListResponse =
+     *   await client.automations.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/automations', { query, ...options });
+    }
 }
 exports.Automations = Automations;
 Automations.Invoke = invoke_1.Invoke;

package/resources/automations/automations.js.map

@@ -1 +1 @@
-{"version":3,"file":"automations.js","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAAyF;AAEzF,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAFD,kCAEC;AAMD,WAAW,CAAC,MAAM,GAAG,eAAM,CAAC"}
+{"version":3,"file":"automations.js","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAAyF;AAIzF,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiBhE,CAAC;IAfC;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAlBD,kCAkBC;AAwDD,WAAW,CAAC,MAAM,GAAG,eAAM,CAAC"}

package/resources/automations/automations.mjs

@@ -7,6 +7,18 @@ export class Automations extends APIResource {
         super(...arguments);
         this.invoke = new InvokeAPI.Invoke(this._client);
     }
+    /**
+     * Get the list of automations.
+     *
+     * @example
+     * ```ts
+     * const automationTemplateListResponse =
+     *   await client.automations.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/automations', { query, ...options });
+    }
 }
 Automations.Invoke = Invoke;
 //# sourceMappingURL=automations.mjs.map

package/resources/automations/automations.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"automations.mjs","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,MAAM,EAAyD;AAExE,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAMD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"automations.mjs","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,MAAM,EAAyD;AAIxE,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiBhE,CAAC;IAfC;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAwDD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}

package/resources/automations/index.d.mts

@@ -1,3 +1,3 @@
-export { Automations, type AutomationInvokeResponse } from "./automations.mjs";
+export { Automations, type AutomationInvokeResponse, type AutomationTemplate, type AutomationTemplateListResponse, type AutomationListParams, } from "./automations.mjs";
 export { Invoke, type InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams } from "./invoke.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/automations/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,wBAAwB,EAAE;OAC9C,EAAE,MAAM,EAAE,KAAK,uBAAuB,EAAE,KAAK,4BAA4B,EAAE"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,GAC1B;OACM,EAAE,MAAM,EAAE,KAAK,uBAAuB,EAAE,KAAK,4BAA4B,EAAE"}

package/resources/automations/index.d.ts

@@ -1,3 +1,3 @@
-export { Automations, type AutomationInvokeResponse } from "./automations.js";
+export { Automations, type AutomationInvokeResponse, type AutomationTemplate, type AutomationTemplateListResponse, type AutomationListParams, } from "./automations.js";
 export { Invoke, type InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams } from "./invoke.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/automations/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,wBAAwB,EAAE;OAC9C,EAAE,MAAM,EAAE,KAAK,uBAAuB,EAAE,KAAK,4BAA4B,EAAE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,8BAA8B,EACnC,KAAK,oBAAoB,GAC1B;OACM,EAAE,MAAM,EAAE,KAAK,uBAAuB,EAAE,KAAK,4BAA4B,EAAE"}

package/resources/automations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA2E;AAAlE,0GAAA,WAAW,OAAA;AACpB,sCAAmG;AAA1F,gGAAA,MAAM,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAMuB;AALrB,0GAAA,WAAW,OAAA;AAMb,sCAAmG;AAA1F,gGAAA,MAAM,OAAA"}

package/resources/automations/index.mjs

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export { Automations } from "./automations.mjs";
+export { Automations, } from "./automations.mjs";
 export { Invoke } from "./invoke.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/automations/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAiC;OAC9C,EAAE,MAAM,EAAmE"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,GAKZ;OACM,EAAE,MAAM,EAAmE"}

package/resources/bulk.d.mts

@@ -5,11 +5,21 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Bulk extends APIResource {
     /**
-     * Ingest user data into a Bulk Job
+     * Ingest user data into a Bulk Job.
+     *
+     * **Important**: For email-based bulk jobs, each user must include `profile.email`
+     * for provider routing to work correctly. The `to.email` field is not sufficient
+     * for email provider routing.
      */
     addUsers(jobID: string, body: BulkAddUsersParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Create a bulk job
+     * Creates a new bulk job for sending messages to multiple recipients.
+     *
+     * **Required**: `message.event` (event ID or notification ID)
+     *
+     * **Optional (V2 format)**: `message.template` (notification ID) or
+     * `message.content` (Elemental content) can be provided to override the
+     * notification associated with the event.
      */
     createJob(body: BulkCreateJobParams, options?: RequestOptions): APIPromise<BulkCreateJobResponse>;
     /**
@@ -25,49 +35,66 @@ export declare class Bulk extends APIResource {
      */
     runJob(jobID: string, options?: RequestOptions): APIPromise<void>;
 }
-export type InboundBulkMessage = InboundBulkMessage.InboundBulkTemplateMessage | InboundBulkMessage.InboundBulkContentMessage;
-export declare namespace InboundBulkMessage {
-    interface InboundBulkTemplateMessage {
-        template: string;
-        brand?: string | null;
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        event?: string | null;
-        locale?: {
-            [key: string]: {
-                [key: string]: unknown;
-            };
-        } | null;
-        override?: {
-            [key: string]: unknown;
-        } | null;
-    }
-    interface InboundBulkContentMessage {
-        /**
-         * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-         */
-        content: Shared.ElementalContentSugar | Shared.ElementalContent;
-        brand?: string | null;
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        event?: string | null;
-        locale?: {
-            [key: string]: {
-                [key: string]: unknown;
-            };
-        } | null;
-        override?: {
+/**
+ * Bulk message definition. Supports two formats:
+ *
+ * - V1 format: Requires `event` field (event ID or notification ID)
+ * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+ *   content) in addition to `event`
+ */
+export interface InboundBulkMessage {
+    /**
+     * Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+     * "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+     * mapped to a notification.
+     */
+    event: string;
+    brand?: string | null;
+    /**
+     * Elemental content (optional, for V2 format). When provided, this will be used
+     * instead of the notification associated with the `event` field.
+     */
+    content?: Shared.ElementalContentSugar | Shared.ElementalContent | null;
+    data?: {
+        [key: string]: unknown;
+    } | null;
+    locale?: {
+        [key: string]: {
             [key: string]: unknown;
-        } | null;
-    }
+        };
+    } | null;
+    override?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Notification ID or template ID (optional, for V2 format). When provided, this
+     * will be used instead of the notification associated with the `event` field.
+     */
+    template?: string | null;
 }
 export interface InboundBulkMessageUser {
+    /**
+     * User-specific data that will be merged with message.data
+     */
     data?: unknown;
     preferences?: Shared.RecipientPreferences | null;
-    profile?: unknown;
+    /**
+     * User profile information. For email-based bulk jobs, `profile.email` is required
+     * for provider routing to determine if the message can be delivered. The email
+     * address should be provided here rather than in `to.email`.
+     */
+    profile?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * User ID (legacy field, use profile or to.user_id instead)
+     */
     recipient?: string | null;
+    /**
+     * Optional recipient information. Note: For email provider routing, use
+     * `profile.email` instead of `to.email`. The `to` field is primarily used for
+     * recipient identification and data merging.
+     */
     to?: Shared.UserRecipient | null;
 }
 export interface BulkCreateJobResponse {
@@ -88,6 +115,13 @@ export interface BulkRetrieveJobResponse {
 }
 export declare namespace BulkRetrieveJobResponse {
     interface Job {
+        /**
+         * Bulk message definition. Supports two formats:
+         *
+         * - V1 format: Requires `event` field (event ID or notification ID)
+         * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+         *   content) in addition to `event`
+         */
         definition: BulkAPI.InboundBulkMessage;
         enqueued: number;
         failures: number;
@@ -99,6 +133,13 @@ export interface BulkAddUsersParams {
     users: Array<InboundBulkMessageUser>;
 }
 export interface BulkCreateJobParams {
+    /**
+     * Bulk message definition. Supports two formats:
+     *
+     * - V1 format: Requires `event` field (event ID or notification ID)
+     * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+     *   content) in addition to `event`
+     */
     message: InboundBulkMessage;
 }
 export interface BulkListUsersParams {

package/resources/bulk.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjG;;OAEG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIzF;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,CAAC,0BAA0B,GAC7C,kBAAkB,CAAC,yBAAyB,CAAC;AAEjD,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,0BAA0B;QACzC,QAAQ,EAAE,MAAM,CAAC;QAEjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAA;SAAE,GAAG,IAAI,CAAC;QAE9D,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC9C;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAEhE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAA;SAAE,GAAG,IAAI,CAAC;QAE9D,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC9C;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,EAAE,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAK,SAAQ,OAAO,CAAC,sBAAsB;QAC1D,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;QAEzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,uBAAuB,CAAC,GAAG,CAAC;CAClC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,GAAG;QAClB,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjG;;OAEG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIzF;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAExE,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9D,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAK,SAAQ,OAAO,CAAC,sBAAsB;QAC1D,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;QAEzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,uBAAuB,CAAC,GAAG,CAAC;CAClC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,GAAG;QAClB;;;;;;WAMG;QACH,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/bulk.d.ts

@@ -5,11 +5,21 @@ import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Bulk extends APIResource {
     /**
-     * Ingest user data into a Bulk Job
+     * Ingest user data into a Bulk Job.
+     *
+     * **Important**: For email-based bulk jobs, each user must include `profile.email`
+     * for provider routing to work correctly. The `to.email` field is not sufficient
+     * for email provider routing.
      */
     addUsers(jobID: string, body: BulkAddUsersParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Create a bulk job
+     * Creates a new bulk job for sending messages to multiple recipients.
+     *
+     * **Required**: `message.event` (event ID or notification ID)
+     *
+     * **Optional (V2 format)**: `message.template` (notification ID) or
+     * `message.content` (Elemental content) can be provided to override the
+     * notification associated with the event.
      */
     createJob(body: BulkCreateJobParams, options?: RequestOptions): APIPromise<BulkCreateJobResponse>;
     /**
@@ -25,49 +35,66 @@ export declare class Bulk extends APIResource {
      */
     runJob(jobID: string, options?: RequestOptions): APIPromise<void>;
 }
-export type InboundBulkMessage = InboundBulkMessage.InboundBulkTemplateMessage | InboundBulkMessage.InboundBulkContentMessage;
-export declare namespace InboundBulkMessage {
-    interface InboundBulkTemplateMessage {
-        template: string;
-        brand?: string | null;
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        event?: string | null;
-        locale?: {
-            [key: string]: {
-                [key: string]: unknown;
-            };
-        } | null;
-        override?: {
-            [key: string]: unknown;
-        } | null;
-    }
-    interface InboundBulkContentMessage {
-        /**
-         * Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-         */
-        content: Shared.ElementalContentSugar | Shared.ElementalContent;
-        brand?: string | null;
-        data?: {
-            [key: string]: unknown;
-        } | null;
-        event?: string | null;
-        locale?: {
-            [key: string]: {
-                [key: string]: unknown;
-            };
-        } | null;
-        override?: {
+/**
+ * Bulk message definition. Supports two formats:
+ *
+ * - V1 format: Requires `event` field (event ID or notification ID)
+ * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+ *   content) in addition to `event`
+ */
+export interface InboundBulkMessage {
+    /**
+     * Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+     * "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+     * mapped to a notification.
+     */
+    event: string;
+    brand?: string | null;
+    /**
+     * Elemental content (optional, for V2 format). When provided, this will be used
+     * instead of the notification associated with the `event` field.
+     */
+    content?: Shared.ElementalContentSugar | Shared.ElementalContent | null;
+    data?: {
+        [key: string]: unknown;
+    } | null;
+    locale?: {
+        [key: string]: {
             [key: string]: unknown;
-        } | null;
-    }
+        };
+    } | null;
+    override?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Notification ID or template ID (optional, for V2 format). When provided, this
+     * will be used instead of the notification associated with the `event` field.
+     */
+    template?: string | null;
 }
 export interface InboundBulkMessageUser {
+    /**
+     * User-specific data that will be merged with message.data
+     */
     data?: unknown;
     preferences?: Shared.RecipientPreferences | null;
-    profile?: unknown;
+    /**
+     * User profile information. For email-based bulk jobs, `profile.email` is required
+     * for provider routing to determine if the message can be delivered. The email
+     * address should be provided here rather than in `to.email`.
+     */
+    profile?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * User ID (legacy field, use profile or to.user_id instead)
+     */
     recipient?: string | null;
+    /**
+     * Optional recipient information. Note: For email provider routing, use
+     * `profile.email` instead of `to.email`. The `to` field is primarily used for
+     * recipient identification and data merging.
+     */
     to?: Shared.UserRecipient | null;
 }
 export interface BulkCreateJobResponse {
@@ -88,6 +115,13 @@ export interface BulkRetrieveJobResponse {
 }
 export declare namespace BulkRetrieveJobResponse {
     interface Job {
+        /**
+         * Bulk message definition. Supports two formats:
+         *
+         * - V1 format: Requires `event` field (event ID or notification ID)
+         * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+         *   content) in addition to `event`
+         */
         definition: BulkAPI.InboundBulkMessage;
         enqueued: number;
         failures: number;
@@ -99,6 +133,13 @@ export interface BulkAddUsersParams {
     users: Array<InboundBulkMessageUser>;
 }
 export interface BulkCreateJobParams {
+    /**
+     * Bulk message definition. Supports two formats:
+     *
+     * - V1 format: Requires `event` field (event ID or notification ID)
+     * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+     *   content) in addition to `event`
+     */
     message: InboundBulkMessage;
 }
 export interface BulkListUsersParams {

package/resources/bulk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjG;;OAEG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIzF;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,CAAC,0BAA0B,GAC7C,kBAAkB,CAAC,yBAAyB,CAAC;AAEjD,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,0BAA0B;QACzC,QAAQ,EAAE,MAAM,CAAC;QAEjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAA;SAAE,GAAG,IAAI,CAAC;QAE9D,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC9C;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAEhE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAA;SAAE,GAAG,IAAI,CAAC;QAE9D,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC9C;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,EAAE,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAK,SAAQ,OAAO,CAAC,sBAAsB;QAC1D,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;QAEzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,uBAAuB,CAAC,GAAG,CAAC;CAClC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,GAAG;QAClB,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjG;;OAEG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIzF;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMlE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAExE,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAA;KAAE,GAAG,IAAI,CAAC;IAE9D,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEjD;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAK,SAAQ,OAAO,CAAC,sBAAsB;QAC1D,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;QAEzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,uBAAuB,CAAC,GAAG,CAAC;CAClC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,GAAG;QAClB;;;;;;WAMG;QACH,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC;QAEvC,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;KAC1D;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/bulk.js

@@ -7,7 +7,11 @@ const headers_1 = require("../internal/headers.js");
 const path_1 = require("../internal/utils/path.js");
 class Bulk extends resource_1.APIResource {
     /**
-     * Ingest user data into a Bulk Job
+     * Ingest user data into a Bulk Job.
+     *
+     * **Important**: For email-based bulk jobs, each user must include `profile.email`
+     * for provider routing to work correctly. The `to.email` field is not sufficient
+     * for email provider routing.
      */
     addUsers(jobID, body, options) {
         return this._client.post((0, path_1.path) `/bulk/${jobID}`, {
@@ -17,7 +21,13 @@ class Bulk extends resource_1.APIResource {
         });
     }
     /**
-     * Create a bulk job
+     * Creates a new bulk job for sending messages to multiple recipients.
+     *
+     * **Required**: `message.event` (event ID or notification ID)
+     *
+     * **Optional (V2 format)**: `message.template` (notification ID) or
+     * `message.content` (Elemental content) can be provided to override the
+     * notification associated with the event.
      */
     createJob(body, options) {
         return this._client.post('/bulk', { body, ...options });

package/resources/bulk.js.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,EAAE,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAyB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,SAAS,CACP,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,KAAa,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,MAAM,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA9CD,oBA8CC"}
+{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,EAAE,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAyB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,SAAS,CACP,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,KAAa,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,MAAM,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAxDD,oBAwDC"}

package/resources/bulk.mjs

@@ -4,7 +4,11 @@ import { buildHeaders } from "../internal/headers.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class Bulk extends APIResource {
     /**
-     * Ingest user data into a Bulk Job
+     * Ingest user data into a Bulk Job.
+     *
+     * **Important**: For email-based bulk jobs, each user must include `profile.email`
+     * for provider routing to work correctly. The `to.email` field is not sufficient
+     * for email provider routing.
      */
     addUsers(jobID, body, options) {
         return this._client.post(path `/bulk/${jobID}`, {
@@ -14,7 +18,13 @@ export class Bulk extends APIResource {
         });
     }
     /**
-     * Create a bulk job
+     * Creates a new bulk job for sending messages to multiple recipients.
+     *
+     * **Required**: `message.event` (event ID or notification ID)
+     *
+     * **Optional (V2 format)**: `message.template` (notification ID) or
+     * `message.content` (Elemental content) can be provided to override the
+     * notification associated with the event.
      */
     createJob(body, options) {
         return this._client.post('/bulk', { body, ...options });

package/resources/bulk.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,EAAE,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAyB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,SAAS,CACP,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,KAAK,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,KAAa,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,MAAM,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,EAAE,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAyB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,SAAS,CACP,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,KAAK,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,KAAa,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,MAAM,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/inbound.d.mts

@@ -45,7 +45,7 @@ export interface InboundTrackEventParams {
     };
     type: 'track';
     /**
-     * The user id associatiated with the track
+     * The user id associated with the track
      */
     userId?: string | null;
 }

package/resources/inbound.d.ts

@@ -45,7 +45,7 @@ export interface InboundTrackEventParams {
     };
     type: 'track';
     /**
-     * The user id associatiated with the track
+     * The user id associated with the track
      */
     userId?: string | null;
 }

package/resources/index.d.mts

@@ -1,18 +1,19 @@
 export * from "./shared.mjs";
-export { Audiences, type Audience, type Filter, type FilterConfig, type AudienceUpdateResponse, type AudienceListResponse, type AudienceListMembersResponse, type AudienceUpdateParams, type AudienceListParams, type AudienceListMembersParams, } from "./audiences.mjs";
+export { Audiences, type Audience, type AudienceUpdateResponse, type AudienceListResponse, type AudienceListMembersResponse, type AudienceUpdateParams, type AudienceListParams, type AudienceListMembersParams, } from "./audiences.mjs";
 export { AuditEvents, type AuditEvent, type AuditEventListResponse, type AuditEventListParams, } from "./audit-events.mjs";
 export { Auth, type AuthIssueTokenResponse, type AuthIssueTokenParams } from "./auth.mjs";
-export { Automations, type AutomationInvokeResponse } from "./automations/automations.mjs";
+export { Automations, type AutomationInvokeResponse, type AutomationTemplate, type AutomationTemplateListResponse, type AutomationListParams, } from "./automations/automations.mjs";
 export { Brands, type Brand, type BrandColors, type BrandSettings, type BrandSettingsEmail, type BrandSettingsInApp, type BrandSnippet, type BrandSnippets, type BrandTemplate, type EmailFooter, type EmailHead, type EmailHeader, type Icons, type Logo, type WidgetBackground, type BrandListResponse, type BrandCreateParams, type BrandUpdateParams, type BrandListParams, } from "./brands.mjs";
 export { Bulk, type InboundBulkMessage, type InboundBulkMessageUser, type BulkCreateJobResponse, type BulkListUsersResponse, type BulkRetrieveJobResponse, type BulkAddUsersParams, type BulkCreateJobParams, type BulkListUsersParams, } from "./bulk.mjs";
 export { Inbound, type InboundTrackEventResponse, type InboundTrackEventParams } from "./inbound.mjs";
+export { Journeys, type Journey, type JourneysInvokeRequest, type JourneysInvokeResponse, type JourneysListResponse, type JourneyListParams, type JourneyInvokeParams, } from "./journeys.mjs";
 export { Lists, type PutSubscriptionsRecipient, type SubscriptionList, type ListListResponse, type ListUpdateParams, type ListListParams, type ListRestoreParams, } from "./lists/lists.mjs";
 export { Messages, type MessageDetails, type MessageRetrieveResponse, type MessageListResponse, type MessageContentResponse, type MessageHistoryResponse, type MessageListParams, type MessageHistoryParams, } from "./messages.mjs";
 export { Notifications, type BaseCheck, type Check, type NotificationGetContent, type NotificationListResponse, type NotificationListParams, } from "./notifications/notifications.mjs";
 export { Profiles, type SubscribeToListsRequestItem, type ProfileCreateResponse, type ProfileRetrieveResponse, type ProfileReplaceResponse, type ProfileCreateParams, type ProfileUpdateParams, type ProfileReplaceParams, } from "./profiles/profiles.mjs";
 export { Requests } from "./requests.mjs";
 export { Send, type SendMessageResponse, type SendMessageParams } from "./send.mjs";
-export { Tenants, type BaseTemplateTenantAssociation, type DefaultPreferences, type SubscriptionTopicNew, type Tenant, type TenantAssociation, type TenantListResponse, type TenantListUsersResponse, type TenantUpdateParams, type TenantListParams, type TenantListUsersParams, } from "./tenants/tenants.mjs";
+export { Tenants, type BaseTemplateTenantAssociation, type DefaultPreferences, type PostTenantTemplatePublishRequest, type PostTenantTemplatePublishResponse, type PutTenantTemplateRequest, type PutTenantTemplateResponse, type SubscriptionTopicNew, type Tenant, type TenantAssociation, type TenantTemplateInput, type TenantListResponse, type TenantListUsersResponse, type TenantUpdateParams, type TenantListParams, type TenantListUsersParams, } from "./tenants/tenants.mjs";
 export { Translations, type TranslationRetrieveResponse, type TranslationRetrieveParams, type TranslationUpdateParams, } from "./translations.mjs";
 export { Users } from "./users/users.mjs";
 //# sourceMappingURL=index.d.mts.map