@talqing/sdk 0.7.0 → 0.8.0

package/dist/cjs/gen/types.gen.d.ts

@@ -1276,6 +1276,26 @@ export type CallBatchResponse = {
      * Created At
      */
     created_at: string;
+    /**
+     * Dial Daily Cap
+     */
+    dial_daily_cap: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
+    /**
+     * Dial Daily Cap Today
+     */
+    dial_daily_cap_today: number | null;
+    /**
+     * Dial Gap Seconds
+     */
+    dial_gap_seconds: number;
+    /**
+     * Dialed Today
+     */
+    dialed_today: number;
     /**
      * Ended At
      */
@@ -1312,6 +1332,10 @@ export type CallBatchResponse = {
      * Next Dial At
      */
     next_dial_at: string | null;
+    /**
+     * Next Dial Reason
+     */
+    next_dial_reason: 'start' | 'window' | 'daily_cap' | null;
     /**
      * Retry After Minutes
      */
@@ -2799,6 +2823,22 @@ export type CreateCallBatchRequest = {
      */
     agent_version?: number | 'draft' | null;
     calling_window?: TimeWindow | null;
+    /**
+     * Dial Daily Cap
+     *
+     * Calls placed per local day, retries included: a fixed limit, or a ramp that rises on days it dialled. Null is uncapped.
+     */
+    dial_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
+    /**
+     * Dial Gap Seconds
+     *
+     * Minimum seconds between STARTING two calls; 0 dials as slots free. A call may start up to 30 seconds after its gap ends.
+     */
+    dial_gap_seconds?: number;
     /**
      * From Phone Number Id
      */
@@ -2953,9 +2993,13 @@ export type CreateEmailBatchRequest = {
     /**
      * Send Daily Cap
      *
-     * Emails this batch may send per local day, across all of its sends. Null is uncapped.
+     * Emails this batch may send per local day, across all of its sends: a fixed limit, or a ramp that rises on days it sent. Null is uncapped.
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      *
@@ -3029,7 +3073,11 @@ export type CreateEmailSendRequest = {
     /**
      * Send Daily Cap
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      */
@@ -3316,9 +3364,13 @@ export type CreateWhatsAppBatchRequest = {
     /**
      * Send Daily Cap
      *
-     * Messages per local day. Null is uncapped.
+     * Messages per local day: a fixed limit, or a ramp that rises on days it sent. Null is uncapped.
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      */
@@ -3735,7 +3787,15 @@ export type EmailBatchResponse = {
     /**
      * Send Daily Cap
      */
-    send_daily_cap: number | null;
+    send_daily_cap: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
+    /**
+     * Send Daily Cap Today
+     */
+    send_daily_cap_today: number | null;
     /**
      * Send Gap Seconds
      */
@@ -4011,7 +4071,15 @@ export type EmailSendResponse = {
     /**
      * Send Daily Cap
      */
-    send_daily_cap: number | null;
+    send_daily_cap: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
+    /**
+     * Send Daily Cap Today
+     */
+    send_daily_cap_today: number | null;
     /**
      * Send Gap Seconds
      */
@@ -4190,6 +4258,21 @@ export type FieldMap = {
      */
     to: string;
 };
+/**
+ * FixedDailyCap
+ *
+ * The same limit every day.
+ */
+export type FixedDailyCap = {
+    /**
+     * Kind
+     */
+    kind: 'fixed';
+    /**
+     * Limit
+     */
+    limit: number;
+};
 /**
  * FrontendRpcConfig
  */
@@ -7662,8 +7745,9 @@ export type PageWhatsAppRecipientResponse = {
  *
  * Policy edits, allowed while a batch is `scheduled`, `running`, `paused` or `completed`.
  *
- * ``calling_window`` and ``start_at`` accept an explicit ``null`` to *clear*
- * them — "dial at any hour", "start on the next pass" — which is why the
+ * ``calling_window``, ``start_at`` and ``dial_daily_cap`` accept an explicit
+ * ``null`` to *clear* them — "dial at any hour", "start on the next pass", "no
+ * daily limit" — which is why the
  * service reads ``model_fields_set`` rather than treating absent and null the
  * same way. Every other field keeps the usual PATCH rule: absent means
  * unchanged.
@@ -7674,6 +7758,18 @@ export type PatchCallBatchRequest = {
      */
     agent_id?: string | null;
     calling_window?: TimeWindow | null;
+    /**
+     * Dial Daily Cap
+     */
+    dial_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
+    /**
+     * Dial Gap Seconds
+     */
+    dial_gap_seconds?: number | null;
     /**
      * From Phone Number Id
      */
@@ -7784,7 +7880,11 @@ export type PatchEmailBatchRequest = {
     /**
      * Send Daily Cap
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      */
@@ -7839,7 +7939,11 @@ export type PatchEmailSendRequest = {
     /**
      * Send Daily Cap
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      */
@@ -8114,9 +8218,13 @@ export type PatchWhatsAppBatchRequest = {
     /**
      * Send Daily Cap
      *
-     * Messages per local day. Null is uncapped.
+     * Messages per local day: a fixed limit, or a ramp that rises on days it sent. Null is uncapped.
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      */
@@ -8662,6 +8770,33 @@ export type PublishedValueResponse = {
      */
     value?: unknown;
 };
+/**
+ * RampDailyCap
+ *
+ * `start` a day, raised by `step` every `interval_days` sending days, up to `end`.
+ */
+export type RampDailyCap = {
+    /**
+     * End
+     */
+    end: number;
+    /**
+     * Interval Days
+     */
+    interval_days: number;
+    /**
+     * Kind
+     */
+    kind: 'ramp';
+    /**
+     * Start
+     */
+    start: number;
+    /**
+     * Step
+     */
+    step: number;
+};
 /**
  * RealtimeCatalogEntryResponse
  */
@@ -9730,9 +9865,13 @@ export type SendWhatsAppBatchRequest = {
     /**
      * Send Daily Cap
      *
-     * Messages per local day. Null is uncapped.
+     * Messages per local day: a fixed limit, or a ramp that rises on days it sent. Null is uncapped.
      */
-    send_daily_cap?: number | null;
+    send_daily_cap?: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
     /**
      * Send Gap Seconds
      */
@@ -12255,7 +12394,15 @@ export type WhatsAppBatchResponse = {
     /**
      * Send Daily Cap
      */
-    send_daily_cap: number | null;
+    send_daily_cap: ({
+        kind: 'fixed';
+    } & FixedDailyCap) | ({
+        kind: 'ramp';
+    } & RampDailyCap) | null;
+    /**
+     * Send Daily Cap Today
+     */
+    send_daily_cap_today: number | null;
     /**
      * Send Gap Seconds
      */