@trycourier/courier 7.20.0 → 7.22.0

package/src/resources/workspace-preferences/workspace-preferences.ts

@@ -15,13 +15,15 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
+ */
 export class WorkspacePreferences extends APIResource {
   topics: TopicsAPI.Topics = new TopicsAPI.Topics(this._client);
 
   /**
-   * Create a workspace preference. The workspace preference id is generated and
-   * returned. Topics are created inside a workspace preference via POST
-   * /preferences/sections/{section_id}/topics.
+   * Creates a workspace preference and returns its generated id. Add subscription
+   * topics to it afterwards with the topics endpoint.
    *
    * @example
    * ```ts
@@ -32,14 +34,32 @@ export class WorkspacePreferences extends APIResource {
    * ```
    */
   create(
-    body: WorkspacePreferenceCreateParams,
+    params: WorkspacePreferenceCreateParams,
     options?: RequestOptions,
   ): APIPromise<WorkspacePreferenceGetResponse> {
-    return this._client.post('/preferences/sections', { body, ...options });
+    const {
+      'Idempotency-Key': idempotencyKey,
+      'x-idempotency-expiration': xIdempotencyExpiration,
+      ...body
+    } = params;
+    return this._client.post('/preferences/sections', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+          ...(xIdempotencyExpiration != null ?
+            { 'x-idempotency-expiration': xIdempotencyExpiration }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
-   * Retrieve a workspace preference by id, including its topics.
+   * Returns one workspace preference by id, including its subscription topics,
+   * routing options, and custom routing flag.
    *
    * @example
    * ```ts
@@ -52,8 +72,8 @@ export class WorkspacePreferences extends APIResource {
   }
 
   /**
-   * List the workspace's preferences. Each workspace preference embeds its topics.
-   * Scoped to the workspace of the API key.
+   * Returns the workspace's preferences, each embedding its subscription topics,
+   * routing options, and whether custom routing is allowed.
    *
    * @example
    * ```ts
@@ -82,9 +102,8 @@ export class WorkspacePreferences extends APIResource {
   }
 
   /**
-   * Publish the workspace's preferences page. Takes a snapshot of every workspace
-   * preference with its topics under a new published version, making the current
-   * state visible on the hosted preferences page (non-draft).
+   * Publishes the workspace preference page, snapshotting every preference and
+   * topic, and returns the page id and a preview URL.
    *
    * @example
    * ```ts
@@ -93,10 +112,27 @@ export class WorkspacePreferences extends APIResource {
    * ```
    */
   publish(
-    body: WorkspacePreferencePublishParams | null | undefined = {},
+    params: WorkspacePreferencePublishParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<PublishPreferencesResponse> {
-    return this._client.post('/preferences/publish', { body, ...options });
+    const {
+      'Idempotency-Key': idempotencyKey,
+      'x-idempotency-expiration': xIdempotencyExpiration,
+      ...body
+    } = params ?? {};
+    return this._client.post('/preferences/publish', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+          ...(xIdempotencyExpiration != null ?
+            { 'x-idempotency-expiration': xIdempotencyExpiration }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
@@ -444,42 +480,81 @@ export interface WorkspacePreferenceTopicReplaceRequest {
 
 export interface WorkspacePreferenceCreateParams {
   /**
-   * Human-readable name for the workspace preference.
+   * Body param: Human-readable name for the workspace preference.
    */
   name: string;
 
   /**
-   * Optional description shown under the section on the hosted preferences page.
+   * Body param: Optional description shown under the section on the hosted
+   * preferences page.
    */
   description?: string | null;
 
   /**
-   * Whether the workspace preference defines custom routing for its topics.
+   * Body param: Whether the workspace preference defines custom routing for its
+   * topics.
    */
   has_custom_routing?: boolean | null;
 
   /**
-   * Default channels for the workspace preference. Defaults to empty if omitted.
+   * Body param: Default channels for the workspace preference. Defaults to empty if
+   * omitted.
    */
   routing_options?: Array<Shared.ChannelClassification> | null;
+
+  /**
+   * Header param: A unique key that makes this request idempotent. If Courier
+   * receives another request with the same `Idempotency-Key`, it returns the stored
+   * response from the first request without performing the operation again
+   * (including the original status code and any error). Use it to safely retry
+   * `POST` requests after network failures without risking duplicate sends. The key
+   * is scoped to this endpoint.
+   */
+  'Idempotency-Key'?: string;
+
+  /**
+   * Header param: How long the idempotency key remains valid, as a Unix epoch
+   * timestamp in seconds or an ISO 8601 date string. Only applies when
+   * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
+   * maximum is 1 year.
+   */
+  'x-idempotency-expiration'?: string;
 }
 
 export interface WorkspacePreferencePublishParams {
   /**
-   * Brand for the hosted page - "default" (workspace default brand), "none" (no
-   * brand), or a specific brand id. Defaults to "default".
+   * Body param: Brand for the hosted page - "default" (workspace default brand),
+   * "none" (no brand), or a specific brand id. Defaults to "default".
    */
   brand_id?: string | null;
 
   /**
-   * Description shown under the heading on the hosted preferences page.
+   * Body param: Description shown under the heading on the hosted preferences page.
    */
   description?: string | null;
 
   /**
-   * Heading shown at the top of the hosted preferences page.
+   * Body param: Heading shown at the top of the hosted preferences page.
    */
   heading?: string | null;
+
+  /**
+   * Header param: A unique key that makes this request idempotent. If Courier
+   * receives another request with the same `Idempotency-Key`, it returns the stored
+   * response from the first request without performing the operation again
+   * (including the original status code and any error). Use it to safely retry
+   * `POST` requests after network failures without risking duplicate sends. The key
+   * is scoped to this endpoint.
+   */
+  'Idempotency-Key'?: string;
+
+  /**
+   * Header param: How long the idempotency key remains valid, as a Unix epoch
+   * timestamp in seconds or an ISO 8601 date string. Only applies when
+   * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
+   * maximum is 1 year.
+   */
+  'x-idempotency-expiration'?: string;
 }
 
 export interface WorkspacePreferenceReplaceParams {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.20.0'; // x-release-please-version
+export const VERSION = '7.22.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.20.0";
+export declare const VERSION = "7.22.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.20.0";
+export declare const VERSION = "7.22.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '7.20.0'; // x-release-please-version
+exports.VERSION = '7.22.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '7.20.0'; // x-release-please-version
+export const VERSION = '7.22.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/resources/bulk.d.mts

@@ -1,155 +0,0 @@
-import { APIResource } from "../core/resource.mjs";
-import * as BulkAPI from "./bulk.mjs";
-import * as Shared from "./shared.mjs";
-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.
-     *
-     * **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>;
-    /**
-     * 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>;
-    /**
-     * Get Bulk Job Users
-     */
-    listUsers(jobID: string, query?: BulkListUsersParams | null | undefined, options?: RequestOptions): APIPromise<BulkListUsersResponse>;
-    /**
-     * Get a bulk job
-     */
-    retrieveJob(jobID: string, options?: RequestOptions): APIPromise<BulkRetrieveJobResponse>;
-    /**
-     * Run a bulk job
-     */
-    runJob(jobID: string, options?: RequestOptions): APIPromise<void>;
-}
-/**
- * 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;
-    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;
-    /**
-     * 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 {
-    jobId: string;
-}
-export interface BulkListUsersResponse {
-    items: Array<BulkListUsersResponse.Item>;
-    paging: Shared.Paging;
-}
-export declare namespace BulkListUsersResponse {
-    interface Item extends BulkAPI.InboundBulkMessageUser {
-        status: 'PENDING' | 'ENQUEUED' | 'ERROR';
-        messageId?: string | null;
-    }
-}
-export interface BulkRetrieveJobResponse {
-    job: BulkRetrieveJobResponse.Job;
-}
-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;
-        received: number;
-        status: 'CREATED' | 'PROCESSING' | 'COMPLETED' | 'ERROR';
-    }
-}
-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 {
-    /**
-     * A unique identifier that allows for fetching the next set of users added to the
-     * bulk job
-     */
-    cursor?: string | null;
-}
-export declare namespace Bulk {
-    export { type InboundBulkMessage as InboundBulkMessage, type InboundBulkMessageUser as InboundBulkMessageUser, type BulkCreateJobResponse as BulkCreateJobResponse, type BulkListUsersResponse as BulkListUsersResponse, type BulkRetrieveJobResponse as BulkRetrieveJobResponse, type BulkAddUsersParams as BulkAddUsersParams, type BulkCreateJobParams as BulkCreateJobParams, type BulkListUsersParams as BulkListUsersParams, };
-}
-//# sourceMappingURL=bulk.d.mts.map

package/resources/bulk.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,OAAO,mBAAe;AAClC,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,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

@@ -1,155 +0,0 @@
-import { APIResource } from "../core/resource.js";
-import * as BulkAPI from "./bulk.js";
-import * as Shared from "./shared.js";
-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.
-     *
-     * **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>;
-    /**
-     * 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>;
-    /**
-     * Get Bulk Job Users
-     */
-    listUsers(jobID: string, query?: BulkListUsersParams | null | undefined, options?: RequestOptions): APIPromise<BulkListUsersResponse>;
-    /**
-     * Get a bulk job
-     */
-    retrieveJob(jobID: string, options?: RequestOptions): APIPromise<BulkRetrieveJobResponse>;
-    /**
-     * Run a bulk job
-     */
-    runJob(jobID: string, options?: RequestOptions): APIPromise<void>;
-}
-/**
- * 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;
-    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;
-    /**
-     * 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 {
-    jobId: string;
-}
-export interface BulkListUsersResponse {
-    items: Array<BulkListUsersResponse.Item>;
-    paging: Shared.Paging;
-}
-export declare namespace BulkListUsersResponse {
-    interface Item extends BulkAPI.InboundBulkMessageUser {
-        status: 'PENDING' | 'ENQUEUED' | 'ERROR';
-        messageId?: string | null;
-    }
-}
-export interface BulkRetrieveJobResponse {
-    job: BulkRetrieveJobResponse.Job;
-}
-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;
-        received: number;
-        status: 'CREATED' | 'PROCESSING' | 'COMPLETED' | 'ERROR';
-    }
-}
-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 {
-    /**
-     * A unique identifier that allows for fetching the next set of users added to the
-     * bulk job
-     */
-    cursor?: string | null;
-}
-export declare namespace Bulk {
-    export { type InboundBulkMessage as InboundBulkMessage, type InboundBulkMessageUser as InboundBulkMessageUser, type BulkCreateJobResponse as BulkCreateJobResponse, type BulkListUsersResponse as BulkListUsersResponse, type BulkRetrieveJobResponse as BulkRetrieveJobResponse, type BulkAddUsersParams as BulkAddUsersParams, type BulkCreateJobParams as BulkCreateJobParams, type BulkListUsersParams as BulkListUsersParams, };
-}
-//# sourceMappingURL=bulk.d.ts.map

package/resources/bulk.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,OAAO,kBAAe;AAClC,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,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

@@ -1,58 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Bulk = void 0;
-const resource_1 = require("../core/resource.js");
-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.
-     *
-     * **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}`, {
-            body,
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
-    /**
-     * 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 });
-    }
-    /**
-     * Get Bulk Job Users
-     */
-    listUsers(jobID, query = {}, options) {
-        return this._client.get((0, path_1.path) `/bulk/${jobID}/users`, { query, ...options });
-    }
-    /**
-     * Get a bulk job
-     */
-    retrieveJob(jobID, options) {
-        return this._client.get((0, path_1.path) `/bulk/${jobID}`, options);
-    }
-    /**
-     * Run a bulk job
-     */
-    runJob(jobID, options) {
-        return this._client.post((0, path_1.path) `/bulk/${jobID}/run`, {
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
-}
-exports.Bulk = Bulk;
-//# sourceMappingURL=bulk.js.map

package/resources/bulk.js.map

@@ -1 +0,0 @@
-{"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

@@ -1,54 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../core/resource.mjs";
-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.
-     *
-     * **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}`, {
-            body,
-            ...options,
-            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
-    /**
-     * 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 });
-    }
-    /**
-     * Get Bulk Job Users
-     */
-    listUsers(jobID, query = {}, options) {
-        return this._client.get(path `/bulk/${jobID}/users`, { query, ...options });
-    }
-    /**
-     * Get a bulk job
-     */
-    retrieveJob(jobID, options) {
-        return this._client.get(path `/bulk/${jobID}`, options);
-    }
-    /**
-     * Run a bulk job
-     */
-    runJob(jobID, options) {
-        return this._client.post(path `/bulk/${jobID}/run`, {
-            ...options,
-            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
-}
-//# sourceMappingURL=bulk.mjs.map

package/resources/bulk.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../src/resources/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,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"}