@talqing/sdk 0.7.0 → 0.8.0

package/dist/cjs/gen/sdk.gen.js

@@ -551,8 +551,9 @@ class Batches extends HeyApiClient {
      *
      * List outbound calling batches, newest first, with live progress.
      *
-     * `counts` breaks the recipient list down by outcome and `next_dial_at` says
-     * when a batch that is not dialling will start again — the clock, not a fault.
+     * `counts` breaks the recipient list down by outcome; `next_dial_at` and
+     * `next_dial_reason` say when a batch that is not dialling will start again and
+     * why — its start time, its window or today's limit, not a fault.
      * A `failed` batch carries `failure_reason`: the circuit breaker stopped it
      * after ten consecutive setup failures.
      */
@@ -588,8 +589,9 @@ class Batches extends HeyApiClient {
      * greeting. A number that appears twice is refused with both row numbers.
      *
      * `start_at` and `calling_window` schedule it in the timezone you give;
-     * `max_concurrency` and `max_attempts` pace it. A number that was reached is
-     * never called twice.
+     * `max_concurrency`, `max_attempts`, `dial_gap_seconds` and `dial_daily_cap`
+     * (a fixed limit or a ramp) pace it. A number that was reached is never
+     * called twice.
      *
      * Two things you would otherwise learn from an invoice:
      *
@@ -2251,7 +2253,8 @@ class Sends extends HeyApiClient {
      * drafting runs. It cannot be live beside another send of the batch (409).
      *
      * `start_at` schedules it, `window` holds it to business hours, and
-     * `send_gap_seconds` and `send_daily_cap` pace the whole batch. Everything
+     * `send_gap_seconds` and `send_daily_cap` (a fixed limit or a ramp) pace the
+     * whole batch. Everything
      * omitted comes from the batch. Cancelling it leaves the unsent rows as drafts.
      */
     create(parameters, options) {
@@ -2488,7 +2491,7 @@ class Batches2 extends HeyApiClient {
      * One batch: its policy, its per-status counts and what drafting has cost.
      *
      * `drafted_versions` says which published version of the task wrote how many
-     * rows, and `sent_today` how much of `send_daily_cap` is left today.
+     * rows, and `sent_today` how much of `send_daily_cap_today` is left.
      */
     get(parameters, options) {
         const params = (0, index_js_1.buildClientParams)([parameters], [{ args: [{ in: 'path', key: 'batch_id' }] }]);
@@ -5022,8 +5025,8 @@ class Batches3 extends HeyApiClient {
      * Send every ready row. **This messages real people and cannot be undone.**
      *
      * `start_at` schedules it, `window` holds it to business hours, and
-     * `send_daily_cap` (default 250, Meta's lowest tier) and `send_gap_seconds`
-     * pace it.
+     * `send_daily_cap` (default a fixed 250, Meta's lowest tier; or a ramp) and
+     * `send_gap_seconds` pace it.
      */
     send(parameters, options) {
         const params = (0, index_js_1.buildClientParams)([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'sendWhatsAppBatchRequest', map: 'body' }] }]);