@trycourier/courier 7.22.0 → 7.23.0

package/resources/broadcasts.d.mts

@@ -0,0 +1,381 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import * as NotificationsAPI from "./notifications/notifications.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Broadcasts extends APIResource {
+    /**
+     * Create a broadcast. Provisions a private notification template for the broadcast
+     * and returns the new broadcast in the draft state. Exactly one channel is
+     * required.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.create({
+     *   channel: 'email',
+     *   name: 'Spring Sale Announcement',
+     * });
+     * ```
+     */
+    create(body: BroadcastCreateParams, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * Retrieve a broadcast by ID. Archived broadcasts return 404.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.retrieve(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    retrieve(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * Update a broadcast's name. Content is edited via the broadcast's notification
+     * template, not this endpoint.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.update(
+     *   'broadcastId',
+     *   { name: 'Spring Sale Announcement (v2)' },
+     * );
+     * ```
+     */
+    update(broadcastID: string, body: BroadcastUpdateParams, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * List broadcasts in your workspace. Cursor-paginated; returns broadcasts
+     * newest-first.
+     *
+     * @example
+     * ```ts
+     * const broadcastListResponse =
+     *   await client.broadcasts.list();
+     * ```
+     */
+    list(query?: BroadcastListParams | null | undefined, options?: RequestOptions): APIPromise<BroadcastListResponse>;
+    /**
+     * Archive a broadcast. This is a soft delete — the archived broadcast is returned
+     * and no longer appears in list results.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.archive(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    archive(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * Cancel a broadcast's pending schedule, returning it to the draft state. Only
+     * valid for a scheduled broadcast.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.cancel(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    cancel(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * Duplicate a broadcast (and its template) into a new draft named "{source name}
+     * (copy)".
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.duplicate(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    duplicate(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * Author the broadcast's content by replacing the draft elemental content of its
+     * private notification template. The draft is published automatically when the
+     * broadcast is sent or scheduled.
+     *
+     * @example
+     * ```ts
+     * const notificationContentMutationResponse =
+     *   await client.broadcasts.putContent('broadcastId', {
+     *     content: {
+     *       version: '2022-01-01',
+     *       elements: [{ type: 'meta' }, { type: 'text' }],
+     *     },
+     *   });
+     * ```
+     */
+    putContent(broadcastID: string, body: BroadcastPutContentParams, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentMutationResponse>;
+    /**
+     * Retrieve the broadcast's content — the elemental content of its private
+     * notification template. Defaults to the working draft, since broadcast content is
+     * authored as a draft until the broadcast is sent.
+     *
+     * @example
+     * ```ts
+     * const notificationContentGetResponse =
+     *   await client.broadcasts.retrieveContent('broadcastId');
+     * ```
+     */
+    retrieveContent(broadcastID: string, query?: BroadcastRetrieveContentParams | null | undefined, options?: RequestOptions): APIPromise<NotificationsAPI.NotificationContentGetResponse>;
+    /**
+     * Schedule a broadcast for a future send to a list or audience. Publishes the
+     * broadcast template first. Not allowed once the broadcast is sending or sent. For
+     * an immediate send use POST /broadcasts/{broadcastId}/send.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.schedule(
+     *   'broadcastId',
+     *   {
+     *     recipient_id: 'aud_01kx4h2jdafq8bk9amzvy6hbv0',
+     *     recipient_type: 'audience',
+     *     scheduled_to: '2026-08-01T15:00:00',
+     *     timezone: 'America/New_York',
+     *   },
+     * );
+     * ```
+     */
+    schedule(broadcastID: string, body: BroadcastScheduleParams, options?: RequestOptions): APIPromise<Broadcast>;
+    /**
+     * Send a broadcast immediately to a list or audience. Publishes the broadcast
+     * template first. Not allowed once the broadcast is sending or sent.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.send(
+     *   'broadcastId',
+     *   {
+     *     recipient_id: 'cool-customers',
+     *     recipient_type: 'list',
+     *   },
+     * );
+     * ```
+     */
+    send(broadcastID: string, body: BroadcastSendParams, options?: RequestOptions): APIPromise<Broadcast>;
+}
+/**
+ * A broadcast — a single-channel message delivered to a known set of recipients (a
+ * list or audience).
+ */
+export interface Broadcast {
+    /**
+     * The broadcast ID (bst\_ prefix).
+     */
+    id: string;
+    /**
+     * The broadcast's delivery channel.
+     */
+    channel: 'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams';
+    /**
+     * ISO 8601 timestamp when the broadcast was created.
+     */
+    created_at: string;
+    /**
+     * Actor that created the broadcast.
+     */
+    created_by: string;
+    /**
+     * Human-readable name.
+     */
+    name: string;
+    /**
+     * Lifecycle status of the broadcast.
+     */
+    status: 'draft' | 'scheduled' | 'sending' | 'sent';
+    /**
+     * ISO 8601 timestamp of the last update.
+     */
+    updated_at: string;
+    /**
+     * Actor that last updated the broadcast.
+     */
+    updated_by: string;
+    /**
+     * ISO 8601 timestamp when the broadcast was archived, if archived.
+     */
+    archived_at?: string | null;
+    /**
+     * Actor that archived the broadcast, if archived.
+     */
+    archived_by?: string | null;
+    /**
+     * The delivery schedule and recipient targeting for a broadcast.
+     */
+    schedule?: BroadcastSchedule | null;
+}
+/**
+ * Paginated list of broadcasts.
+ */
+export interface BroadcastListResponse {
+    paging: Shared.Paging;
+    results: Array<Broadcast>;
+}
+/**
+ * The delivery schedule and recipient targeting for a broadcast.
+ */
+export interface BroadcastSchedule {
+    /**
+     * ID of the target list or audience.
+     */
+    recipient_id: string;
+    /**
+     * Whether the broadcast targets a list or an audience.
+     */
+    recipient_type: 'list' | 'audience';
+    /**
+     * Wall-clock timestamp of the scheduled send, no timezone offset (e.g.
+     * "2026-07-21T20:00:00").
+     */
+    scheduled_to?: string | null;
+    /**
+     * IANA timezone for the scheduled send (e.g. America/New_York).
+     */
+    timezone?: string | null;
+}
+/**
+ * Request body for creating a broadcast.
+ */
+export interface CreateBroadcastRequest {
+    /**
+     * The single delivery channel for this broadcast.
+     */
+    channel: 'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams';
+    /**
+     * Human-readable name.
+     */
+    name: string;
+}
+/**
+ * Request body for scheduling a broadcast for a future send.
+ */
+export interface ScheduleBroadcastRequest {
+    /**
+     * ID of the target list or audience.
+     */
+    recipient_id: string;
+    /**
+     * Whether the broadcast targets a list or an audience.
+     */
+    recipient_type: 'list' | 'audience';
+    /**
+     * Wall-clock timestamp of the future send, no timezone offset (e.g.
+     * "2026-07-21T20:00:00"). The zone is given by `timezone`.
+     */
+    scheduled_to: string;
+    /**
+     * IANA timezone for the scheduled send (e.g. America/New_York).
+     */
+    timezone?: string;
+}
+/**
+ * Request body for sending a broadcast immediately.
+ */
+export interface SendBroadcastRequest {
+    /**
+     * ID of the target list or audience.
+     */
+    recipient_id: string;
+    /**
+     * Whether the broadcast targets a list or an audience.
+     */
+    recipient_type: 'list' | 'audience';
+}
+/**
+ * Request body for updating a broadcast. Only the name is mutable.
+ */
+export interface UpdateBroadcastRequest {
+    /**
+     * New human-readable name.
+     */
+    name: string;
+}
+export interface BroadcastCreateParams {
+    /**
+     * The single delivery channel for this broadcast.
+     */
+    channel: 'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams';
+    /**
+     * Human-readable name.
+     */
+    name: string;
+}
+export interface BroadcastUpdateParams {
+    /**
+     * New human-readable name.
+     */
+    name: string;
+}
+export interface BroadcastListParams {
+    /**
+     * Opaque pagination cursor from a previous response. Omit for the first page.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of results per page.
+     */
+    limit?: number;
+}
+export interface BroadcastPutContentParams {
+    /**
+     * Elemental content payload. The server defaults `version` when omitted.
+     */
+    content: BroadcastPutContentParams.Content;
+    /**
+     * Template state. Defaults to `DRAFT`.
+     */
+    state?: NotificationsAPI.NotificationTemplateState;
+}
+export declare namespace BroadcastPutContentParams {
+    /**
+     * Elemental content payload. The server defaults `version` when omitted.
+     */
+    interface Content {
+        elements: Array<Shared.ElementalNode>;
+        /**
+         * Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+         * omitted.
+         */
+        version?: string;
+    }
+}
+export interface BroadcastRetrieveContentParams {
+    /**
+     * Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
+     * `draft`.
+     */
+    version?: string;
+}
+export interface BroadcastScheduleParams {
+    /**
+     * ID of the target list or audience.
+     */
+    recipient_id: string;
+    /**
+     * Whether the broadcast targets a list or an audience.
+     */
+    recipient_type: 'list' | 'audience';
+    /**
+     * Wall-clock timestamp of the future send, no timezone offset (e.g.
+     * "2026-07-21T20:00:00"). The zone is given by `timezone`.
+     */
+    scheduled_to: string;
+    /**
+     * IANA timezone for the scheduled send (e.g. America/New_York).
+     */
+    timezone?: string;
+}
+export interface BroadcastSendParams {
+    /**
+     * ID of the target list or audience.
+     */
+    recipient_id: string;
+    /**
+     * Whether the broadcast targets a list or an audience.
+     */
+    recipient_type: 'list' | 'audience';
+}
+export declare namespace Broadcasts {
+    export { type Broadcast as Broadcast, type BroadcastListResponse as BroadcastListResponse, type BroadcastSchedule as BroadcastSchedule, type CreateBroadcastRequest as CreateBroadcastRequest, type ScheduleBroadcastRequest as ScheduleBroadcastRequest, type SendBroadcastRequest as SendBroadcastRequest, type UpdateBroadcastRequest as UpdateBroadcastRequest, type BroadcastCreateParams as BroadcastCreateParams, type BroadcastUpdateParams as BroadcastUpdateParams, type BroadcastListParams as BroadcastListParams, type BroadcastPutContentParams as BroadcastPutContentParams, type BroadcastRetrieveContentParams as BroadcastRetrieveContentParams, type BroadcastScheduleParams as BroadcastScheduleParams, type BroadcastSendParams as BroadcastSendParams, };
+}
+//# sourceMappingURL=broadcasts.d.mts.map

package/resources/broadcasts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcasts.d.mts","sourceRoot":"","sources":["../src/resources/broadcasts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,KAAK,gBAAgB,0CAAsC;AAClE,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIpF;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAI9E;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIzG;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAI7E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAI5E;;;;;;;;;;OAUG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAI/E;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,mCAAmC,CAAC;IAInE;;;;;;;;;;OAUG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,8BAA8B,CAAC;IAI9D;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC;IAIxB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAElE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAEnD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,UAAU,CAAC;IAEpC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAElE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,UAAU,CAAC;IAEpC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,UAAU,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAElE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC,OAAO,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC;CACpD;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,OAAO;QACtB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEtC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,UAAU,CAAC;IAEpC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,UAAU,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}