retell-sdk 4.66.0 → 5.1.0

package/src/resources/chat-agent.ts

@@ -1,8 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class ChatAgent extends APIResource {
   /**
@@ -18,7 +20,7 @@ export class ChatAgent extends APIResource {
    * });
    * ```
    */
-  create(body: ChatAgentCreateParams, options?: Core.RequestOptions): Core.APIPromise<ChatAgentResponse> {
+  create(body: ChatAgentCreateParams, options?: RequestOptions): APIPromise<ChatAgentResponse> {
     return this._client.post('/create-chat-agent', { body, ...options });
   }
 
@@ -33,20 +35,11 @@ export class ChatAgent extends APIResource {
    * ```
    */
   retrieve(
-    agentId: string,
-    query?: ChatAgentRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ChatAgentResponse>;
-  retrieve(agentId: string, options?: Core.RequestOptions): Core.APIPromise<ChatAgentResponse>;
-  retrieve(
-    agentId: string,
-    query: ChatAgentRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ChatAgentResponse> {
-    if (isRequestOptions(query)) {
-      return this.retrieve(agentId, {}, query);
-    }
-    return this._client.get(`/get-chat-agent/${agentId}`, { query, ...options });
+    agentID: string,
+    query: ChatAgentRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChatAgentResponse> {
+    return this._client.get(path`/get-chat-agent/${agentID}`, { query, ...options });
   }
 
   /**
@@ -60,12 +53,12 @@ export class ChatAgent extends APIResource {
    * ```
    */
   update(
-    agentId: string,
+    agentID: string,
     params: ChatAgentUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ChatAgentResponse> {
+    options?: RequestOptions,
+  ): APIPromise<ChatAgentResponse> {
     const { version, ...body } = params;
-    return this._client.patch(`/update-chat-agent/${agentId}`, { query: { version }, body, ...options });
+    return this._client.patch(path`/update-chat-agent/${agentID}`, { query: { version }, body, ...options });
   }
 
   /**
@@ -76,15 +69,10 @@ export class ChatAgent extends APIResource {
    * const chatAgentResponses = await client.chatAgent.list();
    * ```
    */
-  list(query?: ChatAgentListParams, options?: Core.RequestOptions): Core.APIPromise<ChatAgentListResponse>;
-  list(options?: Core.RequestOptions): Core.APIPromise<ChatAgentListResponse>;
   list(
-    query: ChatAgentListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ChatAgentListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
+    query: ChatAgentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChatAgentListResponse> {
     return this._client.get('/list-chat-agents', { query, ...options });
   }
 
@@ -98,10 +86,10 @@ export class ChatAgent extends APIResource {
    * );
    * ```
    */
-  delete(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/delete-chat-agent/${agentId}`, {
+  delete(agentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/delete-chat-agent/${agentID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
@@ -116,8 +104,8 @@ export class ChatAgent extends APIResource {
    *   );
    * ```
    */
-  getVersions(agentId: string, options?: Core.RequestOptions): Core.APIPromise<ChatAgentGetVersionsResponse> {
-    return this._client.get(`/get-chat-agent-versions/${agentId}`, options);
+  getVersions(agentID: string, options?: RequestOptions): APIPromise<ChatAgentGetVersionsResponse> {
+    return this._client.get(path`/get-chat-agent-versions/${agentID}`, options);
   }
 
   /**
@@ -131,10 +119,10 @@ export class ChatAgent extends APIResource {
    * );
    * ```
    */
-  publish(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post(`/publish-chat-agent/${agentId}`, {
+  publish(agentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/publish-chat-agent/${agentID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
@@ -193,11 +181,23 @@ export interface ChatAgentResponse {
 
   /**
    * If users stay silent for a period after agent speech, end the chat. The minimum
-   * value allowed is 360,000 ms (0.1 hours). The maximum value allowed is
+   * value allowed is 120,000 ms (2 minutes). The maximum value allowed is
    * 259,200,000 ms (72 hours). By default, this is set to 3,600,000 (1 hour).
    */
   end_chat_after_silence_ms?: number;
 
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  guardrail_config?: ChatAgentResponse.GuardrailConfig;
+
+  /**
+   * Whether the agent is public. When set to true, the agent is available for public
+   * agent preview link.
+   */
+  is_public?: boolean | null;
+
   /**
    * Whether the chat agent is published.
    */
@@ -245,6 +245,9 @@ export interface ChatAgentResponse {
     | 'no-NO'
     | 'sk-SK'
     | 'sv-SE'
+    | 'lt-LT'
+    | 'lv-LV'
+    | 'cs-CZ'
     | 'multi';
 
   /**
@@ -278,12 +281,15 @@ export interface ChatAgentResponse {
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
     | 'gpt-5'
+    | 'gpt-5.1'
+    | 'gpt-5.2'
     | 'gpt-5-mini'
     | 'gpt-5-nano'
     | 'claude-4.5-sonnet'
     | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
+    | 'gemini-3.0-flash'
     | null;
 
   /**
@@ -298,6 +304,12 @@ export interface ChatAgentResponse {
    */
   version?: number;
 
+  /**
+   * Which webhook events this agent should receive. If not set, defaults to
+   * chat_started, chat_ended, chat_analyzed.
+   */
+  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+
   /**
    * The timeout for the webhook in milliseconds. If not set, default value of 10000
    * will apply.
@@ -360,6 +372,35 @@ export namespace ChatAgentResponse {
     version?: number | null;
   }
 
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  export interface GuardrailConfig {
+    /**
+     * Selected prohibited user topic categories to check. When user messages contain
+     * these topics, the agent will respond with a placeholder message instead of
+     * processing the request.
+     */
+    input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+
+    /**
+     * Selected prohibited agent topic categories to check. When agent messages contain
+     * these topics, they will be replaced with a placeholder message.
+     */
+    output_topics?: Array<
+      | 'harassment'
+      | 'self_harm'
+      | 'sexual_exploitation'
+      | 'violence'
+      | 'defense_and_national_security'
+      | 'illicit_and_harmful_activity'
+      | 'gambling'
+      | 'regulated_professional_advice'
+      | 'child_safety_and_exploitation'
+    > | null;
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -381,6 +422,7 @@ export namespace ChatAgentResponse {
       | 'pin'
       | 'medical_id'
       | 'date_of_birth'
+      | 'customer_account_number'
     >;
 
     /**
@@ -515,11 +557,23 @@ export interface ChatAgentCreateParams {
 
   /**
    * If users stay silent for a period after agent speech, end the chat. The minimum
-   * value allowed is 360,000 ms (0.1 hours). The maximum value allowed is
+   * value allowed is 120,000 ms (2 minutes). The maximum value allowed is
    * 259,200,000 ms (72 hours). By default, this is set to 3,600,000 (1 hour).
    */
   end_chat_after_silence_ms?: number;
 
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  guardrail_config?: ChatAgentCreateParams.GuardrailConfig;
+
+  /**
+   * Whether the agent is public. When set to true, the agent is available for public
+   * agent preview link.
+   */
+  is_public?: boolean | null;
+
   /**
    * Specifies what language (and dialect) the chat will operate in. For instance,
    * selecting `en-GB` optimizes for British English. If unset, will use default
@@ -562,6 +616,9 @@ export interface ChatAgentCreateParams {
     | 'no-NO'
     | 'sk-SK'
     | 'sv-SE'
+    | 'lt-LT'
+    | 'lv-LV'
+    | 'cs-CZ'
     | 'multi';
 
   /**
@@ -595,12 +652,15 @@ export interface ChatAgentCreateParams {
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
     | 'gpt-5'
+    | 'gpt-5.1'
+    | 'gpt-5.2'
     | 'gpt-5-mini'
     | 'gpt-5-nano'
     | 'claude-4.5-sonnet'
     | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
+    | 'gemini-3.0-flash'
     | null;
 
   /**
@@ -610,6 +670,12 @@ export interface ChatAgentCreateParams {
    */
   signed_url_expiration_ms?: number | null;
 
+  /**
+   * Which webhook events this agent should receive. If not set, defaults to
+   * chat_started, chat_ended, chat_analyzed.
+   */
+  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+
   /**
    * The timeout for the webhook in milliseconds. If not set, default value of 10000
    * will apply.
@@ -672,6 +738,35 @@ export namespace ChatAgentCreateParams {
     version?: number | null;
   }
 
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  export interface GuardrailConfig {
+    /**
+     * Selected prohibited user topic categories to check. When user messages contain
+     * these topics, the agent will respond with a placeholder message instead of
+     * processing the request.
+     */
+    input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+
+    /**
+     * Selected prohibited agent topic categories to check. When agent messages contain
+     * these topics, they will be replaced with a placeholder message.
+     */
+    output_topics?: Array<
+      | 'harassment'
+      | 'self_harm'
+      | 'sexual_exploitation'
+      | 'violence'
+      | 'defense_and_national_security'
+      | 'illicit_and_harmful_activity'
+      | 'gambling'
+      | 'regulated_professional_advice'
+      | 'child_safety_and_exploitation'
+    > | null;
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -693,6 +788,7 @@ export namespace ChatAgentCreateParams {
       | 'pin'
       | 'medical_id'
       | 'date_of_birth'
+      | 'customer_account_number'
     >;
 
     /**
@@ -828,11 +924,23 @@ export interface ChatAgentUpdateParams {
 
   /**
    * Body param: If users stay silent for a period after agent speech, end the chat.
-   * The minimum value allowed is 360,000 ms (0.1 hours). The maximum value allowed
+   * The minimum value allowed is 120,000 ms (2 minutes). The maximum value allowed
    * is 259,200,000 ms (72 hours). By default, this is set to 3,600,000 (1 hour).
    */
   end_chat_after_silence_ms?: number;
 
+  /**
+   * Body param: Configuration for guardrail checks to detect and prevent prohibited
+   * topics in agent output and user input.
+   */
+  guardrail_config?: ChatAgentUpdateParams.GuardrailConfig;
+
+  /**
+   * Body param: Whether the agent is public. When set to true, the agent is
+   * available for public agent preview link.
+   */
+  is_public?: boolean | null;
+
   /**
    * Body param: Specifies what language (and dialect) the chat will operate in. For
    * instance, selecting `en-GB` optimizes for British English. If unset, will use
@@ -875,6 +983,9 @@ export interface ChatAgentUpdateParams {
     | 'no-NO'
     | 'sk-SK'
     | 'sv-SE'
+    | 'lt-LT'
+    | 'lv-LV'
+    | 'cs-CZ'
     | 'multi';
 
   /**
@@ -908,12 +1019,15 @@ export interface ChatAgentUpdateParams {
     | 'gpt-4.1-mini'
     | 'gpt-4.1-nano'
     | 'gpt-5'
+    | 'gpt-5.1'
+    | 'gpt-5.2'
     | 'gpt-5-mini'
     | 'gpt-5-nano'
     | 'claude-4.5-sonnet'
     | 'claude-4.5-haiku'
     | 'gemini-2.5-flash'
     | 'gemini-2.5-flash-lite'
+    | 'gemini-3.0-flash'
     | null;
 
   /**
@@ -933,6 +1047,12 @@ export interface ChatAgentUpdateParams {
    */
   signed_url_expiration_ms?: number | null;
 
+  /**
+   * Body param: Which webhook events this agent should receive. If not set, defaults
+   * to chat_started, chat_ended, chat_analyzed.
+   */
+  webhook_events?: Array<'chat_started' | 'chat_ended' | 'chat_analyzed'> | null;
+
   /**
    * Body param: The timeout for the webhook in milliseconds. If not set, default
    * value of 10000 will apply.
@@ -949,6 +1069,35 @@ export interface ChatAgentUpdateParams {
 }
 
 export namespace ChatAgentUpdateParams {
+  /**
+   * Configuration for guardrail checks to detect and prevent prohibited topics in
+   * agent output and user input.
+   */
+  export interface GuardrailConfig {
+    /**
+     * Selected prohibited user topic categories to check. When user messages contain
+     * these topics, the agent will respond with a placeholder message instead of
+     * processing the request.
+     */
+    input_topics?: Array<'platform_integrity_jailbreaking'> | null;
+
+    /**
+     * Selected prohibited agent topic categories to check. When agent messages contain
+     * these topics, they will be replaced with a placeholder message.
+     */
+    output_topics?: Array<
+      | 'harassment'
+      | 'self_harm'
+      | 'sexual_exploitation'
+      | 'violence'
+      | 'defense_and_national_security'
+      | 'illicit_and_harmful_activity'
+      | 'gambling'
+      | 'regulated_professional_advice'
+      | 'child_safety_and_exploitation'
+    > | null;
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -970,6 +1119,7 @@ export namespace ChatAgentUpdateParams {
       | 'pin'
       | 'medical_id'
       | 'date_of_birth'
+      | 'customer_account_number'
     >;
 
     /**