@talqing/sdk 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -540,8 +540,9 @@ export class Batches extends HeyApiClient {
540
540
  *
541
541
  * List outbound calling batches, newest first, with live progress.
542
542
  *
543
- * `counts` breaks the recipient list down by outcome and `next_dial_at` says
544
- * when a batch that is not dialling will start again — the clock, not a fault.
543
+ * `counts` breaks the recipient list down by outcome; `next_dial_at` and
544
+ * `next_dial_reason` say when a batch that is not dialling will start again and
545
+ * why — its start time, its window or today's limit, not a fault.
545
546
  * A `failed` batch carries `failure_reason`: the circuit breaker stopped it
546
547
  * after ten consecutive setup failures.
547
548
  */
@@ -577,8 +578,9 @@ export class Batches extends HeyApiClient {
577
578
  * greeting. A number that appears twice is refused with both row numbers.
578
579
  *
579
580
  * `start_at` and `calling_window` schedule it in the timezone you give;
580
- * `max_concurrency` and `max_attempts` pace it. A number that was reached is
581
- * never called twice.
581
+ * `max_concurrency`, `max_attempts`, `dial_gap_seconds` and `dial_daily_cap`
582
+ * (a fixed limit or a ramp) pace it. A number that was reached is never
583
+ * called twice.
582
584
  *
583
585
  * Two things you would otherwise learn from an invoice:
584
586
  *
@@ -2217,7 +2219,8 @@ export class Sends extends HeyApiClient {
2217
2219
  * drafting runs. It cannot be live beside another send of the batch (409).
2218
2220
  *
2219
2221
  * `start_at` schedules it, `window` holds it to business hours, and
2220
- * `send_gap_seconds` and `send_daily_cap` pace the whole batch. Everything
2222
+ * `send_gap_seconds` and `send_daily_cap` (a fixed limit or a ramp) pace the
2223
+ * whole batch. Everything
2221
2224
  * omitted comes from the batch. Cancelling it leaves the unsent rows as drafts.
2222
2225
  */
2223
2226
  create(parameters, options) {
@@ -2453,7 +2456,7 @@ export class Batches2 extends HeyApiClient {
2453
2456
  * One batch: its policy, its per-status counts and what drafting has cost.
2454
2457
  *
2455
2458
  * `drafted_versions` says which published version of the task wrote how many
2456
- * rows, and `sent_today` how much of `send_daily_cap` is left today.
2459
+ * rows, and `sent_today` how much of `send_daily_cap_today` is left.
2457
2460
  */
2458
2461
  get(parameters, options) {
2459
2462
  const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }] }]);
@@ -4962,8 +4965,8 @@ export class Batches3 extends HeyApiClient {
4962
4965
  * Send every ready row. **This messages real people and cannot be undone.**
4963
4966
  *
4964
4967
  * `start_at` schedules it, `window` holds it to business hours, and
4965
- * `send_daily_cap` (default 250, Meta's lowest tier) and `send_gap_seconds`
4966
- * pace it.
4968
+ * `send_daily_cap` (default a fixed 250, Meta's lowest tier; or a ramp) and
4969
+ * `send_gap_seconds` pace it.
4967
4970
  */
4968
4971
  send(parameters, options) {
4969
4972
  const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'sendWhatsAppBatchRequest', map: 'body' }] }]);