@talqing/sdk 0.9.0 → 0.10.0

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

@@ -875,7 +875,7 @@ export type AvatarSpecOverride = {
  * AvatarUsage
  *
  * One avatar session's billable window: WALL-CLOCK seconds alive, idle
- * included (Anam's billing rule, §16 Phase 15). Metered from our own job
+ * included (Anam's billing rule). Metered from our own job
  * timing — Anam has no usage webhooks; `avatar_session_id` (Anam's sessionId)
  * is stored for reconciliation against any future Anam usage export.
  */
@@ -1487,6 +1487,10 @@ export type CallSessionResponse = {
      */
     phone_number_id: string | null;
     recording: RecordingResponse;
+    /**
+     * Resumed From Call Id
+     */
+    resumed_from_call_id: string | null;
     screen_recording: RecordingResponse;
     /**
      * Started At
@@ -1616,6 +1620,10 @@ export type CallSummaryResponse = {
     outcome?: 'success' | 'failure' | 'unknown' | null;
     plan?: CallPlanSummary | null;
     recording: RecordingResponse;
+    /**
+     * Resumed From Call Id
+     */
+    resumed_from_call_id?: string | null;
     /**
      * Started At
      */
@@ -2406,7 +2414,7 @@ export type ConversationSpec = {
     /**
      * Context
      *
-     * How much of the past comes into a new call: 'none' starts clean, 'summary' adds background on recent conversations, 'transcript' carries the same conversation on. Set on the agent that answers. A WhatsApp call always carries the chat on.
+     * What a new session starts with from earlier ones with this person: 'none' starts clean, 'summary' adds background on recent conversations, 'transcript' carries the same conversation on. Read only from the agent that answers. A WhatsApp call always carries the chat on, whatever this says.
      */
     context?: 'none' | 'summary' | 'transcript';
     /**
@@ -2431,7 +2439,7 @@ export type ConversationSpecOverride = {
     /**
      * Context
      *
-     * How much of the past comes into a new call: 'none' starts clean, 'summary' adds background on recent conversations, 'transcript' carries the same conversation on. Set on the agent that answers. A WhatsApp call always carries the chat on.
+     * What a new session starts with from earlier ones with this person: 'none' starts clean, 'summary' adds background on recent conversations, 'transcript' carries the same conversation on. Read only from the agent that answers. A WhatsApp call always carries the chat on, whatever this says.
      */
     context?: 'none' | 'summary' | 'transcript' | null;
     /**
@@ -3240,8 +3248,10 @@ export type CreateTelephonyAccountRequest = {
     };
     /**
      * Display Name
+     *
+     * Omit to use the carrier's own name for the account.
      */
-    display_name: string;
+    display_name?: string | null;
     /**
      * Provider
      */
@@ -3370,12 +3380,7 @@ export type CreateWhatsAppBatchRequest = {
 /**
  * CreditBalanceResponse
  *
- * This region's balance for the workspace, what it buys, and top-up prices.
- *
- * Per region, because the balance is a data-plane table. A caller reading this
- * is reading the balance of whichever region's API they called, and the
- * dashboard labels it with that region's name — a bare number is what makes a
- * customer with $50 in one region and $0 in another think the money vanished.
+ * This workspace's credit balance, what it buys, and top-up prices.
  */
 export type CreditBalanceResponse = {
     /**
@@ -3495,6 +3500,17 @@ export type CreditPackResponse = {
      */
     voice_minutes: number;
 };
+/**
+ * DeleteRecipientsRequest
+ *
+ * Rows to remove from a batch, by id.
+ */
+export type DeleteRecipientsRequest = {
+    /**
+     * Recipient Ids
+     */
+    recipient_ids: Array<string>;
+};
 /**
  * DeliveryError
  *
@@ -4480,6 +4496,12 @@ export type HandoffConfig = {
      * Context
      */
     context?: 'none' | 'summary' | 'transcript';
+    /**
+     * Instructions
+     *
+     * What the target is told as it opens, when it has no greeting.
+     */
+    instructions?: string | null;
     /**
      * Message
      *
@@ -4489,7 +4511,7 @@ export type HandoffConfig = {
     /**
      * Recent Turns
      *
-     * Turns that cross verbatim alongside a summary, or in place of one under 'none'. Past ten, the honest answer is context 'transcript'.
+     * Context 'summary' only: turns of this call that cross verbatim beside the summary. Defaults to 2.
      */
     recent_turns?: number | null;
     /**
@@ -4540,6 +4562,10 @@ export type HandoffTarget = {
      * Description
      */
     description: string;
+    /**
+     * Instructions
+     */
+    instructions?: string | null;
     /**
      * Message
      */
@@ -9500,27 +9526,6 @@ export type SecretResponse = {
      */
     value_hint: string;
 };
-/**
- * SelectRecipientsRequest
- *
- * What `skip` and `restore` accept — either shape.
- *
- * Both are reversible, which is why both take a bulk shorthand: skipping four
- * thousand rows is undone by restoring them, and making curation tedious pushes
- * an operator toward not curating.
- */
-export type SelectRecipientsRequest = {
-    /**
-     * Recipient Ids
-     */
-    recipient_ids?: Array<string> | null;
-    /**
-     * Selection
-     *
-     * Every row this verb can act on: drafts for skip, rows a person skipped for restore.
-     */
-    selection?: 'all_eligible' | null;
-};
 /**
  * SendDtmfConfig
  */
@@ -13577,6 +13582,55 @@ export type CallsBatchesRecipientsAddResults = {
     200: AddRecipientsResponse;
 };
 export type CallsBatchesRecipientsAddResult = CallsBatchesRecipientsAddResults[keyof CallsBatchesRecipientsAddResults];
+export type CallsBatchesRecipientsDeleteData = {
+    body: DeleteRecipientsRequest;
+    path: {
+        /**
+         * Batch Id
+         */
+        batch_id: string;
+    };
+    query?: never;
+    url: '/v1/calls/batches/{batch_id}/recipients/delete';
+};
+export type CallsBatchesRecipientsDeleteErrors = {
+    /**
+     * 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 CallsBatchesRecipientsDeleteError = CallsBatchesRecipientsDeleteErrors[keyof CallsBatchesRecipientsDeleteErrors];
+export type CallsBatchesRecipientsDeleteResults = {
+    /**
+     * Successful Response
+     */
+    200: RecipientActionResponse;
+};
+export type CallsBatchesRecipientsDeleteResult = CallsBatchesRecipientsDeleteResults[keyof CallsBatchesRecipientsDeleteResults];
 export type CallsBatchesResumeData = {
     body?: never;
     path: {
@@ -13986,6 +14040,59 @@ export type CallsRecordingGetResults = {
     200: Blob | File;
 };
 export type CallsRecordingGetResult = CallsRecordingGetResults[keyof CallsRecordingGetResults];
+export type CallsResumeData = {
+    body?: never;
+    path: {
+        /**
+         * Session Id
+         */
+        session_id: string;
+    };
+    query?: never;
+    url: '/v1/calls/{session_id}/resume';
+};
+export type CallsResumeErrors = {
+    /**
+     * 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;
+    /**
+     * This organization has no credit left, so a new call cannot be started. Calls already running are unaffected.
+     */
+    402: 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 CallsResumeError = CallsResumeErrors[keyof CallsResumeErrors];
+export type CallsResumeResults = {
+    /**
+     * Successful Response
+     */
+    200: CallTokenResponse;
+};
+export type CallsResumeResult = CallsResumeResults[keyof CallsResumeResults];
 export type CallsScreenRecordingGetData = {
     body?: never;
     path: {
@@ -15903,22 +16010,18 @@ export type EmailBatchesRecipientsAddResults = {
     200: AddEmailRecipientsResponse;
 };
 export type EmailBatchesRecipientsAddResult = EmailBatchesRecipientsAddResults[keyof EmailBatchesRecipientsAddResults];
-export type EmailBatchesRecipientsUpdateData = {
-    body: PatchEmailRecipientRequest;
+export type EmailBatchesRecipientsDeleteData = {
+    body: DeleteRecipientsRequest;
     path: {
         /**
          * Batch Id
          */
         batch_id: string;
-        /**
-         * Recipient Id
-         */
-        recipient_id: string;
     };
     query?: never;
-    url: '/v1/email/batches/{batch_id}/recipients/{recipient_id}';
+    url: '/v1/email/batches/{batch_id}/recipients/delete';
 };
-export type EmailBatchesRecipientsUpdateErrors = {
+export type EmailBatchesRecipientsDeleteErrors = {
     /**
      * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
      */
@@ -15948,26 +16051,30 @@ export type EmailBatchesRecipientsUpdateErrors = {
      */
     default: ErrorResponse;
 };
-export type EmailBatchesRecipientsUpdateError = EmailBatchesRecipientsUpdateErrors[keyof EmailBatchesRecipientsUpdateErrors];
-export type EmailBatchesRecipientsUpdateResults = {
+export type EmailBatchesRecipientsDeleteError = EmailBatchesRecipientsDeleteErrors[keyof EmailBatchesRecipientsDeleteErrors];
+export type EmailBatchesRecipientsDeleteResults = {
     /**
      * Successful Response
      */
-    200: EmailRecipientResponse;
+    200: RecipientActionResponse;
 };
-export type EmailBatchesRecipientsUpdateResult = EmailBatchesRecipientsUpdateResults[keyof EmailBatchesRecipientsUpdateResults];
-export type EmailBatchesRecipientsRedraftData = {
-    body: RedraftRequest;
+export type EmailBatchesRecipientsDeleteResult = EmailBatchesRecipientsDeleteResults[keyof EmailBatchesRecipientsDeleteResults];
+export type EmailBatchesRecipientsUpdateData = {
+    body: PatchEmailRecipientRequest;
     path: {
         /**
          * Batch Id
          */
         batch_id: string;
+        /**
+         * Recipient Id
+         */
+        recipient_id: string;
     };
     query?: never;
-    url: '/v1/email/batches/{batch_id}/redraft';
+    url: '/v1/email/batches/{batch_id}/recipients/{recipient_id}';
 };
-export type EmailBatchesRecipientsRedraftErrors = {
+export type EmailBatchesRecipientsUpdateErrors = {
     /**
      * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
      */
@@ -15997,16 +16104,16 @@ export type EmailBatchesRecipientsRedraftErrors = {
      */
     default: ErrorResponse;
 };
-export type EmailBatchesRecipientsRedraftError = EmailBatchesRecipientsRedraftErrors[keyof EmailBatchesRecipientsRedraftErrors];
-export type EmailBatchesRecipientsRedraftResults = {
+export type EmailBatchesRecipientsUpdateError = EmailBatchesRecipientsUpdateErrors[keyof EmailBatchesRecipientsUpdateErrors];
+export type EmailBatchesRecipientsUpdateResults = {
     /**
      * Successful Response
      */
-    200: RecipientActionResponse;
+    200: EmailRecipientResponse;
 };
-export type EmailBatchesRecipientsRedraftResult = EmailBatchesRecipientsRedraftResults[keyof EmailBatchesRecipientsRedraftResults];
-export type EmailBatchesRecipientsRestoreData = {
-    body: SelectRecipientsRequest;
+export type EmailBatchesRecipientsUpdateResult = EmailBatchesRecipientsUpdateResults[keyof EmailBatchesRecipientsUpdateResults];
+export type EmailBatchesRecipientsRedraftData = {
+    body: RedraftRequest;
     path: {
         /**
          * Batch Id
@@ -16014,9 +16121,9 @@ export type EmailBatchesRecipientsRestoreData = {
         batch_id: string;
     };
     query?: never;
-    url: '/v1/email/batches/{batch_id}/restore';
+    url: '/v1/email/batches/{batch_id}/redraft';
 };
-export type EmailBatchesRecipientsRestoreErrors = {
+export type EmailBatchesRecipientsRedraftErrors = {
     /**
      * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
      */
@@ -16046,14 +16153,14 @@ export type EmailBatchesRecipientsRestoreErrors = {
      */
     default: ErrorResponse;
 };
-export type EmailBatchesRecipientsRestoreError = EmailBatchesRecipientsRestoreErrors[keyof EmailBatchesRecipientsRestoreErrors];
-export type EmailBatchesRecipientsRestoreResults = {
+export type EmailBatchesRecipientsRedraftError = EmailBatchesRecipientsRedraftErrors[keyof EmailBatchesRecipientsRedraftErrors];
+export type EmailBatchesRecipientsRedraftResults = {
     /**
      * Successful Response
      */
     200: RecipientActionResponse;
 };
-export type EmailBatchesRecipientsRestoreResult = EmailBatchesRecipientsRestoreResults[keyof EmailBatchesRecipientsRestoreResults];
+export type EmailBatchesRecipientsRedraftResult = EmailBatchesRecipientsRedraftResults[keyof EmailBatchesRecipientsRedraftResults];
 export type EmailBatchesResumeData = {
     body?: never;
     path: {
@@ -16451,55 +16558,6 @@ export type EmailBatchesSendsResumeResults = {
     200: EmailSendResponse;
 };
 export type EmailBatchesSendsResumeResult = EmailBatchesSendsResumeResults[keyof EmailBatchesSendsResumeResults];
-export type EmailBatchesRecipientsSkipData = {
-    body: SelectRecipientsRequest;
-    path: {
-        /**
-         * Batch Id
-         */
-        batch_id: string;
-    };
-    query?: never;
-    url: '/v1/email/batches/{batch_id}/skip';
-};
-export type EmailBatchesRecipientsSkipErrors = {
-    /**
-     * 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 EmailBatchesRecipientsSkipError = EmailBatchesRecipientsSkipErrors[keyof EmailBatchesRecipientsSkipErrors];
-export type EmailBatchesRecipientsSkipResults = {
-    /**
-     * Successful Response
-     */
-    200: RecipientActionResponse;
-};
-export type EmailBatchesRecipientsSkipResult = EmailBatchesRecipientsSkipResults[keyof EmailBatchesRecipientsSkipResults];
 export type EmailSendersListData = {
     body?: never;
     path?: never;
@@ -20249,57 +20307,8 @@ export type WhatsappBatchesRecipientsAddResults = {
     200: AddWhatsAppRecipientsResponse;
 };
 export type WhatsappBatchesRecipientsAddResult = WhatsappBatchesRecipientsAddResults[keyof WhatsappBatchesRecipientsAddResults];
-export type WhatsappBatchesRecipientsRestoreData = {
-    body: SelectRecipientsRequest;
-    path: {
-        /**
-         * Batch Id
-         */
-        batch_id: string;
-    };
-    query?: never;
-    url: '/v1/whatsapp/batches/{batch_id}/recipients/restore';
-};
-export type WhatsappBatchesRecipientsRestoreErrors = {
-    /**
-     * 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 WhatsappBatchesRecipientsRestoreError = WhatsappBatchesRecipientsRestoreErrors[keyof WhatsappBatchesRecipientsRestoreErrors];
-export type WhatsappBatchesRecipientsRestoreResults = {
-    /**
-     * Successful Response
-     */
-    200: RecipientActionResponse;
-};
-export type WhatsappBatchesRecipientsRestoreResult = WhatsappBatchesRecipientsRestoreResults[keyof WhatsappBatchesRecipientsRestoreResults];
-export type WhatsappBatchesRecipientsSkipData = {
-    body: SelectRecipientsRequest;
+export type WhatsappBatchesRecipientsDeleteData = {
+    body: DeleteRecipientsRequest;
     path: {
         /**
          * Batch Id
@@ -20307,9 +20316,9 @@ export type WhatsappBatchesRecipientsSkipData = {
         batch_id: string;
     };
     query?: never;
-    url: '/v1/whatsapp/batches/{batch_id}/recipients/skip';
+    url: '/v1/whatsapp/batches/{batch_id}/recipients/delete';
 };
-export type WhatsappBatchesRecipientsSkipErrors = {
+export type WhatsappBatchesRecipientsDeleteErrors = {
     /**
      * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
      */
@@ -20339,14 +20348,14 @@ export type WhatsappBatchesRecipientsSkipErrors = {
      */
     default: ErrorResponse;
 };
-export type WhatsappBatchesRecipientsSkipError = WhatsappBatchesRecipientsSkipErrors[keyof WhatsappBatchesRecipientsSkipErrors];
-export type WhatsappBatchesRecipientsSkipResults = {
+export type WhatsappBatchesRecipientsDeleteError = WhatsappBatchesRecipientsDeleteErrors[keyof WhatsappBatchesRecipientsDeleteErrors];
+export type WhatsappBatchesRecipientsDeleteResults = {
     /**
      * Successful Response
      */
     200: RecipientActionResponse;
 };
-export type WhatsappBatchesRecipientsSkipResult = WhatsappBatchesRecipientsSkipResults[keyof WhatsappBatchesRecipientsSkipResults];
+export type WhatsappBatchesRecipientsDeleteResult = WhatsappBatchesRecipientsDeleteResults[keyof WhatsappBatchesRecipientsDeleteResults];
 export type WhatsappBatchesRecipientsUpdateData = {
     body: PatchWhatsAppRecipientRequest;
     path: {