@zavudev/sdk 0.56.0 → 0.58.0

package/resources/broadcasts/broadcasts.js

@@ -1,30 +1,24 @@
 "use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 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");
+const ContactsAPI = tslib_1.__importStar(require("./contacts.js"));
 class Broadcasts extends resource_1.APIResource {
     constructor() {
         super(...arguments);
         this.contacts = new ContactsAPI.Contacts(this._client);
     }
     /**
+     * Create broadcast
+     *
      * 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.',
-     * });
-     * ```
+     * `POST /v1/broadcasts`
      */
     create(body, options) {
         return this._client.post('/v1/broadcasts', { body, ...options });
@@ -32,50 +26,37 @@ class Broadcasts extends resource_1.APIResource {
     /**
      * Get broadcast
      *
-     * @example
-     * ```ts
-     * const broadcast = await client.broadcasts.retrieve(
-     *   'broadcastId',
-     * );
-     * ```
+     * `GET /v1/broadcasts/{broadcastId}`
      */
     retrieve(broadcastID, options) {
         return this._client.get((0, path_1.path) `/v1/broadcasts/${broadcastID}`, options);
     }
     /**
+     * Update broadcast
+     *
      * Update a broadcast in draft status.
      *
-     * @example
-     * ```ts
-     * const broadcast = await client.broadcasts.update(
-     *   'broadcastId',
-     * );
-     * ```
+     * `PATCH /v1/broadcasts/{broadcastId}`
      */
     update(broadcastID, body, options) {
         return this._client.patch((0, path_1.path) `/v1/broadcasts/${broadcastID}`, { body, ...options });
     }
     /**
+     * List broadcasts
+     *
      * List broadcasts for this project.
      *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const broadcast of client.broadcasts.list()) {
-     *   // ...
-     * }
-     * ```
+     * `GET /v1/broadcasts`
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/broadcasts', (pagination_1.Cursor), { query, ...options });
     }
     /**
+     * Delete broadcast
+     *
      * Delete a broadcast in draft status.
      *
-     * @example
-     * ```ts
-     * await client.broadcasts.delete('broadcastId');
-     * ```
+     * `DELETE /v1/broadcasts/{broadcastId}`
      */
     delete(broadcastID, options) {
         return this._client.delete((0, path_1.path) `/v1/broadcasts/${broadcastID}`, {
@@ -84,112 +65,110 @@ class Broadcasts extends resource_1.APIResource {
         });
     }
     /**
+     * Cancel broadcast
+     *
      * 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',
-     * );
-     * ```
+     * A broadcast can be cancelled from `draft`, `pending_review`,
+     * `pending_admin_review`, `approved`, `rejected`, `escalated`, `scheduled` and
+     * `sending`. Any balance reserved for it is released. A review still running when
+     * it is cancelled cannot bring it back.
+     *
+     * `POST /v1/broadcasts/{broadcastId}/cancel`
      */
     cancel(broadcastID, options) {
         return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/cancel`, options);
     }
     /**
+     * Escalate to manual review
+     *
      * Request manual review by the Zavu team for a rejected broadcast. Use this after
      * automated review rejection if you believe the content is legitimate.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.escalateReview(
-     *   'broadcastId',
-     * );
-     * ```
+     * `POST /v1/broadcasts/{broadcastId}/escalate`
      */
     escalateReview(broadcastID, options) {
         return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/escalate`, options);
     }
     /**
+     * Get broadcast progress
+     *
      * Get real-time progress of a broadcast including delivery counts and estimated
      * completion time.
      *
-     * @example
-     * ```ts
-     * const broadcastProgress = await client.broadcasts.progress(
-     *   'broadcastId',
-     * );
-     * ```
+     * `GET /v1/broadcasts/{broadcastId}/progress`
      */
     progress(broadcastID, options) {
         return this._client.get((0, path_1.path) `/v1/broadcasts/${broadcastID}/progress`, options);
     }
     /**
+     * Reschedule broadcast
+     *
      * Update the scheduled time for a broadcast. The broadcast must be in scheduled
      * status.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.reschedule(
-     *   'broadcastId',
-     *   { scheduledAt: '2024-01-15T14:00:00Z' },
-     * );
-     * ```
+     * `PATCH /v1/broadcasts/{broadcastId}/schedule`
      */
     reschedule(broadcastID, body, options) {
         return this._client.patch((0, path_1.path) `/v1/broadcasts/${broadcastID}/schedule`, { body, ...options });
     }
     /**
+     * Retry broadcast review
+     *
      * Resubmit a rejected broadcast for AI review after editing content. Maximum 3
      * review attempts allowed per broadcast.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.retryReview(
-     *   'broadcastId',
-     * );
-     * ```
+     * `POST /v1/broadcasts/{broadcastId}/retry-review`
      */
     retryReview(broadcastID, options) {
         return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/retry-review`, options);
     }
     /**
+     * Send broadcast
+     *
      * Start sending the broadcast immediately or schedule for later.
      *
-     * **Verification is required to send, except on WhatsApp.** On every channel other
-     * than `whatsapp`, the team must have completed both identity verification (KYC)
-     * and business verification (KYB); passing one is not enough. A `whatsapp`
-     * broadcast requires neither: it can only be built on a template, and Meta vets
-     * the business and the content when it approves that template, so an unapproved
-     * template is refused instead. `smart` is not exempt — it can route a contact to
-     * SMS or email. Drafts can be created, edited and kept without any check. Every
-     * send path — dashboard, API and CLI alike — enforces the same rule, returning
-     * `403` with code `kyc_required` or `kyb_required` for whichever is outstanding.
+     * **Sending a broadcast needs no account verification.** Identity and business
+     * verification raise daily ceilings; neither is a permission to broadcast, on any
+     * channel. What stands in front of a broadcast is the content review below, and it
+     * applies to every send path — dashboard, API and CLI. Drafts can be created,
+     * edited and kept freely.
+     *
+     * **Email broadcasts need a paid plan.** On Free, sending or scheduling a
+     * broadcast on the `email` channel is refused with `402` and code
+     * `paid_plan_required`; drafts can still be created and edited. A `smart`
+     * broadcast is not refused: its email recipients fail individually with
+     * `errorCode` `PAID_PLAN_REQUIRED` and the others are sent. Teams created before
+     * August 1, 2026 keep their earlier terms.
+     *
+     * **Daily ceilings apply per recipient.** Each message a broadcast sends counts
+     * against the channel's daily ceiling (see `POST /v1/messages`). Once the ceiling
+     * is reached, the remaining recipients are marked `failed` with `errorCode`
+     * `DAILY_LIMIT_EXCEEDED`; they are not retried the next day.
      *
      * **Review depends on the channel, and cannot be bypassed.** A draft is submitted
      * to automated content review here; it does not go straight out. A WhatsApp
      * broadcast built on a Meta-approved template skips review (Meta already vetted
-     * the content) and begins sending. An email broadcast sends as soon as the
-     * automated review passes. Every other channel moves to `pending_admin_review` and
-     * waits for a person. If the review rejects it, use PATCH to edit the content then
-     * call POST /retry-review.
+     * the content) and begins sending. An email broadcast sends as soon as the review
+     * passes it, unless the review asks for a person. Every other channel moves to
+     * `pending_admin_review` and waits for a person. A broadcast the review refuses
+     * lands on `rejected`: use PATCH to edit the content then call POST /retry-review,
+     * or escalate it for a manual review.
+     *
+     * A broadcast is read once, on its own text, rather than per recipient. While an
+     * account's sending is suspended its recipients fail individually with `errorCode`
+     * `SENDING_SUSPENDED`; see `POST /v1/messages`.
      *
      * Calling this on a broadcast that is already `approved` or `scheduled` sends or
      * reschedules it directly, since it has already been reviewed. Reserves the
      * estimated cost from your balance.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.send(
-     *   'broadcastId',
-     * );
-     * ```
+     * `POST /v1/broadcasts/{broadcastId}/send`
      */
     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

@@ -1 +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;IA0M1E,CAAC;IAxMC;;;;;;;;;;;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,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,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;;;;;;;;;;;OAWG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;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;AA3MD,gCA2MC;AAqaD,UAAU,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
+{"version":3,"file":"broadcasts.js","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":";AAAA,6FAA6F;;;;AAE7F,qDAAkD;AAElD,yDAA4D;AAC5D,uDAAsD;AAEtD,uDAAiD;AAEjD,mEAA0C;AAS1C,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuL1E,CAAC;IArLC;;;;;;OAMG;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;;;;OAIG;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;;;;;;OAMG;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;;;;;;OAMG;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;;;;;;OAMG;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;;;;;;;;;;;;OAYG;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;;;;;;;OAOG;IACH,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;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;;;;;;;OAOG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;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;AAxLD,gCAwLC"}

package/resources/broadcasts/broadcasts.mjs

@@ -1,26 +1,20 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 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";
+import * as ContactsAPI from "./contacts.mjs";
 export class Broadcasts extends APIResource {
     constructor() {
         super(...arguments);
         this.contacts = new ContactsAPI.Contacts(this._client);
     }
     /**
+     * Create broadcast
+     *
      * 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.',
-     * });
-     * ```
+     * `POST /v1/broadcasts`
      */
     create(body, options) {
         return this._client.post('/v1/broadcasts', { body, ...options });
@@ -28,50 +22,37 @@ export class Broadcasts extends APIResource {
     /**
      * Get broadcast
      *
-     * @example
-     * ```ts
-     * const broadcast = await client.broadcasts.retrieve(
-     *   'broadcastId',
-     * );
-     * ```
+     * `GET /v1/broadcasts/{broadcastId}`
      */
     retrieve(broadcastID, options) {
         return this._client.get(path `/v1/broadcasts/${broadcastID}`, options);
     }
     /**
+     * Update broadcast
+     *
      * Update a broadcast in draft status.
      *
-     * @example
-     * ```ts
-     * const broadcast = await client.broadcasts.update(
-     *   'broadcastId',
-     * );
-     * ```
+     * `PATCH /v1/broadcasts/{broadcastId}`
      */
     update(broadcastID, body, options) {
         return this._client.patch(path `/v1/broadcasts/${broadcastID}`, { body, ...options });
     }
     /**
+     * List broadcasts
+     *
      * List broadcasts for this project.
      *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const broadcast of client.broadcasts.list()) {
-     *   // ...
-     * }
-     * ```
+     * `GET /v1/broadcasts`
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/broadcasts', (Cursor), { query, ...options });
     }
     /**
+     * Delete broadcast
+     *
      * Delete a broadcast in draft status.
      *
-     * @example
-     * ```ts
-     * await client.broadcasts.delete('broadcastId');
-     * ```
+     * `DELETE /v1/broadcasts/{broadcastId}`
      */
     delete(broadcastID, options) {
         return this._client.delete(path `/v1/broadcasts/${broadcastID}`, {
@@ -80,111 +61,109 @@ export class Broadcasts extends APIResource {
         });
     }
     /**
+     * Cancel broadcast
+     *
      * 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',
-     * );
-     * ```
+     * A broadcast can be cancelled from `draft`, `pending_review`,
+     * `pending_admin_review`, `approved`, `rejected`, `escalated`, `scheduled` and
+     * `sending`. Any balance reserved for it is released. A review still running when
+     * it is cancelled cannot bring it back.
+     *
+     * `POST /v1/broadcasts/{broadcastId}/cancel`
      */
     cancel(broadcastID, options) {
         return this._client.post(path `/v1/broadcasts/${broadcastID}/cancel`, options);
     }
     /**
+     * Escalate to manual review
+     *
      * Request manual review by the Zavu team for a rejected broadcast. Use this after
      * automated review rejection if you believe the content is legitimate.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.escalateReview(
-     *   'broadcastId',
-     * );
-     * ```
+     * `POST /v1/broadcasts/{broadcastId}/escalate`
      */
     escalateReview(broadcastID, options) {
         return this._client.post(path `/v1/broadcasts/${broadcastID}/escalate`, options);
     }
     /**
+     * Get broadcast progress
+     *
      * Get real-time progress of a broadcast including delivery counts and estimated
      * completion time.
      *
-     * @example
-     * ```ts
-     * const broadcastProgress = await client.broadcasts.progress(
-     *   'broadcastId',
-     * );
-     * ```
+     * `GET /v1/broadcasts/{broadcastId}/progress`
      */
     progress(broadcastID, options) {
         return this._client.get(path `/v1/broadcasts/${broadcastID}/progress`, options);
     }
     /**
+     * Reschedule broadcast
+     *
      * Update the scheduled time for a broadcast. The broadcast must be in scheduled
      * status.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.reschedule(
-     *   'broadcastId',
-     *   { scheduledAt: '2024-01-15T14:00:00Z' },
-     * );
-     * ```
+     * `PATCH /v1/broadcasts/{broadcastId}/schedule`
      */
     reschedule(broadcastID, body, options) {
         return this._client.patch(path `/v1/broadcasts/${broadcastID}/schedule`, { body, ...options });
     }
     /**
+     * Retry broadcast review
+     *
      * Resubmit a rejected broadcast for AI review after editing content. Maximum 3
      * review attempts allowed per broadcast.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.retryReview(
-     *   'broadcastId',
-     * );
-     * ```
+     * `POST /v1/broadcasts/{broadcastId}/retry-review`
      */
     retryReview(broadcastID, options) {
         return this._client.post(path `/v1/broadcasts/${broadcastID}/retry-review`, options);
     }
     /**
+     * Send broadcast
+     *
      * Start sending the broadcast immediately or schedule for later.
      *
-     * **Verification is required to send, except on WhatsApp.** On every channel other
-     * than `whatsapp`, the team must have completed both identity verification (KYC)
-     * and business verification (KYB); passing one is not enough. A `whatsapp`
-     * broadcast requires neither: it can only be built on a template, and Meta vets
-     * the business and the content when it approves that template, so an unapproved
-     * template is refused instead. `smart` is not exempt — it can route a contact to
-     * SMS or email. Drafts can be created, edited and kept without any check. Every
-     * send path — dashboard, API and CLI alike — enforces the same rule, returning
-     * `403` with code `kyc_required` or `kyb_required` for whichever is outstanding.
+     * **Sending a broadcast needs no account verification.** Identity and business
+     * verification raise daily ceilings; neither is a permission to broadcast, on any
+     * channel. What stands in front of a broadcast is the content review below, and it
+     * applies to every send path — dashboard, API and CLI. Drafts can be created,
+     * edited and kept freely.
+     *
+     * **Email broadcasts need a paid plan.** On Free, sending or scheduling a
+     * broadcast on the `email` channel is refused with `402` and code
+     * `paid_plan_required`; drafts can still be created and edited. A `smart`
+     * broadcast is not refused: its email recipients fail individually with
+     * `errorCode` `PAID_PLAN_REQUIRED` and the others are sent. Teams created before
+     * August 1, 2026 keep their earlier terms.
+     *
+     * **Daily ceilings apply per recipient.** Each message a broadcast sends counts
+     * against the channel's daily ceiling (see `POST /v1/messages`). Once the ceiling
+     * is reached, the remaining recipients are marked `failed` with `errorCode`
+     * `DAILY_LIMIT_EXCEEDED`; they are not retried the next day.
      *
      * **Review depends on the channel, and cannot be bypassed.** A draft is submitted
      * to automated content review here; it does not go straight out. A WhatsApp
      * broadcast built on a Meta-approved template skips review (Meta already vetted
-     * the content) and begins sending. An email broadcast sends as soon as the
-     * automated review passes. Every other channel moves to `pending_admin_review` and
-     * waits for a person. If the review rejects it, use PATCH to edit the content then
-     * call POST /retry-review.
+     * the content) and begins sending. An email broadcast sends as soon as the review
+     * passes it, unless the review asks for a person. Every other channel moves to
+     * `pending_admin_review` and waits for a person. A broadcast the review refuses
+     * lands on `rejected`: use PATCH to edit the content then call POST /retry-review,
+     * or escalate it for a manual review.
+     *
+     * A broadcast is read once, on its own text, rather than per recipient. While an
+     * account's sending is suspended its recipients fail individually with `errorCode`
+     * `SENDING_SUSPENDED`; see `POST /v1/messages`.
      *
      * Calling this on a broadcast that is already `approved` or `scheduled` sends or
      * reschedules it directly, since it has already been reviewed. Reserves the
      * estimated cost from your balance.
      *
-     * @example
-     * ```ts
-     * const response = await client.broadcasts.send(
-     *   'broadcastId',
-     * );
-     * ```
+     * `POST /v1/broadcasts/{broadcastId}/send`
      */
     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

@@ -1 +1 @@
-{"version":3,"file":"broadcasts.mjs","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAKL,QAAQ,GACT,uBAAmB;AAEpB,OAAO,EAAE,MAAM,EAAkC,kCAA8B;AAC/E,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0M1E,CAAC;IAxMC;;;;;;;;;;;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,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,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;;;;;;;;;;;OAWG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;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;AAqaD,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"broadcasts.mjs","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAE7F,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,MAAM,EAAe,kCAA8B;AAC5D,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,OAAO,KAAK,WAAW,uBAAmB;AAS1C,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuL1E,CAAC;IArLC;;;;;;OAMG;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;;;;OAIG;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;;;;;;OAMG;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;;;;;;OAMG;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;;;;;;OAMG;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;;;;;;;;;;;;OAYG;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;;;;;;;OAOG;IACH,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;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;;;;;;;OAOG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;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"}