@talqing/sdk 0.6.0 → 0.8.0

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

@@ -1,6 +1,39 @@
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
+/**
+ * AddEmailRecipientsRequest
+ */
+export type AddEmailRecipientsRequest = {
+    /**
+     * Recipients
+     */
+    recipients: Array<EmailRecipientInput>;
+};
+/**
+ * AddEmailRecipientsResponse
+ *
+ * `standing_send_id` is the send of every row that will mail the new rows
+ * without review, or null when they wait for review.
+ */
+export type AddEmailRecipientsResponse = {
+    /**
+     * Added
+     */
+    added: number;
+    /**
+     * Skipped
+     */
+    skipped: Array<SkippedEmailRecipient>;
+    /**
+     * Standing Send Id
+     */
+    standing_send_id: string | null;
+    /**
+     * Total Recipients
+     */
+    total_recipients: number;
+};
 /**
  * AddMessageConfig
  */
@@ -38,9 +71,10 @@ export type AddRecipientsRequest = {
  *
  * What appending to a batch did.
  *
- * Numbers already in the batch are skipped and reported rather than rejected:
- * re-uploading a list the operator re-exported is the normal case, and the
- * never-call-twice guarantee doing its job is not a user error.
+ * Numbers already in the batch, or repeated in the request, are skipped and
+ * reported rather than rejected: re-uploading a list the operator re-exported
+ * is the normal case, and the never-call-twice guarantee doing its job is not a
+ * user error.
  */
 export type AddRecipientsResponse = {
     /**
@@ -82,6 +116,32 @@ export type AddVoiceResponse = {
      */
     voice_id: string;
 };
+/**
+ * AddWhatsAppRecipientsRequest
+ */
+export type AddWhatsAppRecipientsRequest = {
+    /**
+     * Recipients
+     */
+    recipients: Array<WhatsAppRecipientInput>;
+};
+/**
+ * AddWhatsAppRecipientsResponse
+ */
+export type AddWhatsAppRecipientsResponse = {
+    /**
+     * Added
+     */
+    added: number;
+    /**
+     * Skipped
+     */
+    skipped: Array<SkippedWhatsAppRecipient>;
+    /**
+     * Total Recipients
+     */
+    total_recipients: number;
+};
 /**
  * AgentConfig
  *
@@ -1216,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
      */
@@ -1252,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
      */
@@ -2739,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
      */
@@ -2893,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
      *
@@ -2969,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
      */
@@ -3256,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
      */
@@ -3675,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
      */
@@ -3951,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
      */
@@ -4130,6 +4258,21 @@ export type FieldMap = {
      */
     to: string;
 };
+/**
+ * FixedDailyCap
+ *
+ * The same limit every day.
+ */
+export type FixedDailyCap = {
+    /**
+     * Kind
+     */
+    kind: 'fixed';
+    /**
+     * Limit
+     */
+    limit: number;
+};
 /**
  * FrontendRpcConfig
  */
@@ -7600,10 +7743,11 @@ export type PageWhatsAppRecipientResponse = {
 /**
  * PatchCallBatchRequest
  *
- * Policy edits, allowed while a batch is `scheduled`, `running` or `paused`.
+ * 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.
@@ -7614,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
      */
@@ -7724,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
      */
@@ -7779,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
      */
@@ -8054,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
      */
@@ -8602,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
  */
@@ -9670,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
      */
@@ -9886,6 +10085,26 @@ export type SilenceSpecOverride = {
      */
     timeout?: number | null;
 };
+/**
+ * SkippedEmailRecipient
+ *
+ * A row of the request that will not be drafted. `row_number` is its 1-based
+ * position in the request; `recipient_id` is null when it was not stored.
+ */
+export type SkippedEmailRecipient = {
+    /**
+     * Reason
+     */
+    reason: string;
+    /**
+     * Recipient Id
+     */
+    recipient_id: string | null;
+    /**
+     * Row Number
+     */
+    row_number: number;
+};
 /**
  * SkippedRecipient
  */
@@ -9903,6 +10122,26 @@ export type SkippedRecipient = {
      */
     to: string;
 };
+/**
+ * SkippedWhatsAppRecipient
+ *
+ * A row of the request that will not be sent. `row_number` is its 1-based
+ * position in the request; `recipient_id` is null when it was not stored.
+ */
+export type SkippedWhatsAppRecipient = {
+    /**
+     * Reason
+     */
+    reason: string;
+    /**
+     * Recipient Id
+     */
+    recipient_id: string | null;
+    /**
+     * Row Number
+     */
+    row_number: number;
+};
 /**
  * StoredAgentPlan
  *
@@ -12155,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
      */
@@ -15965,6 +16212,55 @@ export type EmailBatchesRecipientsListResults = {
     200: PageEmailRecipientResponse;
 };
 export type EmailBatchesRecipientsListResult = EmailBatchesRecipientsListResults[keyof EmailBatchesRecipientsListResults];
+export type EmailBatchesRecipientsAddData = {
+    body: AddEmailRecipientsRequest;
+    path: {
+        /**
+         * Batch Id
+         */
+        batch_id: string;
+    };
+    query?: never;
+    url: '/v1/email/batches/{batch_id}/recipients';
+};
+export type EmailBatchesRecipientsAddErrors = {
+    /**
+     * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
+     */
+    400: ErrorResponse;
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * Authenticated, but this organization role may not perform the operation.
+     */
+    403: ErrorResponse;
+    /**
+     * No such resource in this organization.
+     */
+    404: ErrorResponse;
+    /**
+     * The resource's current state forbids this — a name already taken, a job already running.
+     */
+    409: ErrorResponse;
+    /**
+     * The request did not match this operation's schema; `detail.errors` lists each field.
+     */
+    422: ErrorResponse;
+    /**
+     * Unexpected error. Every error this API returns carries this body.
+     */
+    default: ErrorResponse;
+};
+export type EmailBatchesRecipientsAddError = EmailBatchesRecipientsAddErrors[keyof EmailBatchesRecipientsAddErrors];
+export type EmailBatchesRecipientsAddResults = {
+    /**
+     * Successful Response
+     */
+    200: AddEmailRecipientsResponse;
+};
+export type EmailBatchesRecipientsAddResult = EmailBatchesRecipientsAddResults[keyof EmailBatchesRecipientsAddResults];
 export type EmailBatchesRecipientsUpdateData = {
     body: PatchEmailRecipientRequest;
     path: {
@@ -20431,6 +20727,55 @@ export type WhatsappBatchesRecipientsListResults = {
     200: PageWhatsAppRecipientResponse;
 };
 export type WhatsappBatchesRecipientsListResult = WhatsappBatchesRecipientsListResults[keyof WhatsappBatchesRecipientsListResults];
+export type WhatsappBatchesRecipientsAddData = {
+    body: AddWhatsAppRecipientsRequest;
+    path: {
+        /**
+         * Batch Id
+         */
+        batch_id: string;
+    };
+    query?: never;
+    url: '/v1/whatsapp/batches/{batch_id}/recipients';
+};
+export type WhatsappBatchesRecipientsAddErrors = {
+    /**
+     * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
+     */
+    400: ErrorResponse;
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * Authenticated, but this organization role may not perform the operation.
+     */
+    403: ErrorResponse;
+    /**
+     * No such resource in this organization.
+     */
+    404: ErrorResponse;
+    /**
+     * The resource's current state forbids this — a name already taken, a job already running.
+     */
+    409: ErrorResponse;
+    /**
+     * The request did not match this operation's schema; `detail.errors` lists each field.
+     */
+    422: ErrorResponse;
+    /**
+     * Unexpected error. Every error this API returns carries this body.
+     */
+    default: ErrorResponse;
+};
+export type WhatsappBatchesRecipientsAddError = WhatsappBatchesRecipientsAddErrors[keyof WhatsappBatchesRecipientsAddErrors];
+export type WhatsappBatchesRecipientsAddResults = {
+    /**
+     * Successful Response
+     */
+    200: AddWhatsAppRecipientsResponse;
+};
+export type WhatsappBatchesRecipientsAddResult = WhatsappBatchesRecipientsAddResults[keyof WhatsappBatchesRecipientsAddResults];
 export type WhatsappBatchesRecipientsRestoreData = {
     body: SelectRecipientsRequest;
     path: {