@talqing/sdk 0.13.2 → 0.14.1

package/src/gen/types.gen.ts

@@ -1913,6 +1913,10 @@ export type CatalogResponse = {
      * Turn Detector Languages
      */
     turn_detector_languages: Array<LanguageOption>;
+    /**
+     * Whatsapp Template Languages
+     */
+    whatsapp_template_languages: Array<string>;
 };
 
 /**
@@ -3664,8 +3668,34 @@ export type CreateWebhookRequest = {
 
 /**
  * CreateWhatsAppBatchRequest
+ *
+ * The agent fields choose who answers replies; omit them for the number's agent.
  */
 export type CreateWhatsAppBatchRequest = {
+    /**
+     * A complete agent definition, run for this call and stored nowhere. Mutually exclusive with `agent_id`.
+     */
+    agent?: AgentConfig | null;
+    /**
+     * Agent Id
+     *
+     * An agent in this workspace. Mutually exclusive with `agent`.
+     */
+    agent_id?: string | null;
+    /**
+     * Changes layered on top of whichever base was named. Absent keys keep the base value, an explicit null clears the field, objects deep-merge and lists replace.
+     */
+    agent_override?: AgentOverride | null;
+    /**
+     * Run several agents on this call, defined here. Mutually exclusive with `agent_id` / `agent` / `agent_version` / `agent_override`.
+     */
+    agent_team?: AgentTeam | null;
+    /**
+     * Agent Version
+     *
+     * Which version of `agent_id` to run. Omit for the published one. `"draft"` runs the unpublished working copy — validated and tool-pinned at request time, and refused with the publish errors if it does not hold together.
+     */
+    agent_version?: number | 'draft' | null;
     /**
      * Delivery Attempts
      *
@@ -3728,9 +3758,75 @@ export type CreateWhatsAppBatchRequest = {
     variable_map: {
         [key: string]: string;
     };
+    /**
+     * Vars
+     *
+     * Values for the variables the agents on this session declare, read as {{vars.name}} in a prompt, a greeting and a tool. They override each agent's declared default and reach every agent the session runs, including a handoff target. Unlike `userdata`, which describes the PERSON and is kept on their contact record, these describe THIS session and are gone with it. Strings only; an empty string is a deliberate blank, not a request for the default. The model can see them, so credentials go in `secrets` (this session's own, where the request takes them) or a workspace secret, read as {{secrets.NAME}} by a tool.
+     */
+    vars?: {
+        [key: string]: string;
+    } | null;
     window?: TimeWindow | null;
 };
 
+/**
+ * CreateWhatsAppTemplateRequest
+ */
+export type CreateWhatsAppTemplateRequest = {
+    /**
+     * Body
+     *
+     * Variables are named: `{{first_name}}`.
+     */
+    body: string;
+    /**
+     * Buttons
+     */
+    buttons?: Array<WhatsAppTemplateQuickReplyButtonInput | WhatsAppTemplateUrlButtonInput | WhatsAppTemplatePhoneButtonInput | WhatsAppTemplateVoiceCallButtonInput | WhatsAppTemplateCopyCodeButtonInput>;
+    /**
+     * Category
+     */
+    category: 'marketing' | 'utility';
+    /**
+     * Examples
+     *
+     * A realistic sample for every variable; WhatsApp reviews them.
+     */
+    examples?: {
+        [key: string]: string;
+    };
+    /**
+     * Footer
+     */
+    footer?: string | null;
+    /**
+     * Header
+     */
+    header?: ({
+        type: 'text';
+    } & WhatsAppTemplateTextHeaderInput) | ({
+        type: 'document' | 'image' | 'video';
+    } & WhatsAppTemplateMediaHeaderInput) | null;
+    /**
+     * Integration Id
+     *
+     * A Twilio WhatsApp sender; the template is account-wide.
+     */
+    integration_id: string;
+    /**
+     * Language
+     *
+     * One of the catalog's `whatsapp_template_languages`.
+     */
+    language: string;
+    /**
+     * Name
+     *
+     * Lowercase letters, digits and `_`.
+     */
+    name: string;
+};
+
 /**
  * CreditBalanceResponse
  *
@@ -8721,8 +8817,35 @@ export type PatchWebhookRequest = {
  * PatchWhatsAppBatchRequest
  *
  * Edits. ``window``, ``start_at`` and ``send_daily_cap`` take ``null`` to clear.
+ *
+ * Any agent field replaces the batch's agent wholesale; all of them null returns
+ * replies to the number's agent.
  */
 export type PatchWhatsAppBatchRequest = {
+    /**
+     * A complete agent definition, run for this call and stored nowhere. Mutually exclusive with `agent_id`.
+     */
+    agent?: AgentConfig | null;
+    /**
+     * Agent Id
+     *
+     * An agent in this workspace. Mutually exclusive with `agent`.
+     */
+    agent_id?: string | null;
+    /**
+     * Changes layered on top of whichever base was named. Absent keys keep the base value, an explicit null clears the field, objects deep-merge and lists replace.
+     */
+    agent_override?: AgentOverride | null;
+    /**
+     * Run several agents on this call, defined here. Mutually exclusive with `agent_id` / `agent` / `agent_version` / `agent_override`.
+     */
+    agent_team?: AgentTeam | null;
+    /**
+     * Agent Version
+     *
+     * Which version of `agent_id` to run. Omit for the published one. `"draft"` runs the unpublished working copy — validated and tool-pinned at request time, and refused with the publish errors if it does not hold together.
+     */
+    agent_version?: number | 'draft' | null;
     /**
      * Delivery Attempts
      *
@@ -8765,6 +8888,14 @@ export type PatchWhatsAppBatchRequest = {
     variable_map?: {
         [key: string]: string;
     };
+    /**
+     * Vars
+     *
+     * Values for the variables the agents on this session declare, read as {{vars.name}} in a prompt, a greeting and a tool. They override each agent's declared default and reach every agent the session runs, including a handoff target. Unlike `userdata`, which describes the PERSON and is kept on their contact record, these describe THIS session and are gone with it. Strings only; an empty string is a deliberate blank, not a request for the default. The model can see them, so credentials go in `secrets` (this session's own, where the request takes them) or a workspace secret, read as {{secrets.NAME}} by a tool.
+     */
+    vars?: {
+        [key: string]: string;
+    } | null;
     window?: TimeWindow | null;
 };
 
@@ -8897,8 +9028,34 @@ export type PlatformFeePerMinute = {
 
 /**
  * PostItemRequest
+ *
+ * The agent fields make that agent answer this person; omit them to continue whatever runs.
  */
 export type PostItemRequest = {
+    /**
+     * A complete agent definition, run for this call and stored nowhere. Mutually exclusive with `agent_id`.
+     */
+    agent?: AgentConfig | null;
+    /**
+     * Agent Id
+     *
+     * An agent in this workspace. Mutually exclusive with `agent`.
+     */
+    agent_id?: string | null;
+    /**
+     * Changes layered on top of whichever base was named. Absent keys keep the base value, an explicit null clears the field, objects deep-merge and lists replace.
+     */
+    agent_override?: AgentOverride | null;
+    /**
+     * Run several agents on this call, defined here. Mutually exclusive with `agent_id` / `agent` / `agent_version` / `agent_override`.
+     */
+    agent_team?: AgentTeam | null;
+    /**
+     * Agent Version
+     *
+     * Which version of `agent_id` to run. Omit for the published one. `"draft"` runs the unpublished working copy — validated and tool-pinned at request time, and refused with the publish errors if it does not hold together.
+     */
+    agent_version?: number | 'draft' | null;
     /**
      * Who at your business posted this; shown in transcripts, never sent to the person or shown to the agent.
      */
@@ -8913,6 +9070,14 @@ export type PostItemRequest = {
      * fail refuses free text outside WhatsApp's 24h window; an opener sends that template and holds the message until they reply.
      */
     on_window_closed?: 'fail' | OpenerPolicy;
+    /**
+     * Secrets
+     *
+     * Secrets for this session only, read by tools as {{secrets.NAME}}; a name here overrides the workspace secret. Never shown to the model or returned.
+     */
+    secrets?: {
+        [key: string]: string;
+    } | null;
     /**
      * For `template` only.
      */
@@ -8941,6 +9106,14 @@ export type PostItemRequest = {
     userdata?: {
         [key: string]: unknown;
     } | null;
+    /**
+     * Vars
+     *
+     * Values for the variables the agents on this session declare, read as {{vars.name}} in a prompt, a greeting and a tool. They override each agent's declared default and reach every agent the session runs, including a handoff target. Unlike `userdata`, which describes the PERSON and is kept on their contact record, these describe THIS session and are gone with it. Strings only; an empty string is a deliberate blank, not a request for the default. The model can see them, so credentials go in `secrets` (this session's own, where the request takes them) or a workspace secret, read as {{secrets.NAME}} by a tool.
+     */
+    vars?: {
+        [key: string]: string;
+    } | null;
 };
 
 /**
@@ -13568,6 +13741,7 @@ export type WhatsAppBatchResponse = {
      * Agent Name
      */
     agent_name: string | null;
+    agent_plan: StoredAgentPlan | null;
     counts: WhatsAppBatchCounts;
     /**
      * Created At
@@ -13617,6 +13791,10 @@ export type WhatsAppBatchResponse = {
      * Next Send Reason
      */
     next_send_reason: 'start' | 'window' | 'daily_cap' | 'retry' | 'gap' | null;
+    /**
+     * Own Agent
+     */
+    own_agent: boolean;
     /**
      * Send Daily Cap
      */
@@ -13653,7 +13831,7 @@ export type WhatsAppBatchResponse = {
      * Status
      */
     status: 'draft' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'canceled' | 'failed';
-    template: WhatsAppTemplate;
+    template: WhatsAppTemplateSnapshot;
     /**
      * Timezone
      */
@@ -13668,6 +13846,12 @@ export type WhatsAppBatchResponse = {
     variable_map: {
         [key: string]: string;
     };
+    /**
+     * Vars
+     */
+    vars: {
+        [key: string]: string;
+    } | null;
     window: TimeWindow | null;
 };
 
@@ -13774,7 +13958,7 @@ export type WhatsAppRecipientResponse = {
 /**
  * WhatsAppTemplate
  *
- * The whole message: header, body, footer and buttons.
+ * A template and where WhatsApp's review of it stands. Only `approved` can be sent.
  */
 export type WhatsAppTemplate = {
     /**
@@ -13788,7 +13972,17 @@ export type WhatsAppTemplate = {
     /**
      * Category
      */
-    category: string;
+    category: 'marketing' | 'utility' | 'authentication';
+    /**
+     * Created At
+     */
+    created_at: string;
+    /**
+     * Examples
+     */
+    examples: {
+        [key: string]: string;
+    };
     /**
      * Footer
      */
@@ -13806,6 +14000,14 @@ export type WhatsAppTemplate = {
      * Name
      */
     name: string;
+    /**
+     * Rejection Reason
+     */
+    rejection_reason: string | null;
+    /**
+     * Status
+     */
+    status: 'pending' | 'approved' | 'rejected' | 'paused' | 'disabled';
     /**
      * Unsupported Reason
      */
@@ -13832,6 +14034,10 @@ export type WhatsAppTemplateButton = {
      * Text
      */
     text: string;
+    /**
+     * Ttl Minutes
+     */
+    ttl_minutes: number | null;
     /**
      * Type
      */
@@ -13842,6 +14048,22 @@ export type WhatsAppTemplateButton = {
     url: string | null;
 };
 
+/**
+ * WhatsAppTemplateCopyCodeButtonInput
+ *
+ * WhatsApp labels it "Copy Code".
+ */
+export type WhatsAppTemplateCopyCodeButtonInput = {
+    /**
+     * Code
+     */
+    code: string;
+    /**
+     * Type
+     */
+    type: 'copy_code';
+};
+
 /**
  * WhatsAppTemplateHeader
  */
@@ -13860,6 +14082,151 @@ export type WhatsAppTemplateHeader = {
     url: string | null;
 };
 
+/**
+ * WhatsAppTemplateMediaHeaderInput
+ */
+export type WhatsAppTemplateMediaHeaderInput = {
+    /**
+     * Type
+     */
+    type: 'image' | 'video' | 'document';
+    /**
+     * Url
+     *
+     * A public https file; WhatsApp downloads it.
+     */
+    url: string;
+};
+
+/**
+ * WhatsAppTemplatePhoneButtonInput
+ */
+export type WhatsAppTemplatePhoneButtonInput = {
+    /**
+     * Phone Number
+     */
+    phone_number: string;
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'phone_number';
+};
+
+/**
+ * WhatsAppTemplateQuickReplyButtonInput
+ */
+export type WhatsAppTemplateQuickReplyButtonInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'quick_reply';
+};
+
+/**
+ * WhatsAppTemplateSnapshot
+ *
+ * The whole message as a batch sends it: header, body, footer and buttons.
+ */
+export type WhatsAppTemplateSnapshot = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Buttons
+     */
+    buttons: Array<WhatsAppTemplateButton>;
+    /**
+     * Category
+     */
+    category: 'marketing' | 'utility' | 'authentication';
+    /**
+     * Footer
+     */
+    footer: string | null;
+    header: WhatsAppTemplateHeader | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Language
+     */
+    language: string;
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Variables
+     */
+    variables: Array<string>;
+};
+
+/**
+ * WhatsAppTemplateTextHeaderInput
+ */
+export type WhatsAppTemplateTextHeaderInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'text';
+};
+
+/**
+ * WhatsAppTemplateUrlButtonInput
+ */
+export type WhatsAppTemplateUrlButtonInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'url';
+    /**
+     * Url
+     *
+     * May end in one variable, after a `/`.
+     */
+    url: string;
+};
+
+/**
+ * WhatsAppTemplateVoiceCallButtonInput
+ *
+ * Starts a WhatsApp call to the sending number.
+ */
+export type WhatsAppTemplateVoiceCallButtonInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Ttl Minutes
+     *
+     * How long the button works after sending. Default 7 days.
+     */
+    ttl_minutes?: number | null;
+    /**
+     * Type
+     */
+    type: 'voice_call';
+};
+
 /**
  * WhatsAppTemplatesResponse
  */
@@ -23568,6 +23935,10 @@ export type WhatsappTemplatesListData = {
          * A connected WhatsApp sender.
          */
         integration_id: string;
+        /**
+         * Status
+         */
+        status?: Array<'pending' | 'approved' | 'rejected' | 'paused' | 'disabled'> | null;
     };
     url: '/v1/whatsapp/templates';
 };
@@ -23598,6 +23969,112 @@ export type WhatsappTemplatesListResults = {
 
 export type WhatsappTemplatesListResult = WhatsappTemplatesListResults[keyof WhatsappTemplatesListResults];
 
+export type WhatsappTemplatesCreateData = {
+    body: CreateWhatsAppTemplateRequest;
+    path?: never;
+    query?: never;
+    url: '/v1/whatsapp/templates';
+};
+
+export type WhatsappTemplatesCreateErrors = {
+    /**
+     * 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;
+    /**
+     * 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 WhatsappTemplatesCreateError = WhatsappTemplatesCreateErrors[keyof WhatsappTemplatesCreateErrors];
+
+export type WhatsappTemplatesCreateResults = {
+    /**
+     * Successful Response
+     */
+    201: WhatsAppTemplate;
+};
+
+export type WhatsappTemplatesCreateResult = WhatsappTemplatesCreateResults[keyof WhatsappTemplatesCreateResults];
+
+export type WhatsappTemplatesDeleteData = {
+    body?: never;
+    path: {
+        /**
+         * Template Id
+         */
+        template_id: string;
+    };
+    query: {
+        /**
+         * Integration Id
+         *
+         * A WhatsApp sender on the template's account.
+         */
+        integration_id: string;
+    };
+    url: '/v1/whatsapp/templates/{template_id}';
+};
+
+export type WhatsappTemplatesDeleteErrors = {
+    /**
+     * 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 WhatsappTemplatesDeleteError = WhatsappTemplatesDeleteErrors[keyof WhatsappTemplatesDeleteErrors];
+
+export type WhatsappTemplatesDeleteResults = {
+    /**
+     * Successful Response
+     */
+    200: OkResponse;
+};
+
+export type WhatsappTemplatesDeleteResult = WhatsappTemplatesDeleteResults[keyof WhatsappTemplatesDeleteResults];
+
 export type WhatsappTwilioSendersListData = {
     body: TwilioSendersRequest;
     path?: never;