@zavudev/sdk 0.7.0 → 0.9.0

package/resources/broadcasts/broadcasts.d.ts

@@ -0,0 +1,361 @@
+import { APIResource } from "../../core/resource.js";
+import * as ContactsAPI from "./contacts.js";
+import { ContactAddParams, ContactAddResponse, ContactListParams, ContactRemoveParams, Contacts } from "./contacts.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { Cursor, type CursorParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Broadcasts extends APIResource {
+    contacts: ContactsAPI.Contacts;
+    /**
+     * Create a new broadcast campaign. Add contacts after creation, then send.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.create({
+     *   channel: 'sms',
+     *   name: 'Black Friday Sale',
+     *   text: 'Hi {{name}}, check out our Black Friday deals! Use code FRIDAY20 for 20% off.',
+     * });
+     * ```
+     */
+    create(body: BroadcastCreateParams, options?: RequestOptions): APIPromise<BroadcastCreateResponse>;
+    /**
+     * Get broadcast
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.retrieve(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    retrieve(broadcastID: string, options?: RequestOptions): APIPromise<BroadcastRetrieveResponse>;
+    /**
+     * Update a broadcast in draft status.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.update(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    update(broadcastID: string, body: BroadcastUpdateParams, options?: RequestOptions): APIPromise<BroadcastUpdateResponse>;
+    /**
+     * List broadcasts for this project.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const broadcast of client.broadcasts.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: BroadcastListParams | null | undefined, options?: RequestOptions): PagePromise<BroadcastsCursor, Broadcast>;
+    /**
+     * Delete a broadcast in draft status.
+     *
+     * @example
+     * ```ts
+     * await client.broadcasts.delete('broadcastId');
+     * ```
+     */
+    delete(broadcastID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Cancel a broadcast. Pending contacts will be skipped, but already queued
+     * messages may still be delivered.
+     *
+     * @example
+     * ```ts
+     * const response = await client.broadcasts.cancel(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    cancel(broadcastID: string, options?: RequestOptions): APIPromise<BroadcastCancelResponse>;
+    /**
+     * Get real-time progress of a broadcast including delivery counts and estimated
+     * completion time.
+     *
+     * @example
+     * ```ts
+     * const broadcastProgress = await client.broadcasts.progress(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    progress(broadcastID: string, options?: RequestOptions): APIPromise<BroadcastProgress>;
+    /**
+     * Start sending the broadcast immediately or schedule for later. Reserves the
+     * estimated cost from your balance.
+     *
+     * @example
+     * ```ts
+     * const response = await client.broadcasts.send(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    send(broadcastID: string, body?: BroadcastSendParams | null | undefined, options?: RequestOptions): APIPromise<BroadcastSendResponse>;
+}
+export type BroadcastsCursor = Cursor<Broadcast>;
+export type BroadcastContactsCursor = Cursor<BroadcastContact>;
+export interface Broadcast {
+    id: string;
+    /**
+     * Broadcast delivery channel.
+     */
+    channel: BroadcastChannel;
+    createdAt: string;
+    /**
+     * Type of message for broadcast.
+     */
+    messageType: BroadcastMessageType;
+    name: string;
+    /**
+     * Current status of the broadcast.
+     */
+    status: BroadcastStatus;
+    /**
+     * Total number of contacts in the broadcast.
+     */
+    totalContacts: number;
+    /**
+     * Actual cost so far in USD.
+     */
+    actualCost?: number | null;
+    completedAt?: string;
+    /**
+     * Content for non-text broadcast message types.
+     */
+    content?: BroadcastContent;
+    deliveredCount?: number;
+    emailSubject?: string;
+    /**
+     * Estimated total cost in USD.
+     */
+    estimatedCost?: number | null;
+    failedCount?: number;
+    metadata?: {
+        [key: string]: string;
+    };
+    pendingCount?: number;
+    /**
+     * Amount reserved from balance in USD.
+     */
+    reservedAmount?: number | null;
+    scheduledAt?: string;
+    senderId?: string;
+    sendingCount?: number;
+    startedAt?: string;
+    text?: string;
+    updatedAt?: string;
+}
+/**
+ * Broadcast delivery channel.
+ */
+export type BroadcastChannel = 'sms' | 'whatsapp' | 'email';
+export interface BroadcastContact {
+    id: string;
+    createdAt: string;
+    recipient: string;
+    recipientType: 'phone' | 'email';
+    /**
+     * Status of a contact within a broadcast.
+     */
+    status: BroadcastContactStatus;
+    cost?: number | null;
+    errorCode?: string;
+    errorMessage?: string;
+    /**
+     * Associated message ID after processing.
+     */
+    messageId?: string;
+    processedAt?: string;
+    templateVariables?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Status of a contact within a broadcast.
+ */
+export type BroadcastContactStatus = 'pending' | 'queued' | 'sending' | 'delivered' | 'failed' | 'skipped';
+/**
+ * Content for non-text broadcast message types.
+ */
+export interface BroadcastContent {
+    /**
+     * Filename for documents.
+     */
+    filename?: string;
+    /**
+     * Media ID if already uploaded.
+     */
+    mediaId?: string;
+    /**
+     * URL of the media file.
+     */
+    mediaUrl?: string;
+    /**
+     * MIME type of the media.
+     */
+    mimeType?: string;
+    /**
+     * Template ID for template messages.
+     */
+    templateId?: string;
+    /**
+     * Default template variables (can be overridden per contact).
+     */
+    templateVariables?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Type of message for broadcast.
+ */
+export type BroadcastMessageType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'template';
+export interface BroadcastProgress {
+    broadcastId: string;
+    /**
+     * Successfully delivered.
+     */
+    delivered: number;
+    /**
+     * Failed to deliver.
+     */
+    failed: number;
+    /**
+     * Not yet queued for sending.
+     */
+    pending: number;
+    /**
+     * Percentage complete (0-100).
+     */
+    percentComplete: number;
+    /**
+     * Currently being sent.
+     */
+    sending: number;
+    /**
+     * Skipped (broadcast cancelled).
+     */
+    skipped: number;
+    /**
+     * Current status of the broadcast.
+     */
+    status: BroadcastStatus;
+    /**
+     * Total contacts in broadcast.
+     */
+    total: number;
+    /**
+     * Actual cost so far in USD.
+     */
+    actualCost?: number | null;
+    estimatedCompletionAt?: string;
+    /**
+     * Estimated total cost in USD.
+     */
+    estimatedCost?: number | null;
+    /**
+     * Amount reserved from balance in USD.
+     */
+    reservedAmount?: number | null;
+    startedAt?: string;
+}
+/**
+ * Current status of the broadcast.
+ */
+export type BroadcastStatus = 'draft' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'cancelled' | 'failed';
+export interface BroadcastCreateResponse {
+    broadcast: Broadcast;
+}
+export interface BroadcastRetrieveResponse {
+    broadcast: Broadcast;
+}
+export interface BroadcastUpdateResponse {
+    broadcast: Broadcast;
+}
+export interface BroadcastCancelResponse {
+    broadcast: Broadcast;
+}
+export interface BroadcastSendResponse {
+    broadcast: Broadcast;
+}
+export interface BroadcastCreateParams {
+    /**
+     * Broadcast delivery channel.
+     */
+    channel: BroadcastChannel;
+    /**
+     * Name of the broadcast campaign.
+     */
+    name: string;
+    /**
+     * Content for non-text broadcast message types.
+     */
+    content?: BroadcastContent;
+    /**
+     * HTML body for email broadcasts.
+     */
+    emailHtmlBody?: string;
+    /**
+     * Email subject line. Required for email broadcasts.
+     */
+    emailSubject?: string;
+    /**
+     * Idempotency key to prevent duplicate broadcasts.
+     */
+    idempotencyKey?: string;
+    /**
+     * Type of message for broadcast.
+     */
+    messageType?: BroadcastMessageType;
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * Schedule the broadcast for future delivery.
+     */
+    scheduledAt?: string;
+    /**
+     * Sender profile ID. Uses default sender if omitted.
+     */
+    senderId?: string;
+    /**
+     * Text content or caption. Supports template variables: {{name}}, {{1}}, etc.
+     */
+    text?: string;
+}
+export interface BroadcastUpdateParams {
+    /**
+     * Content for non-text broadcast message types.
+     */
+    content?: BroadcastContent;
+    emailHtmlBody?: string;
+    emailSubject?: string;
+    metadata?: {
+        [key: string]: string;
+    };
+    name?: string;
+    text?: string;
+}
+export interface BroadcastListParams extends CursorParams {
+    /**
+     * Current status of the broadcast.
+     */
+    status?: BroadcastStatus;
+}
+export interface BroadcastSendParams {
+    /**
+     * Schedule for future delivery. Omit to send immediately.
+     */
+    scheduledAt?: string;
+}
+export declare namespace Broadcasts {
+    export { type Broadcast as Broadcast, type BroadcastChannel as BroadcastChannel, type BroadcastContact as BroadcastContact, type BroadcastContactStatus as BroadcastContactStatus, type BroadcastContent as BroadcastContent, type BroadcastMessageType as BroadcastMessageType, type BroadcastProgress as BroadcastProgress, type BroadcastStatus as BroadcastStatus, type BroadcastCreateResponse as BroadcastCreateResponse, type BroadcastRetrieveResponse as BroadcastRetrieveResponse, type BroadcastUpdateResponse as BroadcastUpdateResponse, type BroadcastCancelResponse as BroadcastCancelResponse, type BroadcastSendResponse as BroadcastSendResponse, type BroadcastsCursor as BroadcastsCursor, type BroadcastCreateParams as BroadcastCreateParams, type BroadcastUpdateParams as BroadcastUpdateParams, type BroadcastListParams as BroadcastListParams, type BroadcastSendParams as BroadcastSendParams, };
+    export { Contacts as Contacts, type ContactAddResponse as ContactAddResponse, type ContactListParams as ContactListParams, type ContactAddParams as ContactAddParams, type ContactRemoveParams as ContactRemoveParams, };
+}
+//# sourceMappingURL=broadcasts.d.ts.map

package/resources/broadcasts/broadcasts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcasts.d.ts","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIlG;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAI9F;;;;;;;;;OASG;IACH,MAAM,CACJ,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gBAAgB,EAAE,SAAS,CAAC;IAI3C;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOvE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;;;;;;;;OAUG;IACH,IAAI,CACF,WAAW,EAAE,MAAM,EACnB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAEjD,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE/D,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAE1B,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,oBAAoB,CAAC;IAElC,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,UAAU,GAAG,OAAO,CAAC;AAE5D,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;AAElG,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,OAAO,GACP,WAAW,GACX,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,GACX,QAAQ,CAAC;AAEb,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/broadcasts/broadcasts.js

@@ -0,0 +1,131 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Broadcasts = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const ContactsAPI = tslib_1.__importStar(require("./contacts.js"));
+const contacts_1 = require("./contacts.js");
+const pagination_1 = require("../../core/pagination.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class Broadcasts extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.contacts = new ContactsAPI.Contacts(this._client);
+    }
+    /**
+     * Create a new broadcast campaign. Add contacts after creation, then send.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.create({
+     *   channel: 'sms',
+     *   name: 'Black Friday Sale',
+     *   text: 'Hi {{name}}, check out our Black Friday deals! Use code FRIDAY20 for 20% off.',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/broadcasts', { body, ...options });
+    }
+    /**
+     * Get broadcast
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.retrieve(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    retrieve(broadcastID, options) {
+        return this._client.get((0, path_1.path) `/v1/broadcasts/${broadcastID}`, options);
+    }
+    /**
+     * Update a broadcast in draft status.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.update(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    update(broadcastID, body, options) {
+        return this._client.patch((0, path_1.path) `/v1/broadcasts/${broadcastID}`, { body, ...options });
+    }
+    /**
+     * List broadcasts for this project.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const broadcast of client.broadcasts.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/broadcasts', (pagination_1.Cursor), { query, ...options });
+    }
+    /**
+     * Delete a broadcast in draft status.
+     *
+     * @example
+     * ```ts
+     * await client.broadcasts.delete('broadcastId');
+     * ```
+     */
+    delete(broadcastID, options) {
+        return this._client.delete((0, path_1.path) `/v1/broadcasts/${broadcastID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Cancel a broadcast. Pending contacts will be skipped, but already queued
+     * messages may still be delivered.
+     *
+     * @example
+     * ```ts
+     * const response = await client.broadcasts.cancel(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    cancel(broadcastID, options) {
+        return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/cancel`, options);
+    }
+    /**
+     * Get real-time progress of a broadcast including delivery counts and estimated
+     * completion time.
+     *
+     * @example
+     * ```ts
+     * const broadcastProgress = await client.broadcasts.progress(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    progress(broadcastID, options) {
+        return this._client.get((0, path_1.path) `/v1/broadcasts/${broadcastID}/progress`, options);
+    }
+    /**
+     * Start sending the broadcast immediately or schedule for later. Reserves the
+     * estimated cost from your balance.
+     *
+     * @example
+     * ```ts
+     * const response = await client.broadcasts.send(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    send(broadcastID, body = {}, options) {
+        return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/send`, { body, ...options });
+    }
+}
+exports.Broadcasts = Broadcasts;
+Broadcasts.Contacts = contacts_1.Contacts;
+//# sourceMappingURL=broadcasts.js.map

package/resources/broadcasts/broadcasts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcasts.js","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CAMoB;AAEpB,yDAA+E;AAC/E,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmI1E,CAAC;IAjIC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,WAAmB,EACnB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,mBAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE;YAC9D,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;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,WAAmB,EACnB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AApID,gCAoIC;AAkVD,UAAU,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}

package/resources/broadcasts/broadcasts.mjs

@@ -0,0 +1,126 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as ContactsAPI from "./contacts.mjs";
+import { Contacts, } from "./contacts.mjs";
+import { Cursor } from "../../core/pagination.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Broadcasts extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.contacts = new ContactsAPI.Contacts(this._client);
+    }
+    /**
+     * Create a new broadcast campaign. Add contacts after creation, then send.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.create({
+     *   channel: 'sms',
+     *   name: 'Black Friday Sale',
+     *   text: 'Hi {{name}}, check out our Black Friday deals! Use code FRIDAY20 for 20% off.',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/broadcasts', { body, ...options });
+    }
+    /**
+     * Get broadcast
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.retrieve(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    retrieve(broadcastID, options) {
+        return this._client.get(path `/v1/broadcasts/${broadcastID}`, options);
+    }
+    /**
+     * Update a broadcast in draft status.
+     *
+     * @example
+     * ```ts
+     * const broadcast = await client.broadcasts.update(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    update(broadcastID, body, options) {
+        return this._client.patch(path `/v1/broadcasts/${broadcastID}`, { body, ...options });
+    }
+    /**
+     * List broadcasts for this project.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const broadcast of client.broadcasts.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/broadcasts', (Cursor), { query, ...options });
+    }
+    /**
+     * Delete a broadcast in draft status.
+     *
+     * @example
+     * ```ts
+     * await client.broadcasts.delete('broadcastId');
+     * ```
+     */
+    delete(broadcastID, options) {
+        return this._client.delete(path `/v1/broadcasts/${broadcastID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Cancel a broadcast. Pending contacts will be skipped, but already queued
+     * messages may still be delivered.
+     *
+     * @example
+     * ```ts
+     * const response = await client.broadcasts.cancel(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    cancel(broadcastID, options) {
+        return this._client.post(path `/v1/broadcasts/${broadcastID}/cancel`, options);
+    }
+    /**
+     * Get real-time progress of a broadcast including delivery counts and estimated
+     * completion time.
+     *
+     * @example
+     * ```ts
+     * const broadcastProgress = await client.broadcasts.progress(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    progress(broadcastID, options) {
+        return this._client.get(path `/v1/broadcasts/${broadcastID}/progress`, options);
+    }
+    /**
+     * Start sending the broadcast immediately or schedule for later. Reserves the
+     * estimated cost from your balance.
+     *
+     * @example
+     * ```ts
+     * const response = await client.broadcasts.send(
+     *   'broadcastId',
+     * );
+     * ```
+     */
+    send(broadcastID, body = {}, options) {
+        return this._client.post(path `/v1/broadcasts/${broadcastID}/send`, { body, ...options });
+    }
+}
+Broadcasts.Contacts = Contacts;
+//# sourceMappingURL=broadcasts.mjs.map

package/resources/broadcasts/broadcasts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcasts.mjs","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAKL,QAAQ,GACT;OAEM,EAAE,MAAM,EAAkC;OAC1C,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmI1E,CAAC;IAjIC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,WAAmB,EACnB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,MAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE;YAC9D,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;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,WAAmB,EACnB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAkVD,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC"}